diff options
Diffstat (limited to 'data/en_us/appstream-center/2021-09-03')
| -rw-r--r-- | data/en_us/appstream-center/2021-09-03/api-docs.php | 2311 |
1 files changed, 818 insertions, 1493 deletions
diff --git a/data/en_us/appstream-center/2021-09-03/api-docs.php b/data/en_us/appstream-center/2021-09-03/api-docs.php index 16079a0..a19e785 100644 --- a/data/en_us/appstream-center/2021-09-03/api-docs.php +++ b/data/en_us/appstream-center/2021-09-03/api-docs.php @@ -1,35 +1,14 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'appstream-center', - 'version' => '2021-09-03', - ], - 'directories' => [ - 'GetConnectionTicket', - 'ListPublishedAppInfo', - 'ListRunningApps', - 'Unbind', - 'StopApp', - 'StartAppResources', - 'StopAppResources', - 'RestartAppResources', - 'ResetAppResources', - ], + 'info' => ['style' => 'RPC', 'product' => 'appstream-center', 'version' => '2021-09-03'], + 'directories' => ['ListPublishedAppInfo', 'ListRunningApps', 'StopApp', 'StartAppResources', 'StopAppResources', 'RestartAppResources', 'ResetAppResources', 'GetConnectionTicket', 'Unbind'], 'components' => [ 'schemas' => [], ], 'apis' => [ 'GetConnectionTicket' => [ - 'summary' => 'Queries the credential used to connect to an app instance.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -42,9 +21,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '82371', - 'abilityTreeNodes' => [ - 'FEATUREappstreamingBC1NTD', - ], + 'abilityTreeNodes' => ['FEATUREappstreamingBC1NTD'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -53,415 +30,298 @@ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ - 'description' => '', - 'enumValueTitles' => [ - 'CloudGame' => '', - 'CloudApp' => '', - ], - 'example' => 'CloudApp', - 'required' => true, + 'description' => 'The product type.', + 'enumValueTitles' => ['CloudGame' => 'A cloud game.', 'CloudApp' => 'A cloud application.'], 'type' => 'string', + 'required' => true, + 'example' => 'CloudApp', + 'title' => '', ], ], [ 'name' => 'BizRegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'cn-hangzhou', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'> If you specify this parameter, the service allocates an app instance only from app instance groups in the specified region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'LoginToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'v1c4e2ef03d620f0f6cb41634196161219054e12d8aa5a13deb9ed14eebb76d674559115ad2e27a57f6820c1fd33e0ca36', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The login token. Obtain the token by calling the `GetLoginToken` or `GetStsToken` operation.', 'type' => 'string', 'required' => false, 'example' => 'v2c4e2ef03d62******', 'title' => ''], ], [ 'name' => 'EndUserId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'test.test', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The username of the convenience account.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '09e2b2e6-3181-4c84-9539-6fc9f1c3199e', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The session ID. Obtain this ID by calling the `GetLoginToken` or `GetStsToken` operation. Use this parameter with `LoginToken`.', 'type' => 'string', 'required' => false, 'example' => '09e2b2e6-3181******', 'title' => ''], ], [ 'name' => 'LoginRegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'cn-hangzhou', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The region ID of the user\'s workspace.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'Uuid', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'A8B35215993FBF283F28D617975204C4', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The unique ID of the login device.', 'type' => 'string', 'required' => false, 'example' => 'A8B35215993FBF283F28D61******', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'f2463208-ec89-4309-8e8c-8b17acdcab93', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The client ID.', 'type' => 'string', 'required' => false, 'example' => 'f2463208-ec89-4309-8e8c-8b1******', 'title' => ''], ], [ 'name' => 'ClientType', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端类型。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['title' => 'Client type.', 'description' => 'The client type.', 'type' => 'string', 'required' => false, 'example' => 'html5'], ], [ 'name' => 'ClientOS', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'windows_"Windows 10 Enterprise LTSC 2019" 10.0 (Build 17763)', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The operating system of the client.', 'type' => 'string', 'required' => false, 'example' => 'windows_"Windows 10 Enterprise LTSC 2019" 10.0 (Build 17763)', 'title' => ''], ], [ 'name' => 'ClientVersion', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '2.0.1-D-20211008.101607', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The client version.', 'type' => 'string', 'required' => false, 'example' => '2.0.1-D-20211008.101607', 'title' => ''], ], [ 'name' => 'ClientIp', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '22.21.2.21', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The IP address of the client.', 'type' => 'string', 'required' => false, 'example' => '22.21.*.*', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '6f41731b-7091-4954-80c8-1d1e0b3ebb48', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The task ID.'."\n" + ."\n" + .'> This parameter is required for all calls after the initial call. Use it to query the task status and retrieve the connection ticket.', 'type' => 'string', 'required' => false, 'example' => '6f41731b-7091-4******', 'title' => ''], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'aig-bw1o1gcwvd3e1ipeu', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The app instance group ID.'."\n" + ."\n" + .'> - If you specify this parameter, the service allocates an app instance only from the specified and authorized app instance group.'."\n" + .'>'."\n" + .'> - This parameter is required if you specify the `AppInstanceId` parameter.', 'type' => 'string', 'required' => false, 'example' => 'aig-bw1o1gcwv******', 'title' => ''], ], [ 'name' => 'AppInstanceId', 'in' => 'formData', - 'schema' => [ - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The app instance ID.'."\n" + ."\n" + .'> - If you specify this parameter, the system attempts to allocate only the specified app instance.'."\n" + .'>'."\n" + .'> - If you specify this parameter, you must also specify the `AppInstanceGroupId` parameter.', 'type' => 'string', 'required' => false, 'example' => 'ai-ij4a6kd4bn2******', 'title' => ''], ], [ 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'ca-etn4zizgaezo9gis9', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The application ID.'."\n" + ."\n" + .'> This parameter is required for the initial call and optional for subsequent calls.', 'type' => 'string', 'required' => false, 'example' => 'ca-etn4zizga******', 'title' => ''], ], [ 'name' => 'AppVersion', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '1.0.0.1', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The application version.', 'type' => 'string', 'required' => false, 'example' => '1.0.1', 'title' => ''], ], [ 'name' => 'Param', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '/home/test/test.jpg', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The application startup parameters.', 'type' => 'string', 'required' => false, 'example' => '/q /n'."\n", 'title' => ''], ], [ 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '1126819517152528', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The tenant ID, which is the Alibaba Cloud account UID.', 'type' => 'string', 'required' => false, 'example' => '1126819517******', 'title' => ''], ], [ 'name' => 'ResourceId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The resource ID.'."\n" + ."\n" + .'> The required value depends on the target resource. For a cloud phone, use the persistent session ID. For a cloud browser, use the cloud browser ID. For a cloud application, the required ID depends on the authorization mode: use the application ID for application-based authorization, the app instance group ID for group-based authorization, or the persistent session ID for session-based authorization.', 'type' => 'string', 'required' => false, 'example' => 'p-0cdr5c9kl******', 'title' => ''], ], [ 'name' => 'ConnectionProperties', 'in' => 'formData', - 'schema' => [ - 'title' => '建连属性。', - 'type' => 'string', - ], + 'schema' => ['title' => 'Connection properties. ', 'description' => 'The connection properties, in JSON format.'."\n" + .'The following parameters are supported:'."\n" + ."\n" + .'- `authMode`: The authorization mode. This value must match the authorization mode of the app instance group. Valid values: `App` (application-based authorization), `AppInstanceGroup` (app instance group-based authorization), and `Session` (persistent session-based authorization).'."\n" + ."\n" + .'- `appInstanceGroupScheduleTags`: The scheduling tags of the app instance group. You can filter resources based on multiple key-value pairs. Tag pairs are combined by using a logical AND. A key is required, but the value can be empty. Example: `[{"key":"Resolution","value":"720p"},{"key":"Name"}]`'."\n" + ."\n" + .'- `appInstanceGroupIds`: A list of app instance group IDs.'."\n" + ."\n" + .'- `appInstancePersistentId`: The ID of the persistent session.'."\n" + ."\n" + .'- `avatarId`: The user avatar ID. Default value: `default`. This parameter allows a user to be allocated multiple session instances.'."\n" + ."\n" + .'> When connecting to a cloud phone, set this parameter to `{"authMode":"Session"}`.', 'type' => 'string', 'required' => false, 'example' => '{"authMode":"Session"}'], ], [ 'name' => 'EnvironmentConfig', 'in' => 'formData', - 'schema' => [ - 'title' => '环境配置。', - 'type' => 'string', - ], + 'schema' => ['title' => 'Environment configuration. ', 'description' => 'The environment configuration.', 'type' => 'string', 'required' => false, 'example' => '{"screenWidth":2560,"screenHeight":1564}'], ], [ 'name' => 'AutoConnectInQueue', 'in' => 'formData', 'schema' => [ + 'description' => 'Specifies whether to automatically connect upon reaching the front of the queue.'."\n" + ."\n" + .'> This parameter is not yet available.', + 'enumValueTitles' => ['true' => 'Auto-connect', 'false' => 'Connect manually'], 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', ], ], [ 'name' => 'AccessType', 'in' => 'formData', 'schema' => [ - 'title' => '接入类型，不传表示两种都显示。'."\n" - .'取值范围：'."\n" - .'互联网：INTERNET'."\n" - .'专线：VPC', + 'title' => 'Access type. If not specified, both types are displayed. '."\n" + .'Valid values: '."\n" + .'the Internet: INTERNET '."\n" + .'leased line: VPC', + 'description' => 'The access type. If you omit this parameter, the call returns resources of both access types. Valid values: `INTERNET` (internet) and `VPC` (private connection).', 'type' => 'string', 'example' => 'INTERNET', 'maxLength' => 10, 'minLength' => 0, 'default' => 'INTERNET', - 'enum' => [ - 'INTERNET', - 'VPC', - ], + 'enum' => ['INTERNET', 'VPC'], + 'required' => false, ], ], [ 'name' => 'AppPolicyId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => false, 'example' => 'pg-0clfzcy0adpcf****', 'title' => ''], + ], + [ + 'name' => 'RequireUuidValidation', + 'in' => 'formData', + 'schema' => ['type' => 'boolean', 'required' => false, 'example' => 'true', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'properties' => [ - 'RequestId' => [ - 'description' => 'Id of the request', - 'example' => 'AD2D0761-1FE5-549D-B169-D3F8D19C6CDD', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Ticket' => [ - 'description' => '', - 'example' => 'n7n9bqZlPrvgUOPSJzfdb$89jWwlVISgrchpY0tOfVYGBBcdoPoH39PVHK63fQTEM14kzajQdWAnHTnSicc35W_eI2LbTSGKquKukwcU7opRwmInhtQH*mlmsZQ3ByOLYVmqI*1hFESs0', - 'type' => 'string', - ], - 'TaskId' => [ - 'description' => '', - 'example' => 'f3d1b31c-605e-4d04-a896-015fc9fc03b4', - 'type' => 'string', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AD2D0761-1FE5-549D-B169******'], + 'Ticket' => ['description' => 'The connection ticket.', 'type' => 'string', 'example' => 'n7n9bqZlPrvgUOPY0tOfVYGBBcdoPoH3******', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'f3d1b31c-605e-******', 'title' => ''], 'TaskStatus' => [ - 'description' => '', - 'enumValueTitles' => [ - 'Finished' => '', - 'Failed' => '', - 'Running' => '', - ], - 'example' => 'Running', - 'type' => 'string', - ], - 'RetryTimes' => [ - 'description' => '', - 'example' => '3', - 'format' => 'int32', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => 'InternalError.TicketGenInternalError', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'reenter app instance failed', - 'type' => 'string', - ], - 'AppInstanceGroupId' => [ - 'description' => '', - 'example' => 'aig-53fvrq1oanz6cxzi3', - 'type' => 'string', - ], - 'AppInstancePersistentId' => [ - 'type' => 'string', - ], - 'AppInstanceId' => [ - 'description' => '', - 'example' => 'ai-gc1gemx6vpa6vlync', + 'description' => 'The task status.', + 'enumValueTitles' => ['Finished' => 'The task is complete.', 'Failed' => 'The task failed.', 'Running' => 'The task is in progress.'], 'type' => 'string', + 'example' => 'Running', + 'title' => '', ], + 'RetryTimes' => ['description' => 'The retry count.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InternalError.TicketGenInternalError', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'reenter app instance failed', 'title' => ''], + 'AppInstanceGroupId' => ['description' => 'The ID of the app instance group.', 'type' => 'string', 'example' => 'aig-53fvrq1oa******', 'title' => ''], + 'AppInstancePersistentId' => ['description' => 'The ID of the persistent session.', 'type' => 'string', 'example' => 'p-0cdr5c9kl******', 'title' => ''], + 'AppInstanceId' => ['description' => 'The ID of the app instance.', 'type' => 'string', 'example' => 'ai-gc1gemx6vp******', 'title' => ''], 'OsType' => [ - 'description' => '', - 'enumValueTitles' => [ - 'Linux' => 'Linux', - 'Windows' => 'Windows', - 'Android' => 'Android', - ], - 'example' => 'Windows', + 'description' => 'The operating system type.', + 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows', 'Android' => 'Android'], 'type' => 'string', + 'example' => 'Windows', + 'title' => '', ], - 'RegionId' => [ - 'description' => '', - 'example' => 'cn-hangzhou', - 'type' => 'string', - ], - 'LoginToken' => [ - 'description' => '', - 'example' => 'v15418e331d8d068c29411646996786785303b8f61fd880aeaa50c5b584443cd9e65cc7eec72acdaad0a844666a3b26dab', - 'type' => 'string', - ], - 'TenantId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'RegionId' => ['description' => 'The region ID of the app instance group.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'LoginToken' => ['description' => 'The login token.', 'type' => 'string', 'example' => 'v2c4e2ef03d62******'."\n", 'title' => ''], + 'TenantId' => ['description' => 'The ID of the tenant, which is the unique identifier (UID) of the Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'example' => '1126819517******', 'title' => ''], 'Policy' => [ + 'description' => 'The session policy.', 'type' => 'object', 'properties' => [ 'ResolutionAdaptive' => [ + 'description' => 'Indicates whether adaptive resolution is enabled.'."\n" + ."\n" + .'> - If set to `true`, the session resolution adapts to the client\'s display area, up to the maximums defined by `ResolutionWidth` and `ResolutionHeight`.'."\n" + .'>'."\n" + .'> - If set to `false`, the session resolution is fixed to the values defined by `ResolutionWidth` and `ResolutionHeight`.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'string', + 'example' => 'true', + 'title' => '', ], - 'ResolutionWidth' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ResolutionHeight' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'ResolutionWidth' => ['description' => 'The width of the resolution, in pixels.', 'type' => 'integer', 'format' => 'int32', 'example' => '1920'."\n", 'title' => ''], + 'ResolutionHeight' => ['description' => 'The height of the resolution, in pixels.', 'type' => 'integer', 'format' => 'int32', 'example' => '1080', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'BindQueueInfo' => [ + 'description' => 'The queue information.'."\n" + ."\n" + .'> This parameter is not yet available.', 'type' => 'object', 'properties' => [ - 'RequestKey' => [ - 'type' => 'string', - ], - 'TargetId' => [ - 'type' => 'string', - ], + 'RequestKey' => ['description' => 'The key for the queue request.', 'type' => 'string', 'example' => 'alice******', 'title' => ''], + 'TargetId' => ['description' => 'The queue ID.', 'type' => 'string', 'example' => 'aig-53fvrq1oa******'."\n", 'title' => ''], 'QueueStatus' => [ + 'description' => 'Your status in the queue.', + 'enumValueTitles' => ['Ready' => 'You are at the front of the queue.', 'Waiting' => 'You are waiting in the queue.'], 'type' => 'string', + 'example' => 'Waiting', + 'title' => '', ], - 'ReadyTimeout' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Rank' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'WaitTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RemainingTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'ReadyTimeout' => ['description' => 'The time limit, in seconds, for connecting manually after you reach the front of the queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], + 'Rank' => ['description' => 'Your position in the queue.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'WaitTime' => ['description' => 'The time, in seconds, you have been waiting in the queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'RemainingTime' => ['description' => 'The estimated remaining wait time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'AvatarId' => [ - 'title' => '分身ID。', - 'type' => 'string', - 'example' => 'abc', - 'default' => 'default', - ], - 'NextPollIntervalMs' => [ - 'title' => '下一次轮询间隔，单位为ms，为空则为1000ms。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - 'default' => '1000', - ], + 'AvatarId' => ['title' => 'Avatar ID.', 'description' => 'The avatar ID.', 'type' => 'string', 'example' => 'abc', 'default' => 'default'], + 'NextPollIntervalMs' => ['title' => 'Next polling interval, in milliseconds. If empty, the default value is 1000 ms.', 'description' => 'The next polling interval, in milliseconds. If this parameter is not returned, the default interval is 1,000 ms.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'default' => '1000'], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain application connection credentials', + 'summary' => 'Retrieve the connection credentials for the cloud application.', + 'description' => 'Getting a Ticket can be time-consuming, so you may need to call this API multiple times to retrieve it.'."\n" + ."\n" + .'1. The initial call allocates an application instance to the specified convenience account and starts the application. This call returns a task ID (`TaskId`).'."\n" + ."\n" + .'2. For subsequent calls, pass the TaskId to query the task status. When the returned `TaskStatus` is `Finished`, the call also returns the `Ticket`.'."\n" + ."\n" + .'> - If the startup process is fast enough, the initial call may also return the `Ticket`.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConnectionTicket'], + ], ], + 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169******\\",\\n \\"Ticket\\": \\"n7n9bqZlPrvgUOPY0tOfVYGBBcdoPoH3******\\",\\n \\"TaskId\\": \\"f3d1b31c-605e-******\\",\\n \\"TaskStatus\\": \\"Running\\",\\n \\"RetryTimes\\": 3,\\n \\"Code\\": \\"InternalError.TicketGenInternalError\\",\\n \\"Message\\": \\"reenter app instance failed\\",\\n \\"AppInstanceGroupId\\": \\"aig-53fvrq1oa******\\",\\n \\"AppInstancePersistentId\\": \\"p-0cdr5c9kl******\\",\\n \\"AppInstanceId\\": \\"ai-gc1gemx6vp******\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LoginToken\\": \\"v2c4e2ef03d62******\\\\n\\",\\n \\"TenantId\\": 0,\\n \\"Policy\\": {\\n \\"ResolutionAdaptive\\": \\"true\\",\\n \\"ResolutionWidth\\": 1920,\\n \\"ResolutionHeight\\": 1080\\n },\\n \\"BindQueueInfo\\": {\\n \\"RequestKey\\": \\"alice******\\",\\n \\"TargetId\\": \\"aig-53fvrq1oa******\\\\n\\",\\n \\"QueueStatus\\": \\"Waiting\\",\\n \\"ReadyTimeout\\": 120,\\n \\"Rank\\": 1,\\n \\"WaitTime\\": 100,\\n \\"RemainingTime\\": 100\\n },\\n \\"AvatarId\\": \\"abc\\",\\n \\"NextPollIntervalMs\\": 500\\n}","type":"json"}]', - 'title' => 'GetConnectionTicket', ], 'ListPublishedAppInfo' => [ - 'summary' => 'Queries information about published apps.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Lists information about published applications.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -474,255 +334,171 @@ [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '17b38aaa-761f-44c5-9862-2ad0f5025d15', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'A unique ID generated by the client.', 'type' => 'string', 'required' => false, 'example' => '17b38aaa-761f-44c5-9862-2ad0f5025d15', 'title' => ''], ], [ 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'v189fa78c1aff77a0483b16497517322299131027b85bb84bbdc0871988ce8296d8fd891e2fdeaded3bd75f81f639acee8', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'A login credential. Get it by calling the GetLoginToken operation. Or refresh it by calling RefreshLoginToken after logging in. The response includes LoginToken.', 'type' => 'string', 'required' => false, 'example' => 'v189fa78c1aff77a0483b16497517322299131027b85bb84bbdc0871988ce8296d8fd891e2fdeaded3bd75f81f639acee8', 'title' => ''], ], [ 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'test.test', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'A convenience account username.', 'type' => 'string', 'required' => false, 'example' => 'test.test', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'c261a6a1-e242-4f4b-813c-5fe807e49f03', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'A session ID. Get it by calling the GetLoginToken operation. The response includes SessionId.', 'type' => 'string', 'required' => false, 'example' => 'c261a6a1-e242-4f4b-813c-5fe807e49f03', 'title' => ''], ], [ 'name' => 'ClientOS', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'windows_\\"Windows 10 Enterprise\\" 10.0 (Build 14393)', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The client operating system.', 'type' => 'string', 'required' => false, 'example' => 'windows_\\"Windows 10 Enterprise\\" 10.0 (Build 14393)', 'title' => ''], ], [ 'name' => 'ClientVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '2.0.1-D-20211008.101607'."\n", - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The client version.', 'type' => 'string', 'required' => false, 'example' => '2.0.1-D-20211008.101607'."\n", 'title' => ''], ], [ 'name' => 'ClientIp', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '125.80.132.13', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The client IP address.', 'type' => 'string', 'required' => false, 'example' => '125.80.132.13', 'title' => ''], ], [ 'name' => 'ProductType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'CloudApp', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The product type. Set this to `CloudApp` for WUYING AppStreaming.', 'type' => 'string', 'required' => false, 'example' => 'CloudApp', 'title' => ''], ], [ 'name' => 'BizRegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'cn-hangzhou', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The region ID of the delivery group. For a list of supported regions, see [Limits](https://help.aliyun.com/document_detail/426036.html).', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'LoginRegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'cn-shanghai', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The region ID of appstream-center.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], ], [ 'name' => 'CategoryType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The level 1 category of the application. Valid values:'."\n" + ."\n" + .'- 0: Cloud application'."\n" + ."\n" + .'- 1: Cloud game', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'CategoryId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The level 2 category of the application. Valid values:'."\n" + ."\n" + .'- 1: All applications'."\n" + ."\n" + .'- 2: Design software'."\n" + ."\n" + .'- 3: Programming and development'."\n" + ."\n" + .'- 4: Office essentials'."\n" + ."\n" + .'- 5: Input method'."\n" + ."\n" + .'- 6: Images and video'."\n" + ."\n" + .'- 7: System tools'."\n" + ."\n" + .'- 8: Browser', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'Microsoft Word', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The application name. Use this parameter to perform a fuzzy search by application name.', 'type' => 'string', 'required' => false, 'example' => 'Microsoft Word', 'title' => ''], ], [ 'name' => 'OrderParam', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'default' => 'APP_NAME', - ], + 'schema' => ['type' => 'string', 'default' => 'APP_NAME', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'SortType', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'default' => 'DESC', - ], + 'schema' => ['type' => 'string', 'default' => 'DESC', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'Response schema', 'properties' => [ - 'RequestId' => [ - 'description' => 'Id of the request', - 'example' => 'DB70F8FE-63A3-587B-8560-CEC258E8B944', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'NextToken' => [ - 'description' => '', - 'example' => '2NVfhLfgy5b3J5iJyoLQ6x4EULMg1hbhgB9NfnvdK9oj5zwxd17j4TuQkZze3RvhEvBinZYjknujF3Q1M', - 'type' => 'string', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DB70F8FE-63A3-587B-8560-CEC258E8B944'], + 'NextToken' => ['description' => 'The token used to start the next query.', 'type' => 'string', 'example' => '2NVfhLfgy5b3J5iJyoLQ6x4EULMg1hbhgB9NfnvdK9oj5zwxd17j4TuQkZze3RvhEvBinZYjknujF3Q1M', 'title' => ''], 'AppModels' => [ - 'description' => 'appModels', + 'description' => 'The list of application models.', 'items' => [ 'properties' => [ - 'AppId' => [ - 'description' => '', - 'example' => 'ca-fxwp4koyr5y2sp4mz', - 'type' => 'string', - ], - 'AppName' => [ - 'description' => '', - 'example' => 'Microsoft Word', - 'type' => 'string', - ], - 'AppVersion' => [ - 'description' => '', - 'example' => 'R2021a', - 'type' => 'string', - ], - 'AppVersionName' => [ - 'description' => '', - 'example' => 'v1.0', - 'type' => 'string', - ], - 'IconUrl' => [ - 'description' => '', - 'example' => 'https://app-streaming-icon-prod-shanghai.oss-cn-shanghai.aliyuncs.com/tenant/1973619010349344/1634523814270_Matlab.png', - 'type' => 'string', - ], - 'IsAuth' => [ - 'description' => '', - 'example' => 'True', - 'type' => 'boolean', - ], - 'UsedInSession' => [ - 'description' => '', - 'example' => 'True', - 'type' => 'boolean', - ], - 'AppCenterImageId' => [ - 'description' => '', - 'example' => 'img-f37nddbjc1lje14st', - 'type' => 'string', - ], - 'CategoryType' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'CategoryId' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int64', - 'type' => 'integer', - ], - 'AppThemeColor' => [ - 'type' => 'string', - ], - 'AuthTime' => [ - 'type' => 'string', - ], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'ca-fxwp4koyr5y2sp4mz', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'Microsoft Word', 'title' => ''], + 'AppVersion' => ['description' => 'The application version number.', 'type' => 'string', 'example' => 'R2021a', 'title' => ''], + 'AppVersionName' => ['description' => 'The application version name.', 'type' => 'string', 'example' => 'v1.0', 'title' => ''], + 'IconUrl' => ['description' => 'The URL of the application icon.', 'type' => 'string', 'example' => 'https://app-streaming-icon-prod-shanghai.oss-cn-shanghai.aliyuncs.com/tenant/1973619010349344/1634523814270_Matlab.png', 'title' => ''], + 'IsAuth' => ['description' => 'Indicates whether the user has permission. Returns true.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'UsedInSession' => ['description' => 'Indicates whether the application is in use.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'AppCenterImageId' => ['description' => 'The application image ID. Get it from the Image Management page in the WUYING AppStreaming console.', 'type' => 'string', 'example' => 'img-f37nddbjc1lje14st', 'title' => ''], + 'CategoryType' => ['description' => 'The level 1 category of the application. Valid values:'."\n" + ."\n" + .'- 0: Cloud application'."\n" + ."\n" + .'- 1: Cloud game', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'CategoryId' => ['description' => 'The level 2 category of the application. Valid values:'."\n" + ."\n" + .'- 1: All applications'."\n" + ."\n" + .'- 2: Design software'."\n" + ."\n" + .'- 3: Programming and development'."\n" + ."\n" + .'- 4: Office essentials'."\n" + ."\n" + .'- 5: Input method'."\n" + ."\n" + .'- 6: Images and video'."\n" + ."\n" + .'- 7: System tools'."\n" + ."\n" + .'- 8: Browser', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'AppThemeColor' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AuthTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], 'title' => 'appModels', 'type' => 'array', + 'example' => '', ], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DB70F8FE-63A3-587B-8560-CEC258E8B944\\",\\n \\"NextToken\\": \\"2NVfhLfgy5b3J5iJyoLQ6x4EULMg1hbhgB9NfnvdK9oj5zwxd17j4TuQkZze3RvhEvBinZYjknujF3Q1M\\",\\n \\"AppModels\\": [\\n {\\n \\"AppId\\": \\"ca-fxwp4koyr5y2sp4mz\\",\\n \\"AppName\\": \\"Microsoft Word\\",\\n \\"AppVersion\\": \\"R2021a\\",\\n \\"AppVersionName\\": \\"v1.0\\",\\n \\"IconUrl\\": \\"https://app-streaming-icon-prod-shanghai.oss-cn-shanghai.aliyuncs.com/tenant/1973619010349344/1634523814270_Matlab.png\\",\\n \\"IsAuth\\": true,\\n \\"UsedInSession\\": true,\\n \\"AppCenterImageId\\": \\"img-f37nddbjc1lje14st\\",\\n \\"CategoryType\\": 1,\\n \\"CategoryId\\": 2,\\n \\"AppThemeColor\\": \\"\\",\\n \\"AuthTime\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListPublishedAppInfo', + 'title' => 'Query the list of published applications', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'ListRunningApps' => [ - 'summary' => 'Queries running apps.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Lists running applications.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -734,229 +510,127 @@ [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '370b56f8-2812-4b6c-bfa6-2560791cad88', - ], + 'schema' => ['description' => 'A unique ID generated by the client.', 'type' => 'string', 'required' => false, 'example' => '370b56f8-2812-4b6c-bfa6-2560791cad88', 'title' => ''], ], [ 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'v1124500957832f30b3e716406562071655aa43b2a723ed2be0837815483d54e025db13ba5469f06f2410d0efc4d302e36', - ], + 'schema' => ['description' => 'A login credential. Get it by calling the GetLoginToken operation. Or refresh it by calling RefreshLoginToken after logging in. This parameter is returned as LoginToken.', 'type' => 'string', 'required' => false, 'example' => 'v1124500957832f30b3e716406562071655aa43b2a723ed2be0837815483d54e025db13ba5469f06f2410d0efc4d302e36', 'title' => ''], ], [ 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test.test', - ], + 'schema' => ['description' => 'The username of a convenience account.', 'type' => 'string', 'required' => false, 'example' => 'test.test', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a863f4c3-2f1d-4971-8cf7-e2b92ae97764', - ], + 'schema' => ['description' => 'A session ID. Get it by calling the GetLoginToken operation. This parameter is returned as SessionId.', 'type' => 'string', 'required' => false, 'example' => 'a863f4c3-2f1d-4971-8cf7-e2b92ae97764', 'title' => ''], ], [ 'name' => 'ClientOS', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'windows_"Windows 10 Enterprise" 10.0 (Build 18363)', - ], + 'schema' => ['description' => 'The operating system of the client.', 'type' => 'string', 'required' => false, 'example' => 'windows_"Windows 10 Enterprise" 10.0 (Build 18363)', 'title' => ''], ], [ 'name' => 'ClientVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0.1.0-R-20220512.175656', - ], + 'schema' => ['description' => 'The version of the client.', 'type' => 'string', 'required' => false, 'example' => '0.1.0-R-20220512.175656', 'title' => ''], ], [ 'name' => 'ClientIp', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '22.21.2.32', - ], + 'schema' => ['description' => 'The IP address of the client.', 'type' => 'string', 'required' => false, 'example' => '22.21.2.32', 'title' => ''], ], [ 'name' => 'ProductType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The type of product. Valid value: `CloudApp`. This value indicates WUYING AppStreaming.', + 'enumValueTitles' => ['CloudApp' => 'Cloud application'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'CloudApp' => '', - ], 'example' => 'CloudApp', + 'title' => '', ], ], [ 'name' => 'BizRegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the delivery group.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'TenantId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1735953493960828', - ], + 'schema' => ['description' => 'The tenant ID. Get it by calling the GetLoginToken operation. This parameter is returned as TenantId.', 'type' => 'string', 'required' => false, 'example' => '1735953493960828', 'title' => ''], ], [ 'name' => 'LoginRegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID where you log in.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '470E8C12AB78CE9C3F6627DD0409E51D', - ], + 'schema' => ['description' => 'The UUID of the device used for login.', 'type' => 'string', 'required' => false, 'example' => '470E8C12AB78CE9C3F6627DD0409E51D', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2DC3521C-3820-5EA5-9A9A-00BB7AF4E8E5', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '2DC3521C-3820-5EA5-9A9A-00BB7AF4E8E5'], 'RunningCloudApps' => [ 'title' => 'appModels', - 'description' => '', + 'description' => 'A list of running cloud applications.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Information about a running cloud application.', 'type' => 'object', 'properties' => [ - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ca-dln05y44ze6esfl8x', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'alihealth-keeper', - ], - 'AppVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '11.1', - ], - 'AppVersionName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test1.0', - ], - 'IconUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://app-icon-shanghai.oss-cn-shanghai.aliyuncs.com/tenant/187465/18_bf1.jpg', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'AppInstanceGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'aig-dk8p95irk9xs5xi6a', - ], - 'AppInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ai-gc1gemx6vpa6vlync', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1642748400', - ], - 'Duration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '87', - ], + 'AppId' => ['description' => 'The ID of the application.', 'type' => 'string', 'example' => 'ca-dln05y44ze6esfl8x', 'title' => ''], + 'AppName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'alihealth-keeper', 'title' => ''], + 'AppVersion' => ['description' => 'The version of the application.', 'type' => 'string', 'example' => '11.1', 'title' => ''], + 'AppVersionName' => ['description' => 'The version name of the application.', 'type' => 'string', 'example' => 'test1.0', 'title' => ''], + 'IconUrl' => ['description' => 'The URL of the application icon.', 'type' => 'string', 'example' => 'https://app-icon-shanghai.oss-cn-shanghai.aliyuncs.com/tenant/187465/18_bf1.jpg', 'title' => ''], + 'RegionId' => ['description' => 'The region ID where the cloud application runs.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'AppInstanceGroupId' => ['description' => 'The ID of the delivery group.', 'type' => 'string', 'example' => 'aig-dk8p95irk9xs5xi6a', 'title' => ''], + 'AppInstanceId' => ['description' => 'The ID of the application instance.', 'type' => 'string', 'example' => 'ai-gc1gemx6vpa6vlync', 'title' => ''], + 'StartTime' => ['description' => 'The time when the application started.', 'type' => 'string', 'example' => '1642748400', 'title' => ''], + 'Duration' => ['description' => 'The runtime of the cloud application instance, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '87', 'title' => ''], 'OsType' => [ - 'description' => '', + 'description' => 'The OS type of the platform where the instance runs.', + 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows', 'Android' => 'Android'], 'type' => 'string', - 'enumValueTitles' => [ - 'Linux' => 'Linux', - 'Windows' => 'Windows', - 'Android' => 'Android', - ], 'example' => 'Windows', + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DC3521C-3820-5EA5-9A9A-00BB7AF4E8E5\\",\\n \\"RunningCloudApps\\": [\\n {\\n \\"AppId\\": \\"ca-dln05y44ze6esfl8x\\",\\n \\"AppName\\": \\"alihealth-keeper\\",\\n \\"AppVersion\\": \\"11.1\\",\\n \\"AppVersionName\\": \\"test1.0\\",\\n \\"IconUrl\\": \\"https://app-icon-shanghai.oss-cn-shanghai.aliyuncs.com/tenant/187465/18_bf1.jpg\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AppInstanceGroupId\\": \\"aig-dk8p95irk9xs5xi6a\\",\\n \\"AppInstanceId\\": \\"ai-gc1gemx6vpa6vlync\\",\\n \\"StartTime\\": \\"1642748400\\",\\n \\"Duration\\": 87,\\n \\"OsType\\": \\"Windows\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListRunningApps', - ], - 'Unbind' => [ - 'summary' => 'Unbinds an app instance from a user.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Query the List of running applications', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'ResetAppResources' => [ + 'summary' => 'Resets application resources.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -964,153 +638,88 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREappstreamingEP3FXS', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ProductType', + 'name' => 'BizRegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CloudApp', - ], + 'schema' => ['description' => 'ID of the business region.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], [ - 'name' => 'AppInstanceGroupId', + 'name' => 'LoginToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'aig-e1l4kqqykxt4uzdx9', - 'maxItems' => 100, - ], + 'schema' => ['description' => 'Login token.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'v285fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d****'], ], [ - 'name' => 'AppInstanceId', + 'name' => 'EndUserId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'Username.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'user01'], ], [ - 'name' => 'AppId', + 'name' => 'SessionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ca-fxwp4koxs8hopi94e', - ], + 'schema' => ['description' => 'Session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'c261a6a1-e242-4f4b-813c-5fe807e49f03'], ], [ - 'name' => 'EndUserId', + 'name' => 'LoginRegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test.test', - ], + 'schema' => ['description' => 'Region ID used when logging in from the corporate network.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ClientOS', + 'name' => 'Uuid', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'windows_\\"Windows 10 Pro\\" 10.0 (Build 19041)', - ], + 'schema' => ['description' => 'Client UUID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2943802884B27030B6759F9132B2****'], ], [ 'name' => 'ClientId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'eac19bef-1e45-4190-a03a-4ea74b699ca7', - ], + 'schema' => ['description' => 'Client ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****'."\n"], ], [ - 'name' => 'ClientVersion', + 'name' => 'ClientOS', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2.0.1-D-20220303.171122', - ], + 'schema' => ['description' => 'Client operating system.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'windows_\\"Windows 10 Pro\\" 10.0 (Build 22631)'], ], [ - 'name' => 'ClientIp', + 'name' => 'ClientVersion', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '139.129.223.122', - ], + 'schema' => ['description' => 'Client version.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '7.7.0-R-20241217.092056'], ], [ - 'name' => 'LoginToken', + 'name' => 'ClientIp', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'v1e9c8e83d83ea11270871640059145702bde8c5be8c6b9a854ffb6a43bd2673c19a5551c83800724e024f488dbfb0b247', - ], + 'schema' => ['description' => 'Client IP address.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1.2.3.4'], ], [ - 'name' => 'SessionId', + 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'Product type.', + 'enumValueTitles' => ['CloudApp' => 'Cloud application', 'CloudBrowser' => 'Cloud browser', 'AndroidCloud' => 'Cloud phone'], 'type' => 'string', 'required' => true, - 'example' => '11040139-4fb4-4b35-9b44-6c07c746a43e', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1569416393841402', + 'title' => '', + 'example' => 'AndroidCloud', ], ], [ - 'name' => 'LoginRegionId', + 'name' => 'AppInstanceGroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => 'Resource group ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'aig-9ciijz60n4xsv****'], ], [ - 'name' => 'AppInstancePersistentId', + 'name' => 'ResourceIds', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'title' => '持久会话ID。', - 'type' => 'string', - 'example' => 'p-xxxxx', + 'title' => '', + 'description' => 'List of resource IDs.', + 'type' => 'array', + 'items' => ['description' => 'Resource ID. For cloud phones, provide the persistent session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'p-00001'], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + 'example' => '', ], ], ], @@ -1118,304 +727,152 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '6EBD4046-2202-5FBD-8595-4B631F0C484B', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'Code' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'InvalidAppInstanceGroup.NotFound', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'The app instance group is not found.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call succeeded. true: succeeded. false: failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidAppInstanceGroup.NotFound\\",\\n \\"Message\\": \\"The app instance group is not found.\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Reset application resources', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EBD4046-2202-5FBD-8595-4B631F0C484B\\"\\n}","type":"json"}]', - 'title' => 'Unbind', ], - 'StopApp' => [ - 'summary' => 'Stops a specific app.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RestartAppResources' => [ + 'summary' => 'Restart application resources.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'AppInstanceGroupId', + 'name' => 'BizRegionId', 'in' => 'formData', - 'schema' => [ - 'title' => '实例组id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'aig-89ibriac2wudyph38', - ], + 'schema' => ['description' => 'Business region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], [ - 'name' => 'AppInstanceId', + 'name' => 'LoginToken', 'in' => 'formData', - 'schema' => [ - 'title' => '实例id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ai-d297eyf83g5niwnjl', - ], + 'schema' => ['description' => 'Login token.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'v1124500957832f30b3e716406562071655aa43b2a723ed2be0837815483d54e025db13ba5469f06f2410d0efc4d302e36'], ], [ - 'name' => 'AppId', + 'name' => 'EndUserId', 'in' => 'formData', - 'schema' => [ - 'title' => '应用id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ca-fxwp4koywsglzvvex', - ], + 'schema' => ['description' => 'Username.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'user001'], ], [ - 'name' => 'ProductType', + 'name' => 'SessionId', 'in' => 'formData', - 'schema' => [ - 'title' => '产品线', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CloudApp' => '', - ], - 'example' => 'CloudApp', - ], + 'schema' => ['description' => 'Session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'c261a6a1-e242-4f4b-813c-5fe807e49f03'], ], [ - 'name' => 'ForceStop', + 'name' => 'LoginRegionId', 'in' => 'formData', - 'schema' => [ - 'title' => '强制停止', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], + 'schema' => ['description' => 'Region ID when logging on to the office network.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ApiType', + 'name' => 'Uuid', 'in' => 'formData', - 'schema' => [ - 'title' => 'AdminAPI, InnerAPI, AnonymousUserAPI', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'AnonymousUserAPI' => 'AnonymousUserAPI', - ], - 'example' => 'AnonymousUserAPI', - ], + 'schema' => ['description' => 'Client UUID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2943802884B27030B6759F9132B2****'], ], [ 'name' => 'ClientId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '91b79184-51d0-42ad-8475-78cae95b0aa6', - ], - ], - [ - 'name' => 'LoginToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d330e', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test.test', - ], - ], - [ - 'name' => 'SessionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '597e869d-ea14-4b83-9490-714f68bfe935', - ], + 'schema' => ['description' => 'Client ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'eac19bef-1e45-4190-a03a-4ea74b699ca7'], ], [ 'name' => 'ClientOS', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'windows_"Windows 10 Enterprise" 10.0 (Build 19042)', - ], + 'schema' => ['description' => 'Client operating system.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'windows_\\"Windows 10 Enterprise\\" 10.0 (Build 14393)'], ], [ 'name' => 'ClientVersion', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3.1.1-R-20211022.144255', - ], + 'schema' => ['description' => 'Client version.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '7.5.3-RS-20241127.131156'], ], [ 'name' => 'ClientIp', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '22.21.2.79', - ], - ], - [ - 'name' => 'BizRegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Client IP.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1.2.3.4'], ], [ - 'name' => 'LoginRegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ClientChannel', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'pc' => 'pc', - 'web' => 'web', - 'mobile' => 'mobile', - ], - 'example' => 'pc', - ], - ], - [ - 'name' => 'Uuid', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2943802884B27030B6759F9132B26903', - ], - ], - [ - 'name' => 'WyId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ac3cb49059261898', - ], - ], - [ - 'name' => 'IdpId', + 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'Product type.', + 'enumValueTitles' => ['CloudApp' => 'Cloud application', 'CloudBrowser' => 'Cloud browser', 'AndroidCloud' => 'Cloud phone'], 'type' => 'string', - 'required' => false, - 'example' => 'idp-9ie5smicnct2xodn2', + 'required' => true, + 'title' => '', + 'example' => 'AndroidCloud', ], ], [ - 'name' => 'AliUid', + 'name' => 'AppInstanceGroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1924794279035094', - ], + 'schema' => ['description' => 'Resource group ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'aig-53fvrq1oanz6c****'], ], [ - 'name' => 'RegionId', + 'name' => 'ResourceIds', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'title' => '', + 'description' => 'Resource ID list.', + 'type' => 'array', + 'items' => ['description' => 'Resource ID. For cloud phones, enter the persistent session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'p-00001'], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult', - 'description' => 'BaseResult', + 'title' => 'Schema of Response', + 'description' => 'Response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '83A9075B-C646-59A9-8232-CAE41AF4B9E3', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'Code' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'InvalidAppInstanceGroup.NotFound', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'The app instance group is not found.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. true: The call was successful. false: The call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"83A9075B-C646-59A9-8232-CAE41AF4B9E3\\"\\n}","type":"json"}]', - 'title' => 'StopApp', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidAppInstanceGroup.NotFound\\",\\n \\"Message\\": \\"The app instance group is not found.\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Restart Application Resource ', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], ], 'StartAppResources' => [ - 'summary' => 'Starts app resources.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Start application resources.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -1423,167 +880,88 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'BizRegionId', 'in' => 'formData', - 'schema' => [ - 'title' => '业务地域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Business region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'LoginToken', 'in' => 'formData', - 'schema' => [ - 'title' => '登录Token。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d****', - ], + 'schema' => ['description' => 'Login token.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d****'], ], [ 'name' => 'EndUserId', 'in' => 'formData', - 'schema' => [ - 'title' => '用户名。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'testUser01', - ], + 'schema' => ['description' => 'Username.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'testUser01'], ], [ 'name' => 'SessionId', 'in' => 'formData', - 'schema' => [ - 'title' => '会话ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a863f4c3-2f1d-4971-8cf7-e2b92ae9****', - ], + 'schema' => ['description' => 'Session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a863f4c3-2f1d-4971-8cf7-e2b92ae9****'], ], [ 'name' => 'LoginRegionId', 'in' => 'formData', - 'schema' => [ - 'title' => '工作区登录时候的地域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID when logging on to the office network.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'Uuid', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端Uuid。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2943802884B27030B6759F9132B2****', - ], + 'schema' => ['description' => 'Client UUID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2943802884B27030B6759F9132B2****'], ], [ 'name' => 'ClientId', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'eac19bef-1e45-4190-a03a-4ea74b69****', - ], + 'schema' => ['description' => 'Client ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'eac19bef-1e45-4190-a03a-4ea74b69****'], ], [ 'name' => 'ClientOS', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端操作系统。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'windows_\\"Windows 10 Pro\\" 10.0 (Build 22631)', - ], + 'schema' => ['description' => 'Client operating system.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'windows_\\"Windows 10 Pro\\" 10.0 (Build 22631)'], ], [ 'name' => 'ClientVersion', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端版本。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '7.5.1-R-20240903.163046', - ], + 'schema' => ['description' => 'Client version.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '7.5.1-R-20240903.163046'], ], [ 'name' => 'ClientIp', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端IP。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.2.3.4', - ], + 'schema' => ['description' => 'Client IP.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1.2.3.4'], ], [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ - 'title' => '产品类型。', - 'description' => '', + 'description' => 'Product type.', + 'enumValueTitles' => ['CloudApp' => 'Cloud application', 'CloudBrowser' => 'Cloud browser', 'AndroidCloud' => 'Cloud phone'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'CloudApp' => '', - 'CloudBrowser' => '', - 'AndroidCloud' => '', - ], + 'title' => '', 'example' => 'AndroidCloud', ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'formData', - 'schema' => [ - 'title' => '资源组ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'aig-9ciijz60n4xsv****', - ], + 'schema' => ['description' => 'Resource group ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'aig-9ciijz60n4xsv****'], ], [ 'name' => 'ResourceIds', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'title' => '资源ID列表。', - 'description' => '', + 'title' => '', + 'description' => 'Resource ID list.', 'type' => 'array', - 'items' => [ - 'title' => '资源ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-0000001', - ], + 'items' => ['description' => 'Resource ID. For cloud phones, enter the persistent session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'p-0000001'], 'required' => true, 'maxItems' => 100, 'minItems' => 1, + 'example' => '', ], ], ], @@ -1591,269 +969,198 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'InvalidAppInstanceGroup.NotFound', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'The app instance group is not found.', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'Code' => ['description' => 'Error code when an error occurs.', 'type' => 'string', 'example' => 'InvalidAppInstanceGroup.NotFound', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'The app instance group is not found.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidAppInstanceGroup.NotFound\\",\\n \\"Message\\": \\"The app instance group is not found.\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'StartAppResources', - ], - 'StopAppResources' => [ - 'summary' => 'Stops app resources.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Start application resources', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'StopApp' => [ + 'summary' => 'Stops the specified application.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'BizRegionId', + 'name' => 'AppInstanceGroupId', 'in' => 'formData', - 'schema' => [ - 'title' => '业务地域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Delivery group ID. Obtain this ID by calling the ListRunningApps interface. Parameter: AppInstanceGroupId.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'aig-89ibriac2wudyph38'], ], [ - 'name' => 'LoginToken', + 'name' => 'AppInstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '登录Token。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'v12369636c721ba6b3ddb1683341016775c3f63e4d0e78f120f9a0544ed826b7af7daf747c402f0d0730b52f451b70****', - ], + 'schema' => ['description' => 'Instance ID. Obtain this ID by calling the ListRunningApps interface. Parameter: AppInstanceId.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ai-d297eyf83g5niwnjl'], ], [ - 'name' => 'EndUserId', + 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'title' => '用户名。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'testUser', - ], + 'schema' => ['description' => 'Application ID. Obtain this ID by calling the ListRunningApps interface. Parameter: AppId.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ca-fxwp4koywsglzvvex'], ], [ - 'name' => 'SessionId', + 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ - 'title' => '会话ID。', - 'description' => '', + 'description' => 'Product type. The only valid value is `CloudApp`, which represents WUYING AppStreaming.', + 'enumValueTitles' => ['CloudApp' => 'Cloud application'], 'type' => 'string', - 'required' => true, - 'example' => '597e869d-ea14-4b83-9490-714f68bfe935', + 'title' => '', + 'required' => false, + 'example' => 'CloudApp', ], ], [ - 'name' => 'LoginRegionId', + 'name' => 'ForceStop', 'in' => 'formData', 'schema' => [ - 'title' => '工作区登录时候的地域ID。', - 'description' => '', - 'type' => 'string', + 'description' => 'Force stop.', + 'enumValueTitles' => ['true' => 'Force stop', 'false' => 'Do not force stop'], + 'type' => 'boolean', + 'title' => '', 'required' => false, - 'example' => 'cn-hangzhou', + 'example' => 'false', ], ], [ - 'name' => 'Uuid', + 'name' => 'ApiType', 'in' => 'formData', 'schema' => [ - 'title' => '客户端Uuid。', - 'description' => '', + 'title' => 'AdminAPI, InnerAPI, AnonymousUserAPI', + 'description' => 'Interface type. The only valid value is AnonymousUserAPI, which indicates a client call interface.', + 'enumValueTitles' => ['AnonymousUserAPI' => 'AnonymousUserAPI'], 'type' => 'string', 'required' => false, - 'example' => 'C50973691A6D2BE23F2CDD73B85B****', + 'example' => 'AnonymousUserAPI', ], ], [ 'name' => 'ClientId', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'eac19bef-1e45-4190-a03a-4ea74b699ca7', - ], + 'schema' => ['description' => 'Unique ID generated by the client.', 'type' => 'string', 'required' => false, 'example' => '91b79184-51d0-42ad-8475-78cae95b0aa6', 'title' => ''], + ], + [ + 'name' => 'LoginToken', + 'in' => 'formData', + 'schema' => ['description' => 'Login credential. Obtain this credential by calling the GetLoginToken interface to log on, or by calling the RefreshLoginToken update interface after logging on. Return parameter: LoginToken.', 'type' => 'string', 'required' => false, 'example' => 'v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d330e', 'title' => ''], + ], + [ + 'name' => 'EndUserId', + 'in' => 'formData', + 'schema' => ['description' => 'Convenience account username.', 'type' => 'string', 'required' => false, 'example' => 'test.test', 'title' => ''], + ], + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => ['description' => 'Session ID. Obtain this ID by calling the GetLoginToken login interface. Return parameter: SessionId.', 'type' => 'string', 'required' => false, 'example' => '597e869d-ea14-4b83-9490-714f68bfe935', 'title' => ''], ], [ 'name' => 'ClientOS', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端操作系统。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'windows_"Windows 10 Enterprise" 10.0 (Build 19042)', - ], + 'schema' => ['description' => 'Client operating system.', 'type' => 'string', 'required' => false, 'example' => 'windows_"Windows 10 Enterprise" 10.0 (Build 19042)', 'title' => ''], ], [ 'name' => 'ClientVersion', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端版本。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '7.2.0-R-20241008.110000', - ], + 'schema' => ['description' => 'Client version.', 'type' => 'string', 'required' => false, 'example' => '3.1.1-R-20211022.144255', 'title' => ''], ], [ 'name' => 'ClientIp', 'in' => 'formData', + 'schema' => ['description' => 'Client IP address.', 'type' => 'string', 'required' => false, 'example' => '22.21.2.79', 'title' => ''], + ], + [ + 'name' => 'BizRegionId', + 'in' => 'formData', + 'schema' => ['description' => 'Region ID of the delivery group. Obtain this ID by calling the ListRunningApps interface. Parameter: RegionId.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'LoginRegionId', + 'in' => 'formData', + 'schema' => ['description' => 'Login region ID. This is the workspace region ID selected by the user during log on.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ClientChannel', + 'in' => 'formData', 'schema' => [ - 'title' => '客户端IP。', - 'description' => '', + 'description' => 'App client channel. Use this channel to distinguish between different applications.', + 'enumValueTitles' => ['pc' => 'pc', 'web' => 'web', 'mobile' => 'mobile'], 'type' => 'string', 'required' => false, - 'example' => '1.2.3.4', + 'example' => 'pc', + 'title' => '', ], ], [ - 'name' => 'ProductType', + 'name' => 'Uuid', 'in' => 'formData', - 'schema' => [ - 'title' => '产品类型。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'CloudApp' => '', - 'CloudBrowser' => '', - 'AndroidCloud' => '', - ], - 'example' => 'AndroidCloud', - ], + 'schema' => ['description' => 'Device UUID.', 'type' => 'string', 'required' => false, 'example' => '2943802884B27030B6759F9132B26903', 'title' => ''], ], [ - 'name' => 'AppInstanceGroupId', + 'name' => 'WyId', 'in' => 'formData', - 'schema' => [ - 'title' => '资源组ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'aig-9ciijz60n4xsv****', - ], + 'schema' => ['description' => 'WUYING user ID. Obtain this ID by calling the GetLoginToken login interface. Return parameter: WyId.', 'type' => 'string', 'required' => false, 'example' => 'ac3cb49059261898', 'title' => ''], ], [ - 'name' => 'ResourceIds', + 'name' => 'IdpId', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '资源ID列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '资源ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-00001', - ], - 'required' => true, - 'maxItems' => 100, - 'minItems' => 1, - ], + 'schema' => ['description' => 'Login authentication service ID. Obtain this ID by calling the FindIdpListByLoginName interface.', 'type' => 'string', 'required' => false, 'example' => 'idp-9ie5smicnct2xodn2', 'title' => ''], + ], + [ + 'name' => 'AliUid', + 'in' => 'formData', + 'schema' => ['description' => 'Tenant ID. Obtain this ID by calling the GetLoginToken login interface. Return parameter: TenantId.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1924794279035094', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => ['description' => 'Region ID of the delivery group. Obtain this ID by calling the ListRunningApps interface. Parameter: RegionId.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => 'BaseResult', + 'description' => 'BaseResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '829444D6-9FD3-5C65-A570-065975537647', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'InvalidAppInstanceGroup.NotFound', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'The app instance group is not found.', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '83A9075B-C646-59A9-8232-CAE41AF4B9E3', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"83A9075B-C646-59A9-8232-CAE41AF4B9E3\\"\\n}","type":"json"}]', + 'title' => 'Stop Application', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"829444D6-9FD3-5C65-A570-065975537647\\",\\n \\"Code\\": \\"InvalidAppInstanceGroup.NotFound\\",\\n \\"Message\\": \\"The app instance group is not found.\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'StopAppResources', ], - 'RestartAppResources' => [ - 'summary' => 'Restarts app resources.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopAppResources' => [ + 'summary' => 'Shuts down application resources.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -1861,167 +1168,88 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'BizRegionId', 'in' => 'formData', - 'schema' => [ - 'title' => '业务地域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The business region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'LoginToken', 'in' => 'formData', - 'schema' => [ - 'title' => '登录Token。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'v1124500957832f30b3e716406562071655aa43b2a723ed2be0837815483d54e025db13ba5469f06f2410d0efc4d302e36', - ], + 'schema' => ['description' => 'The logon token.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'v12369636c721ba6b3ddb1683341016775c3f63e4d0e78f120f9a0544ed826b7af7daf747c402f0d0730b52f451b70****'], ], [ 'name' => 'EndUserId', 'in' => 'formData', - 'schema' => [ - 'title' => '用户名。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'user001', - ], + 'schema' => ['description' => 'The username.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'testUser'], ], [ 'name' => 'SessionId', 'in' => 'formData', - 'schema' => [ - 'title' => '会话ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'c261a6a1-e242-4f4b-813c-5fe807e49f03', - ], + 'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '597e869d-ea14-4b83-9490-714f68bfe935'], ], [ 'name' => 'LoginRegionId', 'in' => 'formData', - 'schema' => [ - 'title' => '工作区登录时候的地域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID for office network logon.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'Uuid', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端Uuid。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2943802884B27030B6759F9132B2****', - ], + 'schema' => ['description' => 'The UUID of the client.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'C50973691A6D2BE23F2CDD73B85B****'], ], [ 'name' => 'ClientId', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'eac19bef-1e45-4190-a03a-4ea74b699ca7', - ], + 'schema' => ['description' => 'The client ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'eac19bef-1e45-4190-a03a-4ea74b699ca7'], ], [ 'name' => 'ClientOS', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端操作系统。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'windows_\\"Windows 10 Enterprise\\" 10.0 (Build 14393)', - ], + 'schema' => ['description' => 'The operating system of the client.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'windows_"Windows 10 Enterprise" 10.0 (Build 19042)'], ], [ 'name' => 'ClientVersion', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端版本。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '7.5.3-RS-20241127.131156', - ], + 'schema' => ['description' => 'The version of the client.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '7.2.0-R-20241008.110000'], ], [ 'name' => 'ClientIp', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端IP。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.2.3.4', - ], + 'schema' => ['description' => 'The IP address of the client.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1.2.3.4'], ], [ 'name' => 'ProductType', 'in' => 'formData', 'schema' => [ - 'title' => '产品类型。', - 'description' => '', + 'description' => 'The product type.', + 'enumValueTitles' => ['CloudApp' => 'Cloud App', 'CloudBrowser' => 'Cloud Browser', 'AndroidCloud' => 'Cloud Phone'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'CloudApp' => '', - 'CloudBrowser' => '', - 'AndroidCloud' => '', - ], + 'title' => '', 'example' => 'AndroidCloud', ], ], [ 'name' => 'AppInstanceGroupId', 'in' => 'formData', - 'schema' => [ - 'title' => '资源组ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'aig-53fvrq1oanz6c****', - ], + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'aig-9ciijz60n4xsv****'], ], [ 'name' => 'ResourceIds', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'title' => '资源ID列表。', - 'description' => '', + 'title' => '', + 'description' => 'A list of resource IDs.', 'type' => 'array', - 'items' => [ - 'title' => '资源ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-00001', - ], + 'items' => ['description' => 'The resource ID. For Cloud Phone, pass the persistent session ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'p-00001'], 'required' => true, 'maxItems' => 100, 'minItems' => 1, + 'example' => '', ], ], ], @@ -2029,50 +1257,31 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'InvalidAppInstanceGroup.NotFound', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'The app instance group is not found.', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '829444D6-9FD3-5C65-A570-065975537647'], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidAppInstanceGroup.NotFound', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The app instance group is not found.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. \\`true\\` indicates success, and \\`false\\` indicates failure.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"829444D6-9FD3-5C65-A570-065975537647\\",\\n \\"Code\\": \\"InvalidAppInstanceGroup.NotFound\\",\\n \\"Message\\": \\"The app instance group is not found.\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Shut down application resources', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidAppInstanceGroup.NotFound\\",\\n \\"Message\\": \\"The app instance group is not found.\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'RestartAppResources', ], - 'ResetAppResources' => [ - 'summary' => 'Resets app resources.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'Unbind' => [ + 'summary' => 'Unbinds an application instance from a user.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -2084,213 +1293,329 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREappstreamingEP3FXS'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'BizRegionId', + 'name' => 'ProductType', 'in' => 'formData', - 'schema' => [ - 'title' => '业务地域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The product type. The value must be `CloudApp`, which indicates a cloud application product.', 'type' => 'string', 'required' => true, 'example' => 'CloudApp', 'title' => ''], ], [ - 'name' => 'LoginToken', + 'name' => 'AppInstanceGroupId', 'in' => 'formData', - 'schema' => [ - 'title' => '登录Token。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'v285fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d****', - ], + 'schema' => ['description' => 'The ID of the application instance group.', 'type' => 'string', 'required' => true, 'maxItems' => 100, 'example' => 'aig-e1l4kqqykxt4uzdx9', 'title' => ''], ], [ - 'name' => 'EndUserId', + 'name' => 'AppInstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '用户名。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'user01', - ], + 'schema' => ['description' => 'The ID of the application instance.', 'type' => 'string', 'required' => false, 'example' => 'ai-azn3kmwruh1vl****', 'title' => ''], ], [ - 'name' => 'SessionId', + 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'title' => '会话ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'c261a6a1-e242-4f4b-813c-5fe807e49f03', - ], + 'schema' => ['description' => 'The ID of the application.'."\n" + .'Obtain this ID by calling the ListPublishedAppInfo operation.', 'type' => 'string', 'required' => false, 'example' => 'ca-fxwp4koxs8hopi94e', 'title' => ''], ], [ - 'name' => 'LoginRegionId', + 'name' => 'EndUserId', 'in' => 'formData', - 'schema' => [ - 'title' => '工作区登录时候的地域ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The username of the convenience account.', 'type' => 'string', 'required' => false, 'example' => 'test.test', 'title' => ''], ], [ - 'name' => 'Uuid', + 'name' => 'ClientOS', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端Uuid。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2943802884B27030B6759F9132B2****', - ], + 'schema' => ['description' => 'The operating system of the client.', 'type' => 'string', 'required' => false, 'example' => 'windows_\\"Windows 10 Pro\\" 10.0 (Build 19041)', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****'."\n", - ], + 'schema' => ['description' => 'The unique ID that is generated by the client.', 'type' => 'string', 'required' => false, 'example' => 'eac19bef-1e45-4190-a03a-4ea74b699ca7', 'title' => ''], ], [ - 'name' => 'ClientOS', + 'name' => 'ClientVersion', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端操作系统。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'windows_\\"Windows 10 Pro\\" 10.0 (Build 22631)', - ], + 'schema' => ['description' => 'The version number of the client.', 'type' => 'string', 'required' => false, 'example' => '2.0.1-D-20220303.171122', 'title' => ''], ], [ - 'name' => 'ClientVersion', + 'name' => 'ClientIp', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端版本。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '7.7.0-R-20241217.092056', - ], + 'schema' => ['description' => 'The IP address of the client.', 'type' => 'string', 'required' => false, 'example' => '139.129.223.122', 'title' => ''], ], [ - 'name' => 'ClientIp', + 'name' => 'LoginToken', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端IP。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.2.3.4', - ], + 'schema' => ['description' => 'The logon token.'."\n" + .'Obtain this token by calling the GetLoginToken operation. You can also refresh the token by calling the RefreshLoginToken operation. The token is the value of the returned \\`LoginToken\\` parameter.', 'type' => 'string', 'required' => true, 'example' => 'v1e9c8e83d83ea11270871640059145702bde8c5be8c6b9a854ffb6a43bd2673c19a5551c83800724e024f488dbfb0b247', 'title' => ''], ], [ - 'name' => 'ProductType', + 'name' => 'SessionId', 'in' => 'formData', - 'schema' => [ - 'title' => '产品类型。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'CloudApp' => '', - 'CloudBrowser' => '', - 'AndroidCloud' => '', - ], - 'example' => 'AndroidCloud', - ], + 'schema' => ['description' => 'The session ID.'."\n" + .'Obtain this ID by calling the GetLoginToken operation. The ID is the value of the returned \\`SessionId\\` parameter.', 'type' => 'string', 'required' => true, 'example' => '11040139-4fb4-4b35-9b44-6c07c746a43e', 'title' => ''], ], [ - 'name' => 'AppInstanceGroupId', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'title' => '资源组ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'aig-9ciijz60n4xsv****', - ], + 'schema' => ['description' => 'The tenant ID.'."\n" + .'Obtain this ID by calling the GetLoginToken operation. The ID is the value of the returned \\`TenantId\\` parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1569416393841402', 'title' => ''], ], [ - 'name' => 'ResourceIds', + 'name' => 'LoginRegionId', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '资源ID列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '资源ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-00001', - ], - 'required' => true, - 'maxItems' => 100, - 'minItems' => 1, - ], + 'schema' => ['description' => 'The region ID of AppStream Center.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], + ], + [ + 'name' => 'AppInstancePersistentId', + 'in' => 'formData', + 'schema' => ['title' => 'Persistent session ID.', 'description' => 'The ID of the persistent session.', 'type' => 'string', 'example' => 'p-xxxxx', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'InvalidAppInstanceGroup.NotFound', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'The app instance group is not found.', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6EBD4046-2202-5FBD-8595-4B631F0C484B'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EBD4046-2202-5FBD-8595-4B631F0C484B\\"\\n}","type":"json"}]', + 'title' => 'Detach Application Instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"InvalidAppInstanceGroup.NotFound\\",\\n \\"Message\\": \\"The app instance group is not found.\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'ResetAppResources', + 'ramActions' => [], ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'appstream-center.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'appstream-center.ap-southeast-1.aliyuncs.com', + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'appstream-center.cn-shanghai.aliyuncs.com', 'endpoint' => 'appstream-center.cn-shanghai.aliyuncs.com', 'vpc' => 'appstream-center-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'appstream-center.ap-southeast-1.aliyuncs.com', 'endpoint' => 'appstream-center.ap-southeast-1.aliyuncs.com', 'vpc' => 'appstream-center-intl.vpc-proxy.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AddRemoveAccountIsSame', 'message' => 'The same account is to be added and to be removed at the same time.', 'http_code' => 400, 'description' => 'The same account is to be added and to be removed at the same time.'], + ['code' => 'AppCenterImageId.Missing', 'message' => 'The AppCenter ImageId is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'AppCenterImageInfo.NotFound', 'message' => 'The AppCenter ImageInfo is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'AppDeploymentInfo.NotFound', 'message' => 'The AppDeploymentInfo is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'AppInstallation.StartFailed', 'message' => 'Start app installation failed.', 'http_code' => 400, 'description' => 'Failed to start the app installation.'], + ['code' => 'AppInstallationStatus.IsFailed', 'message' => 'App installation failed.', 'http_code' => 400, 'description' => 'The app installation status is failed.'], + ['code' => 'AppInstanceGroupAttributeModify.Failed', 'message' => 'Failed to modify the delivery group attribute.', 'http_code' => 400, 'description' => ''], + ['code' => 'AppInstanceGroupIdIsNull', 'message' => 'The AppInstanceGroupId is null.', 'http_code' => 400, 'description' => ''], + ['code' => 'AppInstanceGroupImageCreate.Failed', 'message' => 'Failed to create an image from the debugging app instance group.', 'http_code' => 400, 'description' => ''], + ['code' => 'AppInstanceGroupNotFound', 'message' => 'The AppInstanceGroup is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'AppInstanceGroupNotFound', 'message' => 'The specified AppInstanceGroup not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'AppType.ValueNotSupported', 'message' => 'The category of the app is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'AuthorizeFailed', 'message' => 'Authorize failed, please check your EndUserId and Password.', 'http_code' => 400, 'description' => 'Invalid username or password.'], + ['code' => 'BillingItem.InsertFailure', 'message' => 'Failed to insert the billing item.', 'http_code' => 400, 'description' => ''], + ['code' => 'BizTypeNotMatch', 'message' => 'The bizType and image do not match.', 'http_code' => 400, 'description' => 'The bizType and image do not match.'], + ['code' => 'BuilderImage.StartTaskFailed', 'message' => 'Failed to start the builder image task.', 'http_code' => 400, 'description' => 'Failed to start the builder image task.'], + ['code' => 'CallBack.PayOrderCallbackFailed', 'message' => 'Failed to lock the order.', 'http_code' => 400, 'description' => ''], + ['code' => 'CashBookInsufficient', 'message' => 'No payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.', 'http_code' => 400, 'description' => ''], + ['code' => 'CheckStock.Failed', 'message' => 'Failed to check the stock.', 'http_code' => 400, 'description' => ''], + ['code' => 'ConnectLdapServer.Failed', 'message' => 'Failed to connect to the LDAP server. Please check the configuration.', 'http_code' => 400, 'description' => ''], + ['code' => 'CreateAppInstanceGroup.Failed', 'message' => 'Failed to create the app instance group.', 'http_code' => 400, 'description' => ''], + ['code' => 'CreateDesktopImageRecord.Failed', 'message' => 'Create cloud computer image failed.', 'http_code' => 400, 'description' => 'Failed to create the cloud computer image.'], + ['code' => 'DeleteTemplate.Failed', 'message' => 'Delete template failed.', 'http_code' => 400, 'description' => 'Failed to delete the template.'], + ['code' => 'DesktopInstance.NotFound', 'message' => 'The cloud computer instance does not exist.', 'http_code' => 400, 'description' => 'The cloud computer instance does not exist.'], + ['code' => 'ExceedAddAccountQuota', 'message' => 'The maximum number of account addition is reached.', 'http_code' => 400, 'description' => 'The maximum number of account addition is reached.'], + ['code' => 'ExceedAppAuthUserQuota', 'message' => 'The authorized user quota of the app is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'ExceedAppInstanceGroupQuota', 'message' => 'The app instance group quota is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'ExceedBuilderQuota', 'message' => 'The maximum number of builders is reached.', 'http_code' => 400, 'description' => 'The maximum number of builders is reached.'], + ['code' => 'ExceedImageQuota', 'message' => 'The maximum number of images is reached.', 'http_code' => 400, 'description' => 'The maximum number of images is reached.'], + ['code' => 'ExceedPoolNodeAmountQuota', 'message' => 'The pool node amount quota is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'ExceedRemoveAccountQuota', 'message' => 'The maximum number of account removal is reached.', 'http_code' => 400, 'description' => 'The maximum number of account removal is reached.'], + ['code' => 'Forbidden.NoPermission', 'message' => 'You are not authorized to access this page.', 'http_code' => 403, 'description' => 'You are not authorized to access this page.'], + ['code' => 'ForbiddenNoRealNameAuthentication', 'message' => 'Operation failed. The user has not completed the real-name authentication.', 'http_code' => 400, 'description' => ''], + ['code' => 'ForbiddenNoRealNameAuthentication', 'message' => 'Forbidden by user real name authentication status.', 'http_code' => 400, 'description' => ''], + ['code' => 'GetLoginTokenError', 'message' => 'Failed to get the login token.', 'http_code' => 400, 'description' => ''], + ['code' => 'Image.CreateModeInvalid', 'message' => 'The creation mode of this task is invalid.', 'http_code' => 400, 'description' => 'The creation mode of this task is invalid.'], + ['code' => 'Image.NotExist', 'message' => 'The image does not exist.', 'http_code' => 400, 'description' => 'The image does not exist.'], + ['code' => 'ImageCreateByInstance.TaskExist', 'message' => 'The image task of instance creation already exists.', 'http_code' => 400, 'description' => 'The image task of instance creation already exists.'], + ['code' => 'ImageDeleteFailed.HasSharedImage', 'message' => 'The shared image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The shared image is not allowed to be deleted.'], + ['code' => 'ImageDeleteFailed.NotAllow', 'message' => 'The image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The image is not allowed to be deleted.'], + ['code' => 'ImageDeleteFailed.NotAllowCommunityParent', 'message' => 'The parent image of a community image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The parent image of a community image is not allowed to be deleted.'], + ['code' => 'ImageDeleteFailed.NotAllowSharedImage', 'message' => 'The shared image is not allowed to be deleted.', 'http_code' => 400, 'description' => 'The shared image is not allowed to be deleted.'], + ['code' => 'ImageDistribute.ImageNotSupport', 'message' => 'The image does not support region distribution.', 'http_code' => 400, 'description' => 'The image does not support region distribution. E.g. encrypted images.'], + ['code' => 'ImageDistribute.RepeatedDistribution', 'message' => 'This image has been distributed to this region.', 'http_code' => 400, 'description' => 'This image has been distributed to this region.'], + ['code' => 'ImageDistribute.TargetDistributeRegionListEmpty', 'message' => 'The target distribution region list is empty.', 'http_code' => 400, 'description' => 'The target distribution region list is empty.'], + ['code' => 'ImageDistribute.Undistributed', 'message' => 'The image has not been distributed to any region.', 'http_code' => 400, 'description' => 'The image has not been distributed to any region.'], + ['code' => 'ImageIsNull', 'message' => 'The image does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'ImageNotAllowDelete', 'message' => 'The image cannot be deleted, because shared cloud computers already exist.', 'http_code' => 400, 'description' => 'The image cannot be deleted, because shared cloud computers already exist.'], + ['code' => 'ImageRegion.NotConfigured', 'message' => 'The image does not have any region configuration.', 'http_code' => 400, 'description' => 'The image does not have any region configuration.'], + ['code' => 'ImageRegionDistribute.NotAllow', 'message' => 'This image cannot be distributed.', 'http_code' => 400, 'description' => 'This image cannot be distributed.'], + ['code' => 'ImageStatus.Error', 'message' => 'The image status is error.', 'http_code' => 400, 'description' => 'The image status is error.'], + ['code' => 'ImageStatus.ValueNotSupported', 'message' => 'The image status is not supported for creating a delivery group.', 'http_code' => 400, 'description' => 'You cannot create a delivery group in the current image status.'], + ['code' => 'ImageTask.Failed', 'message' => 'Start image task failed.', 'http_code' => 400, 'description' => 'Failed to start the image task.'], + ['code' => 'ImageUpdateFailed.NotAllow', 'message' => 'The image is not allowed to be modified.', 'http_code' => 400, 'description' => 'The image is not allowed to be modified.'], + ['code' => 'ImageUpdateSharedImageFailed.NotAllow', 'message' => 'The shared image is not allowed to be modified.', 'http_code' => 400, 'description' => 'The shared image is not allowed to be modified.'], + ['code' => 'Instance.ImageUnsupported', 'message' => 'A non-centralized image does not support this type of operation.', 'http_code' => 400, 'description' => 'A non-centralized image does not support this type of operation.'], + ['code' => 'Instance.NotFound', 'message' => 'The instance is not found.', 'http_code' => 400, 'description' => 'The instance is not found.'], + ['code' => 'Instance.PhysicalNodeNotExist', 'message' => 'The instance physical node does not exist.', 'http_code' => 400, 'description' => 'The physical node of this instance does not exist.'], + ['code' => 'InternalError', 'message' => 'Internal error.', 'http_code' => 400, 'description' => ''], + ['code' => 'InternalError.TicketGenInternalError', 'message' => 'An error occurred while generating a ticket.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAliUid.Missing', 'message' => 'The AliUid is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAliUid.Missing', 'message' => 'The specified parameter AliUid is missing.', 'http_code' => 400, 'description' => 'The specified parameter AliUid is missing.'], + ['code' => 'InvalidAliUid.NotFound', 'message' => 'The AliUid is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAmount.Invalid', 'message' => 'The Amount is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppId.Missing', 'message' => 'The AppId is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppId.NotFound', 'message' => 'The AppId is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppInstanceGroup.NotContainThisAPP', 'message' => 'The app instance group does not contain this app.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppInstanceGroup.NotFound', 'message' => 'The app instance group is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppInstanceGroup.NotFound', 'message' => 'The AppInstanceGroupId %s is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppInstanceGroup.NullAppInstanceGroup', 'message' => 'The app instance group is null.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppInstanceGroup.NullOrNotPublishedStatus', 'message' => 'The app instance group does not exist or is not published.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppInstanceGroup.StatusInvalid', 'message' => 'The app instance group status is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppInstanceGroup.Unauthorized', 'message' => 'Unauthorized to use this app.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppInstanceGroupAction.IllegalAction', 'message' => 'The action against the app instance group is not allowed.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppInstanceGroupId.Missing', 'message' => 'The AppInstanceGroupId is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppInstanceGroupName.Missing', 'message' => 'The AppInstanceGroupName is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppInstanceGroupSpecItem.NotFound', 'message' => 'The app instance group spec item is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppInstanceId.NotFound', 'message' => 'The AppInstanceId is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppInstanceState', 'message' => 'The app instance state is invalid.', 'http_code' => 200, 'description' => ''], + ['code' => 'InvalidAppInstanceType.Invalid', 'message' => 'The AppInstanceType is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppInstanceType.Missing', 'message' => 'The AppInstanceType is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppInstanceType.NotFound', 'message' => 'The app instance type is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppVersion.Missing', 'message' => 'The AppVersion is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidBaseImage.InvalidStatus', 'message' => 'Invalid base image status.', 'http_code' => 400, 'description' => 'The status of the base image is invalid.'], + ['code' => 'InvalidBaseImage.NotConfigured', 'message' => 'Configuration required for Vhd/Container images.', 'http_code' => 400, 'description' => 'Configuration required for Vhd/Container images.'], + ['code' => 'InvalidBaseImage.NotFound', 'message' => 'Base image not found.', 'http_code' => 400, 'description' => 'The base image is not found.'], + ['code' => 'InvalidBaseImage.NotSystemImage', 'message' => 'Base image is not system image.', 'http_code' => 400, 'description' => 'The base image is not a system image.'], + ['code' => 'InvalidBaseImageVersion.NotOnline', 'message' => 'Base image version is not online.', 'http_code' => 400, 'description' => 'The base image is not of an available online version.'], + ['code' => 'InvalidBindRelationship.NotFound', 'message' => 'The bind relationship is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidBindStage.Missing', 'message' => 'The BindStage is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidBindStrategy.NotFound', 'message' => 'The bind strategy is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidBizType', 'message' => 'The bizType parameter is invalid.', 'http_code' => 400, 'description' => 'The bizType parameter is invalid.'], + ['code' => 'InvalidBrowserInstanceGroup.NotFound', 'message' => 'The browser instance group is not found.', 'http_code' => 400, 'description' => 'The cloud browser does not exist, please confirm and try again'], + ['code' => 'InvalidBundle.NotFound', 'message' => 'The request bundle does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidChargeType.Missing', 'message' => 'The ChargeType is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidChargeType.ValueNotSupported', 'message' => 'The ChargeType is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidDataDiskSize.SmallerThanParent', 'message' => 'Sub-image data disk size is smaller than the parent image.', 'http_code' => 400, 'description' => 'Sub-image data disk size is smaller than the parent image.'], + ['code' => 'InvalidDomainId.NotFound', 'message' => 'The DomainId is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidDriveId.NotFound', 'message' => 'The DriveId is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidEndUserId.Missing', 'message' => 'The EndUserId is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidEndUserIds.ValueNotSupported', 'message' => 'The EndUserIds is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidExternalFileId.NotFound', 'message' => 'The ExternalFileId is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidGwAddress.NotFound', 'message' => 'The gateway address is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidGwParam.NotFound', 'message' => 'A parameter error occurred while generating the gateway token.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidGwToken.ValueTooLong', 'message' => 'The GWToken is too long.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImageConfig.RegionInvalid', 'message' => 'The region configuration of this image is invalid.', 'http_code' => 400, 'description' => 'The region configuration of this image is invalid.'], + ['code' => 'InvalidImageId.Invalid', 'message' => 'The specified parameter imageId is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImageOperation.Failed', 'message' => 'Invalid image operation.', 'http_code' => 400, 'description' => 'Image operation failed.'], + ['code' => 'InvalidImageOperation.ImageIsCreating', 'message' => 'Failed to operation the image, it is creating.', 'http_code' => 400, 'description' => 'Failed to operation the image, it is creating.'], + ['code' => 'InvalidImagePackageType.Unsupported', 'message' => 'Unsupported image package type.', 'http_code' => 400, 'description' => 'This package type is not supported.'], + ['code' => 'InvalidInstanceId.Missing', 'message' => 'The InstanceId is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidLoginToken.Missing', 'message' => 'The LoginToken is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidMaxResults', 'message' => 'The MaxResults is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidNextToken', 'message' => 'The NextToken is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidNodeInstanceType.NotFound', 'message' => 'The node instance type is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidNodeInstanceType.NotSupportOsType', 'message' => 'The node instance type does not support images with this OS type.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidOrder.CommodityCodeNotMatch', 'message' => 'No CommodityCode matches this order.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidOrder.CommodityCodeNotMatch', 'message' => 'No commodityCode matched for this order.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidOrderId.NotFound', 'message' => 'The order is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidOrderId.NotFound', 'message' => 'The specified order is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidOsType.ValueNotSupported', 'message' => 'The operation system type is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameter.%s', 'message' => 'The parameter %s is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameter.AddAccount/RemoveAccount', 'message' => 'The tenant ID to be added or removed is invalid.', 'http_code' => 400, 'description' => 'The tenant ID to be added or removed is invalid.'], + ['code' => 'InvalidParameter.ImageId', 'message' => 'The image ID is invalid.', 'http_code' => 400, 'description' => 'The image ID is invalid.'], + ['code' => 'InvalidParameter.SystemDiskSize', 'message' => 'The system disk size is invalid.', 'http_code' => 400, 'description' => 'The system disk size is invalid.'], + ['code' => 'InvalidParentImage.AlreadyHasCommunityImage', 'message' => 'The parent image already has a community image.', 'http_code' => 400, 'description' => 'This image cannot be published to the community because it is already published.'], + ['code' => 'InvalidParentImage.ImageTypeIsNotUserImage', 'message' => 'Invalid operation. The parent image is not a user image.', 'http_code' => 400, 'description' => 'Invalid operation. The parent image is not a user image.'], + ['code' => 'InvalidParentImage.InvalidStatus', 'message' => 'Invalid parent image status.', 'http_code' => 400, 'description' => 'The status of the parent image is invalid.'], + ['code' => 'InvalidParentImage.NotFound', 'message' => 'Parent image not found.', 'http_code' => 400, 'description' => 'The parent image is not found.'], + ['code' => 'InvalidPeriod.Invalid', 'message' => 'The Period is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPeriod.Missing', 'message' => 'The Period is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPeriodUnit.Missing', 'message' => 'The PeriodUnit is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPeriodUnit.ValueNotSupported', 'message' => 'The PeriodUnit is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidProductType.Invalid', 'message' => 'The ProductType is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidProductType.Missing', 'message' => 'The ProductType is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidProductType.ValueNotSupported', 'message' => 'The ProductType is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidRegion.ConfigError', 'message' => 'The region configuration is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidRegion.Missing', 'message' => 'The Region is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidRegion.NotFound', 'message' => 'The region is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidRegion.NotMatch', 'message' => 'The region does not match the current environment.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidRegionBind.NotFound', 'message' => 'The AppRegionBind is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidRegionId.NotFound', 'message' => 'The RegionId is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidResourcePool.NotFound', 'message' => 'The resource pool is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidResponse.Missing', 'message' => 'The response body is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidSessionId.Missing', 'message' => 'The SessionId is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidSourceImage.ImageTypeCannotBeShared', 'message' => 'Source image cannot be shared.', 'http_code' => 400, 'description' => 'This type of source image cannot be shared.'], + ['code' => 'InvalidSourceImage.StatusNotAvailable', 'message' => 'Invalid source image status.', 'http_code' => 400, 'description' => 'The status of the source image is invalid.'], + ['code' => 'InvalidSpecId.Missing', 'message' => 'The SpecId is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStorageType.NotFound', 'message' => 'The StorageType is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStrategyConfig.ChargeTypeNotSupported', 'message' => 'The charge type is not supported for the given strategy.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStrategyConfig.Invalid', 'message' => 'The StrategyConfig is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStrategyConfig.Invalid', 'message' => 'The policy configuration is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStrategyConfig.Missing', 'message' => 'The StrategyConfig is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStrategyConfig.NotFound', 'message' => 'The StrategyConfig is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStrategyParam.Invalid', 'message' => 'The StrategyParam is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStrategyType.ValueNotSupported', 'message' => 'The strategy type is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStrategyType.ValueNotSupported', 'message' => 'The policy type is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidSubAppType.ValueNotSupported', 'message' => 'The sub-category of the app is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidSystemDiskSize.SmallerThanParent', 'message' => 'Sub-image system disk size is smaller than the parent image.', 'http_code' => 400, 'description' => 'Sub-image system disk size is smaller than the parent image.'], + ['code' => 'InvalidTargetAliUid.TargetShareImageAlreadyExist', 'message' => 'Target shared image already exists.', 'http_code' => 400, 'description' => 'The target shared image already exists.'], + ['code' => 'InvalidTaskId.NotFound', 'message' => 'The TaskId is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidTemplate.NotFound', 'message' => 'Template not found.', 'http_code' => 400, 'description' => 'The template is not found.'], + ['code' => 'InvalidUserId.NotFound', 'message' => 'The UserId is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'LogOffAllSession.Failed', 'message' => 'Failed to log off all sessions in the delivery group.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingParameter', 'message' => 'There is a missing parameter.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingParameter.AppIdAndAppVersion', 'message' => 'The AppId and AppVersion are missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingParameter.RegionId', 'message' => 'The RegionId is missing.', 'http_code' => 400, 'description' => ''], + ['code' => 'nvalidStrategyConfig.NotFound', 'message' => 'The policy configuration is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'OperationDenied.NoStock', 'message' => 'The operation is denied, because the instance stock is unavailable.', 'http_code' => 400, 'description' => ''], + ['code' => 'OtaTask.Canceled', 'message' => 'The task has been cancelled.', 'http_code' => 400, 'description' => ''], + ['code' => 'OtaTask.NotFound', 'message' => 'The ota task is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'OtaTask.Running', 'message' => 'The task is running and cannot be sumitted.', 'http_code' => 400, 'description' => ''], + ['code' => 'OtaTaskNotifyRegion.Error', 'message' => 'The unit manager failed to receive the OTA upgrade job.', 'http_code' => 400, 'description' => ''], + ['code' => 'ParentImage.NotExist', 'message' => 'The parent image does not exist.', 'http_code' => 400, 'description' => 'The parent image does not exist.'], + ['code' => 'ParentImageRegionDistribute.NotExist', 'message' => 'The target distribution region of the parent image does not exist.', 'http_code' => 400, 'description' => 'The target distribution region of the parent image does not exist.'], + ['code' => 'ProductTypeInvalid', 'message' => 'The ProductType is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'ProductTypeNotMatch', 'message' => 'The productType and image do not match.', 'http_code' => 400, 'description' => 'The productType and image do not match.'], + ['code' => 'QueryTemplate.Failed', 'message' => 'Query template failed.', 'http_code' => 400, 'description' => 'Failed to query the template.'], + ['code' => 'RegionUnBind.Fail', 'message' => 'Failed to unbind.', 'http_code' => 400, 'description' => ''], + ['code' => 'ServiceUnavailable', 'message' => 'Service unavailable. Please try again later.', 'http_code' => 500, 'description' => 'Service unavailable. Please try again later.'], + ['code' => 'StockError.InvalidResourceRequest', 'message' => 'Your request cannot be processed currently due to an error. Please try again later.', 'http_code' => 500, 'description' => 'The inventory check failed and the system is temporarily unable to process your request. Please try again later.'], + ['code' => 'StockError.NoStock', 'message' => 'The selected specification is out of stock. Please try again later or select other specifications.', 'http_code' => 400, 'description' => 'The selected specification is out of stock. Please try again later or select other specifications.'], + ['code' => 'StorageLock.Exist', 'message' => 'The storage lock exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'StorageLock.NotFound', 'message' => 'The storage lock is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'StorageLockProperties.NotMatch', 'message' => 'The storage lock properties do not match.', 'http_code' => 400, 'description' => ''], + ['code' => 'StorageLockUnitResponse.Empty', 'message' => 'The storage lock unit is found empty.', 'http_code' => 400, 'description' => ''], + ['code' => 'StorageLockUnlockLevel.Error', 'message' => 'An unlock level error occurred while unlocking the storage lock.', 'http_code' => 400, 'description' => ''], + ['code' => 'Task.ResourceReleased', 'message' => 'Cannot retry because task resource is released.', 'http_code' => 400, 'description' => 'Cannot retry because the resource for builder task is released.'], + ['code' => 'TaskType.Invalid', 'message' => 'Invalid task type.', 'http_code' => 400, 'description' => 'Invalid task type.'], + ['code' => 'TryBind.AppRegionBindLockFailed', 'message' => 'Failed to lock the app and region bind.', 'http_code' => 400, 'description' => ''], + ['code' => 'TryBind.NoBindContext', 'message' => 'Failed to bind, because there is no bind context.', 'http_code' => 400, 'description' => ''], + ['code' => 'TryBind.NoCandidateAppInstanceGroup', 'message' => 'Failed to bind, because there is no candidate app instance group.', 'http_code' => 400, 'description' => ''], + ['code' => 'TryBind.NoSupportedApp', 'message' => 'Failed to bind, because there is no supported app for this file extension.', 'http_code' => 400, 'description' => ''], + ['code' => 'TryRegionBind.BindExistingAppInstanceFail', 'message' => 'Failed to bind existing app instance.', 'http_code' => 400, 'description' => ''], + ['code' => 'TryRegionBind.NoCandidateAppInstance', 'message' => 'Failed to bind, because there is no candidate app instance.', 'http_code' => 400, 'description' => ''], + ['code' => 'TryRegionBind.NoIdleAppInstance', 'message' => 'Failed to bind, because there is no idle app instance.', 'http_code' => 400, 'description' => ''], + ['code' => 'TryRegionBind.TicketIsNull', 'message' => 'Failed to bind, because a null ticket is returned.', 'http_code' => 400, 'description' => ''], + ['code' => 'UpdateImage.Failed', 'message' => 'Failed to update the image.', 'http_code' => 400, 'description' => ''], + ['code' => 'UpdateRegion.NotSupport', 'message' => 'The distributed regions of vhd or container images cannot be modified.', 'http_code' => 400, 'description' => 'The distributed regions of vhd or container images cannot be modified.'], + ['code' => 'UserIdentifier.NotFound', 'message' => 'This username does not exist. Please check if it is correct.', 'http_code' => 400, 'description' => ''], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConnectionTicket'], ], ], + 'ram' => [ + 'productCode' => 'AppStreaming', + 'productName' => 'App Streaming', + 'ramCodes' => ['appstreaming', 'ecd'], + 'ramLevel' => 'SERVICE', + 'ramConditions' => [], + 'ramActions' => [], + 'resourceTypes' => [], + ], ]; |