diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/cgcs/2021-11-11 | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/cgcs/2021-11-11')
| -rw-r--r-- | data/en_us/cgcs/2021-11-11/api-docs.php | 6554 |
1 files changed, 3384 insertions, 3170 deletions
diff --git a/data/en_us/cgcs/2021-11-11/api-docs.php b/data/en_us/cgcs/2021-11-11/api-docs.php index 89f0681..29b9ac5 100644 --- a/data/en_us/cgcs/2021-11-11/api-docs.php +++ b/data/en_us/cgcs/2021-11-11/api-docs.php @@ -1,98 +1,51 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'CGCS', - 'version' => '2021-11-11', - ], + 'info' => ['style' => 'RPC', 'product' => 'CGCS', 'version' => '2021-11-11'], 'directories' => [ [ - 'id' => 188216, - 'title' => null, + 'children' => ['ReserveInstances', 'ReleaseInstances', 'DescribeInstanceStatsInfo'], 'type' => 'directory', - 'children' => [ - 'ReserveInstances', - 'ReleaseInstances', - 'ListInstances', - 'DescribeInstanceStatsInfo', - ], + 'title' => 'Instance management', ], [ - 'id' => 168896, - 'title' => null, + 'children' => ['ListApp', 'GetApp', 'DeleteApp'], 'type' => 'directory', - 'children' => [ - 'CreateApp', - 'ModifyApp', - 'ListApp', - 'GetApp', - 'DeleteApp', - ], + 'title' => 'Application management', ], [ - 'id' => 168902, - 'title' => null, + 'children' => ['ModifyAppVersion', 'ListAppVersion', 'GetAppVersion'], 'type' => 'directory', - 'children' => [ - 'CreateAppVersion', - 'ModifyAppVersion', - 'ListAppVersion', - 'GetAppVersion', - 'DeleteAppVersion', - ], + 'title' => 'Version management', ], [ - 'id' => 168908, - 'title' => null, + 'children' => ['CreateAdaptation', 'GetAdaptation'], 'type' => 'directory', - 'children' => [ - 'CreateAdaptation', - 'GetAdaptation', - ], + 'title' => 'Adaptation management', ], [ - 'id' => 169658, - 'title' => null, + 'children' => ['CancelReserveTask', 'GetReserveTaskDetail', 'ReleaseCapacity', 'ReleaseCapacityByBatch', 'GetCapacity'], 'type' => 'directory', - 'children' => [ - 'CreateCapacityReservation', - 'CancelReserveTask', - 'GetReserveTaskDetail', - 'ReleaseCapacity', - 'ReleaseCapacityByBatch', - 'GetCapacity', - ], + 'title' => 'Container reservation management', ], [ - 'id' => 168895, - 'title' => null, + 'children' => ['CreateAppSession', 'StopAppSession', 'GetAppSession', 'ListAppSessions', 'CreateAppSessionSync', 'CreateAppSessionBatchSync', 'StopAppSessionBatch', 'GetAppCcu', 'BatchCheckSession'], + 'type' => 'directory', + 'title' => 'Session management', + ], + [ + 'children' => ['CreateApp', 'CreateAppVersion', 'CreateCapacityReservation', 'DeleteAppVersion', 'ListInstances', 'ModifyApp'], + 'title' => 'Others', 'type' => 'directory', - 'children' => [ - 'CreateAppSession', - 'StopAppSession', - 'GetAppSession', - 'ListAppSessions', - 'CreateAppSessionSync', - 'CreateAppSessionBatchSync', - 'StopAppSessionBatch', - 'GetAppCcu', - 'BatchCheckSession', - ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'ReserveInstances' => [ - 'summary' => '预定GCS实例', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'BatchCheckSession' => [ + 'summary' => 'This API is used to check suspected abnormal sessions. ', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -100,985 +53,1411 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'none', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', + 'name' => 'Records', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Records of suspected abnormal sessions. '."\n" + .'> A maximum of 50 records are allowed. ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Abnormality type. '."\n" + ."\n" + .'Valid values: '."\n" + ."\n" + .'- L1: critical '."\n" + ."\n" + .'- L2: medium '."\n" + ."\n" + .'- L3: general ', + 'type' => 'string', + 'required' => true, + 'example' => 'L1', + 'enum' => ['L1', 'L2', 'L3'], + 'title' => '', + ], + 'CustomSessionId' => ['description' => 'Custom session ID. ', 'type' => 'string', 'required' => false, 'example' => '100XXXX', 'title' => ''], + 'PlatformSessionId' => ['description' => 'Platform session ID. ', 'type' => 'string', 'required' => false, 'example' => '1ADE0XXXX', 'title' => ''], + 'ReferenceInfo' => ['description' => 'Reference information for evaluating suspected abnormalities. '."\n" + .'> Used only for record keeping and subsequent troubleshooting and analysis. ', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '5469588382860444937003', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'InstanceType', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'gcs.r1c1m1.1xlarge', + 'description' => 'Response parameters. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'."\n"], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\\\n\\"\\n}","type":"json"}]', + 'title' => 'Batch check suspected abnormal sessions ', + 'description' => 'You can submit suspected abnormal sessions and reference data for abnormality evaluation to the platform. The platform asynchronously checks the related resources. '."\n" + ."\n" + .'When an abnormal resource is detected, the platform smoothly replaces the resource without affecting existing sessions. '."\n" + ."\n" + .'The replacement result will not be notified separately. ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchCheckSession'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'cgcs:BatchCheckSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CancelReserveTask' => [ + 'summary' => 'Cancel the specified container reservation job.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DistrictId', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'autoTest' => false], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the container reservation job.', 'type' => 'string', 'required' => true, 'example' => 'b354****'], + ], + [ + 'name' => 'ClientToken', 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'A custom token used to ensure request idempotence. '."\n" + .'> It must consist of ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '2YEF0****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'huanan' => 'huanan', - 'huabei' => 'huabei', - 'xinan' => 'xinan', - 'huazhong' => 'huazhong', - 'huadong' => 'huadong', + 'title' => 'PopHttpResult<>', + 'description' => 'Response parameters.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The ID of the container reservation job.', 'type' => 'string', 'example' => 'b354****', 'title' => ''], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"b354****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + 'title' => 'Cancel Container Reservation Job', + 'changeSet' => [ + ['createdAt' => '2022-12-05T07:51:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-19T07:28:22.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cgcs:CancelReserveTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'huadong', ], ], + ], + ], + 'CreateAdaptation' => [ + 'summary' => 'Create an adaptation request for an application version.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Amount', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'autoTest' => false], + 'parameters' => [ + [ + 'name' => 'AppVersionId', 'in' => 'formData', + 'schema' => ['description' => 'Application Version ID.', 'type' => 'string', 'required' => true, 'example' => '1432****', 'title' => ''], + ], + [ + 'name' => 'AdaptTarget', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', + 'description' => 'Adaptation target information.', + 'type' => 'object', + 'properties' => [ + 'StartProgram' => ['description' => 'Start program.'."\n" + ."\n" + .'Supports Unicode characters, with a maximum of 512 characters.'."\n" + ."\n" + .'> This parameter is required when `AppType` is `end_game`, `hand_game`, or `render_app`.', 'type' => 'string', 'required' => false, 'example' => '/example/example.exe', 'title' => ''], + 'Resolution' => ['description' => 'Resolution. Valid values:'."\n" + ."\n" + .'- 720p'."\n" + .'- 1080p'."\n" + .'- 4k'."\n" + ."\n" + .'> This parameter is required when `AppType` is `end_game` or `hand_game`.', 'type' => 'string', 'required' => false, 'example' => '1080p', 'title' => ''], + 'FrameRate' => ['description' => 'Frame rate. Valid values:'."\n" + ."\n" + .'- 30'."\n" + .'- 60'."\n" + ."\n" + .'Unit: Fps.'."\n" + ."\n" + .'> This parameter is required when `AppType` is `end_game` or `hand_game`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + 'BitRate' => ['description' => 'Bitrate.'."\n" + ."\n" + .'Valid range: 1 to 30.'."\n" + ."\n" + .'Unit: Mbps.'."\n" + ."\n" + .'> This parameter is required when `AppType` is `end_game` or `hand_game`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'AdaptIdDataFlatPopResult', + 'description' => 'Return parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], - 'InstanceIds' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gcs-bmt0kbn7e013aedg9', - ], - ], + 'AdaptApplyId' => ['description' => 'Application adaptation request ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '5435****', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidArgs', - 'errorMessage' => 'Invalid Args.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'failed to get project info.', - ], - [ - 'errorCode' => 'NotFoundProject', - 'errorMessage' => 'project not exist.', - ], - [ - 'errorCode' => 'UnsupportedDistrict', - 'errorMessage' => 'not found any region for district.', - ], - [ - 'errorCode' => 'NotFoundImage', - 'errorMessage' => 'not found tenant image.', - ], - [ - 'errorCode' => 'VmStockNotEnough', - 'errorMessage' => 'no stock.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AdaptApplyId\\": 0,\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + 'title' => 'Create Adaptation Request', + 'changeSet' => [ + ['createdAt' => '2022-06-30T12:58:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-23T08:43:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cgcs:CreateAdaptation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"InstanceIds\\": [\\n \\"gcs-bmt0kbn7e013aedg9\\"\\n ]\\n}","type":"json"}]', ], - 'ReleaseInstances' => [ - 'summary' => '退订GCS实例', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateApp' => [ + 'summary' => 'Create a new application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'create', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4820372607851300489003', - ], + 'schema' => ['description' => 'Application name.'."\n" + ."\n" + .'Unicode characters are supported, with a maximum of 64 characters.', 'type' => 'string', 'required' => true, 'example' => 'example', 'title' => ''], ], [ - 'name' => 'InstanceType', + 'name' => 'AppType', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'gcs.r1c1m1.1xlarge', - ], + 'schema' => ['description' => 'Application type. Valid values:'."\n" + ."\n" + .'- end_game: PC game (client-side game).'."\n" + .'- ai_app: Artificial intelligence application.'."\n" + .'- render_app: Rendering application.'."\n" + .'- compute: Scientific rendering application.', 'type' => 'string', 'required' => true, 'example' => 'end_game', 'title' => ''], ], [ - 'name' => 'DistrictId', + 'name' => 'StreamingAppId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'huanan' => 'huanan', - 'huabei' => 'huabei', - 'xinan' => 'xinan', - 'huazhong' => 'huazhong', - 'huadong' => 'huadong', - ], - 'example' => 'huadong', - ], + 'schema' => ['description' => 'Graphic Computing Service streaming service instance ID.', 'type' => 'string', 'required' => false, 'example' => '47d0bd4d-8815-48a2-b783-6cbba89d****', 'title' => ''], ], [ - 'name' => 'Amount', + 'name' => 'StreamingSolution', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'Streaming solution. Valid values:'."\n" + ."\n" + .'- video-cloud-streaming: Use the Graphic Computing Service streaming service.'."\n" + ."\n" + .'- self-have-streaming: Use your own streaming solution.', 'type' => 'string', 'required' => false, 'example' => 'self-have-streaming', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'AppIdDataFlatPopResult', + 'description' => 'AppIdDataFlatPopResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], - 'InstanceIds' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gcs-bmt0kbn7e013aedg9', - ], - ], + 'AppId' => ['description' => 'Application ID.', 'type' => 'string', 'example' => '4384****', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidArgs', - 'errorMessage' => 'Invalid Args.', - ], - [ - 'errorCode' => 'UnsupportedInstanceType', - 'errorMessage' => 'unsupported instance type.', - ], - [ - 'errorCode' => 'InstanceAmountNotMatch', - 'errorMessage' => 'release instance amount exceed tenant instance total count.', - ], - [ - 'errorCode' => 'TooFrequent', - 'errorMessage' => 'release instance too frequent.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppId\\": \\"4384****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + 'title' => 'Create Application', + 'changeSet' => [ + ['createdAt' => '2022-12-22T12:17:30.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-30T12:58:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-23T08:43:32.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cgcs:CreateApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"InstanceIds\\": [\\n \\"gcs-bmt0kbn7e013aedg9\\"\\n ]\\n}","type":"json"}]', ], - 'ListInstances' => [ - 'summary' => '查询GCS实例列表', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateAppSession' => [ + 'summary' => 'Create an application session and start an application process, then return the session information.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'create', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '4820372607851300489003', - ], + 'schema' => ['title' => '', 'description' => 'Application ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '13027XXXX'], ], [ - 'name' => 'InstanceType', + 'name' => 'AppVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gcs.r1c1m1.1xlarge', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'Application Version ID.'."\n" + ."\n" + .'> If you do not specify an active version, the default application uses the latest version.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '35067XXXX'], ], [ - 'name' => 'DistrictId', + 'name' => 'CustomUserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'huadong', - ], + 'schema' => ['title' => '', 'description' => 'Custom User ID, with a maximum length of 64 characters. '."\n" + ."\n" + .'Used by your business to perform operations based on the user dimension. '."\n" + ."\n" + .'> This parameter is Required when the application Type is `end_game` or `hand_game`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2YEF0XXXX', 'maxLength' => 64], ], [ - 'name' => 'InstanceId', + 'name' => 'CustomSessionId', 'in' => 'query', - 'allowEmptyValue' => false, - 'style' => 'repeatList', + 'schema' => ['title' => '', 'description' => 'Custom session ID used to ensure idempotence of requests. '."\n" + ."\n" + .'Generate a unique value from your client to guarantee uniqueness across different requests. '."\n" + ."\n" + .'> ASCII characters are supported, and the length must not exceed 64 characters.', 'type' => 'string', 'required' => true, 'example' => '1ADE0XXXX', 'maxLength' => 64], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Client IP address of the business, such as the player\'s IP address in a cloud gaming scenario.', 'type' => 'string', 'required' => false, 'example' => '192.168.XXX.XXX'], + ], + [ + 'name' => 'StartParameters', + 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Start parameters.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => 'key', 'description' => 'Currently supported enumeration values include:'."\n" + .'- startArgument: Application start parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'startArgument'], + 'Value' => ['description' => 'The value corresponding to the key.', 'type' => 'string', 'required' => false, 'example' => 'exampleValue', 'title' => ''], + ], 'required' => false, - 'example' => 'gcs-bmt0kbn7e013aedg9', + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 100, + 'example' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'SystemInfo', 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'System information, such as client device model.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Custom key values are supported. The following reserved words are defined by convention: '."\n" + .'- utdid: represents the Device ID, which helps the platform analyze features of unusual traffic and locate issues.', 'type' => 'string', 'required' => false, 'example' => 'utdid', 'title' => ''], + 'Value' => ['description' => 'The value corresponding to the key.', 'type' => 'string', 'required' => false, 'example' => 'OE0usD+APXXXX', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'BEXZPF01W23U46598WVf', + 'example' => '', ], ], [ - 'name' => 'MaxResults', + 'name' => 'Timeout', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'Timeout for on-demand resource provisioning in pay-as-you-go mode. '."\n" + .'Value range: [900, 43200] seconds. Default value: 1800.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1800', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'EnablePostpaid', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'CREATING', - 'enum' => [ - 'CREATING', - 'RUNNING', - 'OPERATING', - 'DELETING', - 'MIGRATING', - ], - ], + 'schema' => ['description' => 'Specifies whether to provision resources on demand when creating a session in pay-as-you-go mode. Valid values: '."\n" + .'- true: Yes '."\n" + .'- false: No (default)', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => '项目ID。如果已将应用关联到项目，创建会话时需填写正确的项目ID。', 'type' => 'string', 'required' => false, 'example' => 'd9a8****', 'title' => ''], + ], + [ + 'name' => 'AdapterFileId', + 'in' => 'query', + 'schema' => ['description' => '适配文件ID。此功能灰度开放，如未约定使用请勿传入。', 'type' => 'string', 'required' => false, 'example' => '501716211209548966XXXX', 'title' => ''], + ], + [ + 'name' => 'DistrictId', + 'in' => 'query', + 'schema' => ['description' => 'Area ID. Valid values: '."\n" + ."\n" + .'- huadong '."\n" + ."\n" + .'- xinan '."\n" + ."\n" + .'- huanan '."\n" + ."\n" + .'- huabei '."\n" + ."\n" + .'- huazhong '."\n" + ."\n", 'type' => 'string', 'required' => false, 'example' => 'huadong', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], - 'Instances' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gcs-bmt0kbn7e013aedg9', - ], - 'InstanceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gcs.r1c1m1.1xlarge', - ], - 'DistrictId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'huadong', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4820372607851300489003', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CREATING', - ], - 'CreationTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-12-13T11:12:11Z', - ], - ], - ], - ], - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEXZPF01W23U46598WVf', - ], - 'MaxResults' => [ - 'description' => '', - 'type' => 'string', - 'example' => '50', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'], + 'CustomSessionId' => ['title' => '', 'description' => 'Custom session ID.', 'type' => 'string', 'example' => '1ADE0XXXX'], + 'PlatformSessionId' => ['title' => '', 'description' => 'Platform session ID.', 'type' => 'string', 'example' => '100XXXX'], + 'AppId' => ['title' => '', 'description' => 'Application ID.', 'type' => 'string', 'example' => '13027XXXX'], + 'AppVersion' => ['title' => '', 'description' => 'Application Version ID.', 'type' => 'string', 'example' => '35067XXXX'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidNextToken', - 'errorMessage' => 'invalid nextToken.', - ], - [ - 'errorCode' => 'InvalidArgs', - 'errorMessage' => 'invalid status.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"CustomSessionId\\": \\"1ADE0XXXX\\",\\n \\"PlatformSessionId\\": \\"100XXXX\\",\\n \\"AppId\\": \\"13027XXXX\\",\\n \\"AppVersion\\": \\"35067XXXX\\"\\n}","type":"json"}]', + 'title' => 'Create Application Session', + 'description' => '- After a session is created successfully, the event type is `APP_START`. The result of application startup is notified through the following message. '."\n" + .'><notice>Applies only to API integration mode and not to H5 SDK integration mode.></notice>'."\n" + ."\n" + .'|Name | Type | Required |Description|'."\n" + .'| ------ | ------ | ------ |------ |'."\n" + .'| success | Boolean | Yes |Indicates whether the startup succeeded.<br> Valid values:<br>true: Startup succeeded.<br>false: Startup failed.|'."\n" + .'|eventType|String|Yes|Event type.|'."\n" + .'|customSessionId|String|Yes|Custom session ID.|'."\n" + .'|platformSessionId|String|Yes|Platform session ID.|'."\n" + .'|customTaskId|String|No|Custom task ID.|'."\n" + .'|platformTaskId|String|No|Platform task ID.|'."\n" + .'|eventDetail|Object[EventDetail]|Yes|Event details.|'."\n" + .'|errorMessage|Object[EventDetail]|No|Error Details.<br>This parameter is returned when startup fails.|'."\n" + .'|tags|Map<String,String>|No|Session labels.|'."\n" + ."\n" + .'The EventDetail data structure is as follows. '."\n" + .'|Name|Type|Required|Description| '."\n" + .'| ------ | ------ | ------ |------ |'."\n" + .'|appId|String|Yes|Application ID.|'."\n" + .'|appVersion|String|Yes|Application Version ID.|'."\n" + .'|appBizConfig|String|No|Custom business configuration data used during platform adaptation.|'."\n" + .'|streamingToken|String|No|Streaming authentication information. This field is included only when a streaming service exists.|'."\n" + .'|endpoint|Object[Endpoint]|No|Event details.<br>This parameter is returned when startup succeeds.|'."\n" + ."\n" + .'The Endpoint data structure is as follows. '."\n" + .'|Name|Type|Required|Description|'."\n" + .'|-------|-------|-------|-------|'."\n" + .'|name|String|Yes|Name.|'."\n" + .'|type|String|Yes|Type.|'."\n" + .'|accessHost|String|Yes|Endpoint IP address.|'."\n" + .'|accessPort|String|Yes|Endpoint port.|'."\n" + .'|isp|String|Yes|Carrier identity.<br>Valid values:<br>MOBILE: China Mobile.<br>UNICOM: China Unicom.<br>TELECOM: China Telecom.<br>BGP: Border Gateway Protocol (BGP).|'."\n" + .'|districtId|String|Yes|Area ID.|'."\n" + .'|regionId|String|Yes|Region ID.|'."\n" + ."\n" + .'The ErrorMessage data structure is as follows. '."\n" + .'|Name|Type|Required|Description|'."\n" + .'|------|------|------|------|'."\n" + .'|code|String|Yes|Error code.|'."\n" + .'|msg|String|Yes|Error Details.|'."\n" + ."\n" + .'- For services involving streaming, after a session is created successfully, the event type is `APP_STREAMING_INIT`. Streaming initialization information is notified through the following message. '."\n" + .'><notice>Applies only to API integration mode and not to H5 SDK integration mode.></notice>'."\n" + ."\n" + .'| Name | Type | Required |Description|'."\n" + .'| ------ | ------ | ------ |------ |'."\n" + .'| success | Boolean | Yes |Indicates whether streaming initialization succeeded.<br> Valid values:<br>true: Initialization succeeded.<br>false: Initialization failed.|'."\n" + .'|eventType|String|Yes|Event type.|'."\n" + .'|customSessionId|String|Yes|Custom session ID.|'."\n" + .'|platformSessionId|String|Yes|Platform session ID.|'."\n" + .'|customTaskId|String|No|Custom task ID.|'."\n" + .'|platformTaskId|String|No|Platform task ID.|'."\n" + .'|eventDetail|Object[EventDetail]|Yes|Event details.|'."\n" + ."\n" + .'The EventDetail data structure is as follows. '."\n" + .'|Name|Type|Required|Description|'."\n" + .'| ------ | ------ | ------ |------ |'."\n" + .'|appId|String|Yes|Application ID.|'."\n" + .'|appVersion|String|Yes|Application Version ID.|'."\n" + .'|appBizConfig|String|No|Custom business configuration data used during platform adaptation.|'."\n" + .'|streamingToken|String|No|Streaming authentication information. This field is included only when a streaming service exists.|'."\n" + .'|eventDetail|Object[EventDetail]|No|Event details.<br>This parameter is returned when session startup succeeds.|'."\n" + .'|errorMessage|Object|No|Error Details.<br>This parameter is returned when session startup fails.|'."\n" + ."\n" + .'The Endpoint data structure is as follows. '."\n" + .'|Name|Type|Required|Description|'."\n" + .'|-------|-------|-------|-------|'."\n" + .'|name|String|Yes|Name.|'."\n" + .'|type|String|Yes|Type.|'."\n" + .'|accessHost|String|Yes|Endpoint IP address.|'."\n" + .'|accessPort|String|Yes|Endpoint port.|'."\n" + .'|isp|String|Yes|<br>Carrier identity.<br>Valid values:<br>MOBILE: China Mobile.<br>UNICOM: China Unicom.<br>TELECOM: China Telecom.<br>BGP: Border Gateway Protocol (BGP).|'."\n" + .'|districtId|String|Yes|Area ID.|'."\n" + .'|regionId|String|Yes|Region ID.|'."\n" + ."\n" + .'The ErrorMessage data structure is as follows. '."\n" + .'|Name|Type|Required|Description|'."\n" + .'|------|------|------|------|'."\n" + .'|code|String|Yes|Error code.|'."\n" + .'|msg|String|Yes|Error Details.|', + 'changeSet' => [ + ['createdAt' => '2024-05-20T07:11:03.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-12T14:13:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-03T09:19:30.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2022-03-03T09:19:30.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-03T09:19:30.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppSession'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cgcs:CreateAppSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"gcs-bmt0kbn7e013aedg9\\",\\n \\"InstanceType\\": \\"gcs.r1c1m1.1xlarge\\",\\n \\"DistrictId\\": \\"huadong\\",\\n \\"ProjectId\\": \\"4820372607851300489003\\",\\n \\"Status\\": \\"CREATING\\",\\n \\"CreationTime\\": \\"2023-12-13T11:12:11Z\\"\\n }\\n ],\\n \\"NextToken\\": \\"BEXZPF01W23U46598WVf\\",\\n \\"MaxResults\\": \\"50\\"\\n}","type":"json"}]', ], - 'DescribeInstanceStatsInfo' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateAppSessionBatchSync' => [ + 'summary' => 'You can batch create application sessions. The platform allocates resources and starts multiple processes sequentially.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'create', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'ProjectIds', + 'name' => 'BatchId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '6733705348307226241003', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'Custom batch operation ID. It must be unique. '."\n" + .'> Supports ASCII characters and must not exceed 64 characters.'."\n" + ."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6d4d****', 'maxLength' => 64, 'minLength' => 1, 'title' => ''], ], [ - 'name' => 'InstanceTypes', + 'name' => 'AppInfos', 'in' => 'query', - 'style' => 'repeatList', + 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Application start information.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'CustomerSessionId' => ['description' => 'Custom session ID.'."\n" + .'> Supports ASCII characters and must not exceed 64 characters.'."\n" + ."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1ADE0****', 'maxLength' => 64, 'minLength' => 1, 'title' => ''], + 'CustomUserId' => ['description' => 'Custom User ID. Used for reading from and saving to archives. The maximum length is 64 characters.'."\n" + .'> This parameter is Required when the application Type is `end_game` or `hand_game`.'."\n", 'type' => 'string', 'required' => false, 'example' => '2YEF0****', 'title' => ''], + 'AppId' => ['description' => 'Application ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '13027****', 'maxLength' => 64, 'minLength' => 1, 'title' => ''], + 'AppVersion' => ['description' => 'Application version ID.', 'type' => 'string', 'required' => false, 'example' => '35067****', 'title' => ''], + 'ClientIp' => ['description' => 'Client IP address of the business.', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', 'title' => ''], + 'SystemInfo' => [ + 'description' => 'System info.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Custom keys are currently supported. The value "utdid" represents the Device ID, which helps the platform analyze features of unusual traffic and locate issues.', 'type' => 'string', 'required' => false, 'example' => 'utdid', 'title' => ''], + 'Value' => ['description' => 'The value corresponding to the key.', 'type' => 'string', 'required' => false, 'example' => 'OE0usD+AP****', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'StartParameters' => [ + 'description' => 'General parameters and business-specific parameters.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Currently supported enumeration values. The value "startArgument" indicates an application start parameter.', 'type' => 'string', 'required' => false, 'example' => 'startArgument', 'title' => ''], + 'Value' => ['description' => 'The value corresponding to the key.', 'type' => 'string', 'required' => false, 'example' => 'exampleValue', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Tags' => [ + 'description' => 'Custom tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Tag key. Maximum length is 64 characters.', 'type' => 'string', 'required' => false, 'example' => 'exampleTag', 'title' => ''], + 'Value' => ['description' => 'Value corresponding to the key.', 'type' => 'string', 'required' => false, 'example' => 'exampleValue', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ProjectId' => ['description' => 'Project ID.', 'type' => 'string', 'required' => false, 'example' => 'd9a8****', 'title' => ''], + 'DistrictId' => ['description' => 'Area ID. Valid values:'."\n" + ."\n" + .'- huadong'."\n" + ."\n" + .'- xinan'."\n" + ."\n" + .'- huanan'."\n" + ."\n" + .'- huabei'."\n" + ."\n" + .'- huazhong', 'type' => 'string', 'required' => false, 'example' => 'huadong', 'title' => ''], + 'MatchRules' => [ + 'description' => 'Rule information for resource matching. Multiple rules are supported; the more rules specified, the longer the Duration required to find a suitable resource.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'Rule type. Valid values:'."\n" + .'- in: Resources that have the specified key and value are hit.'."\n" + .'- notIn: Resources that do not have the specified key and value are hit.', 'type' => 'string', 'required' => false, 'example' => 'in', 'title' => ''], + 'Key' => ['description' => 'Tag name provided by the resource. Valid values:'."\n" + .'- component: widget version; when a widget version is specified, sessions are started only with resources that have the specified widget version.', 'type' => 'string', 'required' => false, 'example' => 'component', 'title' => ''], + 'Values' => [ + 'description' => 'Tag values to match.', + 'type' => 'array', + 'items' => ['description' => 'Convention-based tag values.', 'type' => 'string', 'required' => false, 'example' => 'exampleTag', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'AdapterFileId' => ['description' => 'Adapter file ID. This feature is released in grayscale. Do not pass this parameter unless agreed upon.', 'type' => 'string', 'required' => false, 'example' => '501716211209548966XXXX', 'title' => ''], + ], 'required' => false, - 'example' => 'gcs.r1c1m1.1xlarge', - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'DistrictIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'huabei', + 'title' => '', + 'example' => '', ], - 'required' => false, - 'maxItems' => 100, + 'required' => true, + 'docRequired' => true, + 'maxItems' => 50, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Response<DescribeInstanceStatsInfoPopResponse>', - 'description' => 'Schema of Response', + 'title' => 'Schema of Response', + 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'title' => '释放的 instanceIds', - 'description' => '', + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'], + 'BatchId' => ['title' => '', 'description' => 'Batch operation ID.', 'type' => 'string', 'example' => '6d4d****'], + 'ResultList' => [ + 'description' => 'Result list.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '项目id', - 'description' => '', - 'type' => 'string', - 'example' => '6733705348307226241003', - ], - 'DistrictId' => [ - 'title' => '大区 id', - 'description' => '', - 'type' => 'string', - 'example' => 'huabei', - ], - 'InstanceType' => [ - 'title' => '实例类型', - 'description' => '', - 'type' => 'string', - 'example' => 'gcs.r1c1m1.1xlarge'."\n", - ], - 'TotalCount' => [ - 'title' => '总实例数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'RunningInstanceCount' => [ - 'title' => '运行中实例数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'OperatingInstanceCount' => [ - 'title' => '运维中实例数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ReservingInstanceCount' => [ - 'title' => '预定中实例数，创建中', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ReleasingInstanceCount' => [ - 'title' => '释放中实例数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'CustomSessionId' => ['title' => '', 'description' => 'Custom session ID.', 'type' => 'string', 'example' => '1ADE0****'], + 'PlatformSessionId' => ['title' => '', 'description' => 'Platform session ID.', 'type' => 'string', 'example' => '100****'], + 'AppId' => ['title' => '', 'description' => 'Application ID.', 'type' => 'string', 'example' => '13027****'], + 'AppVersion' => ['title' => '', 'description' => 'Application version ID.', 'type' => 'string', 'example' => '35067****'], + 'BizInfo' => [ + 'description' => 'Business information.', + 'type' => 'object', + 'properties' => [ + 'Biz' => ['description' => 'Business result information.', 'type' => 'object', 'example' => 'authToken', 'title' => ''], + 'Endpoints' => [ + 'description' => 'Endpoint information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'Endpoint Name.', 'type' => 'string', 'example' => 'exampleName', 'title' => ''], + 'AccessHost' => ['description' => 'Endpoint IP address.', 'type' => 'string', 'example' => '127.0.X.X', 'title' => ''], + 'AccessPort' => ['description' => 'Endpoint port.', 'type' => 'string', 'example' => '8080', 'title' => ''], + 'Type' => ['description' => 'Endpoint type. Valid value: Native.', 'type' => 'string', 'example' => 'Native', 'title' => ''], + 'DistrictId' => ['description' => 'Area ID. Valid values:'."\n" + ."\n" + .'- huadong'."\n" + ."\n" + .'- xinan'."\n" + ."\n" + .'- huanan'."\n" + ."\n" + .'- huabei'."\n" + ."\n" + .'- huazhong', 'type' => 'string', 'example' => 'huadong', 'title' => ''], + 'Isp' => ['description' => 'Carrier. Valid values:'."\n" + ."\n" + .'- MOBILE: China Mobile.'."\n" + ."\n" + .'- UNICOM: China Unicom.'."\n" + ."\n" + .'- TELECOM: China Telecom.'."\n" + ."\n" + .'- BGP: Border Gateway Protocol (BGP) multi-line network.', 'type' => 'string', 'example' => 'bgp', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'title' => 'pop的requestId', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0977', + 'FailedList' => [ + 'description' => 'List of failures.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CustomSessionId' => ['description' => 'Custom session ID.', 'type' => 'string', 'example' => '1ADE0****', 'title' => ''], + 'AppId' => ['description' => 'Application ID.', 'type' => 'string', 'example' => '100****', 'title' => ''], + 'FailedInfo' => [ + 'description' => 'Failure information.', + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => ['description' => 'Error code.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorCode' => ['description' => 'Error description.', 'type' => 'string', 'example' => 'App type not support.', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"ProjectId\\": \\"6733705348307226241003\\",\\n \\"DistrictId\\": \\"huabei\\",\\n \\"InstanceType\\": \\"gcs.r1c1m1.1xlarge\\\\n\\",\\n \\"TotalCount\\": 4,\\n \\"RunningInstanceCount\\": 1,\\n \\"OperatingInstanceCount\\": 1,\\n \\"ReservingInstanceCount\\": 1,\\n \\"ReleasingInstanceCount\\": 1\\n }\\n ],\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0977\\"\\n}","type":"json"}]', - ], - 'CreateApp' => [ - 'summary' => '应用创建服务', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"BatchId\\": \\"6d4d****\\",\\n \\"ResultList\\": [\\n {\\n \\"CustomSessionId\\": \\"1ADE0****\\",\\n \\"PlatformSessionId\\": \\"100****\\",\\n \\"AppId\\": \\"13027****\\",\\n \\"AppVersion\\": \\"35067****\\",\\n \\"BizInfo\\": {\\n \\"Biz\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Endpoints\\": [\\n {\\n \\"Name\\": \\"exampleName\\",\\n \\"AccessHost\\": \\"127.0.X.X\\",\\n \\"AccessPort\\": \\"8080\\",\\n \\"Type\\": \\"Native\\",\\n \\"DistrictId\\": \\"huadong\\",\\n \\"Isp\\": \\"bgp\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"FailedList\\": [\\n {\\n \\"CustomSessionId\\": \\"1ADE0****\\",\\n \\"AppId\\": \\"100****\\",\\n \\"FailedInfo\\": {\\n \\"ErrorMessage\\": \\"400\\",\\n \\"ErrorCode\\": \\"App type not support.\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Batch Synchronization for Application Session Creation', + 'description' => 'Timeliness varies depending on the number of sessions created in a batch. You can create up to 20 sessions in a single batch.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppSessionBatchSync'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cgcs:CreateAppSessionBatchSync', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateAppSessionSync' => [ + 'summary' => 'After you create an application session and start the application process, the session information is returned through a message.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'create', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'AppName', - 'in' => 'formData', + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Application ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '13027****'], + ], + [ + 'name' => 'AppVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'Application Version ID. ', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '35067****'], + ], + [ + 'name' => 'CustomUserId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Custom User ID. Used for reading from and saving to archives. The maximum length is 64 characters.'."\n" + .'> This parameter is Required when the application Type is `end_game` or `hand_game`.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2YEF0****', 'maxLength' => 64], + ], + [ + 'name' => 'CustomSessionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Custom session ID. '."\n" + .'Supports ASCII characters and must not exceed 64 characters.'."\n", 'type' => 'string', 'required' => true, 'example' => '1ADE0****', 'maxLength' => 64], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Client IP address of the business.', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX'], + ], + [ + 'name' => 'StartParameters', + 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example', + 'title' => '', + 'description' => 'Business customization parameters. ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => 'key', 'description' => 'Currently supported enumeration values. The value startArgument indicates application start parameters. ', 'type' => 'string', 'required' => false, 'example' => 'startArgument'], + 'Value' => ['title' => 'value', 'description' => 'The value corresponding to the key. ', 'type' => 'string', 'required' => false, 'example' => 'exampleValue'], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'AppType', - 'in' => 'formData', + 'name' => 'SystemInfo', + 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'end_game', + 'title' => '', + 'description' => 'System information. ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Custom is currently supported. The value utdid indicates the Device ID, which helps the platform analyze features of unusual traffic and locate issues.', 'type' => 'string', 'required' => false, 'example' => 'utdid', 'title' => ''], + 'Value' => ['description' => 'The value corresponding to the key. ', 'type' => 'string', 'required' => false, 'example' => 'OE0usD+AP****', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'StreamingAppId', - 'in' => 'formData', + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Custom tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'Tag key. Maximum length is 64 characters.', 'type' => 'string', 'required' => false, 'example' => 'exampleTag', 'title' => ''], + 'Value' => ['description' => 'The value corresponding to the key.', 'type' => 'string', 'required' => false, 'example' => 'exampleValue', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '47d0bd4d-8815-48a2-b783-6cbba89d****', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'StreamingSolution', - 'in' => 'formData', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'Project ID.', 'type' => 'string', 'required' => false, 'example' => 'd9a8****', 'title' => ''], + ], + [ + 'name' => 'DistrictId', + 'in' => 'query', + 'schema' => ['description' => 'Area ID. Valid values:'."\n" + ."\n" + .'- huadong'."\n" + ."\n" + .'- xinan'."\n" + ."\n" + .'- huanan'."\n" + ."\n" + .'- huabei'."\n" + ."\n" + .'- huazhong', 'type' => 'string', 'required' => false, 'example' => 'huadong', 'title' => ''], + ], + [ + 'name' => 'MatchRules', + 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Rule information for resource matching. Multiple rules are supported. The more rules specified, the longer the Duration required to find a suitable resource.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'Rule Type. Valid values:'."\n" + .'- in: Matches resources that carry the specified Key and Value.'."\n" + .'- notIn: Matches resources that do not carry the specified Key and Value.', 'type' => 'string', 'required' => false, 'example' => 'in', 'title' => ''], + 'Key' => ['description' => 'Tag Name provided by the resource.'."\n" + ."\n" + .'Valid value: component, which refers to the widget Version. When a specific widget Version is specified, sessions are started only with resources that carry the specified widget Version.', 'type' => 'string', 'required' => false, 'example' => 'component', 'title' => ''], + 'Values' => [ + 'description' => 'Tag values to match.', + 'type' => 'array', + 'items' => ['description' => 'Agreed-upon tag value.', 'type' => 'string', 'required' => false, 'example' => 'exampleTag', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'self-have-streaming', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'AdapterFileId', + 'in' => 'query', + 'schema' => ['description' => 'Adapter file ID. This feature is released in grayscale. Do not pass this parameter unless agreed upon.', 'type' => 'string', 'required' => false, 'example' => '501716211209548966XXXX', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AppIdDataFlatPopResult', - 'description' => 'AppIdDataFlatPopResult', 'type' => 'object', 'properties' => [ - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4384****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', + 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'], + 'CustomSessionId' => ['title' => '', 'description' => 'Custom session ID. ', 'type' => 'string', 'example' => '1ADE0****'], + 'PlatformSessionId' => ['title' => '', 'description' => 'Platform session ID. ', 'type' => 'string', 'example' => '100****'], + 'AppId' => ['title' => '', 'description' => 'Application ID. ', 'type' => 'string', 'example' => '13027****'], + 'AppVersion' => ['title' => '', 'description' => 'Application Version ID.', 'type' => 'string', 'example' => '35067****'], + 'BizInfo' => [ + 'description' => 'Business information.', + 'type' => 'object', + 'properties' => [ + 'Biz' => ['description' => 'Business result information.', 'type' => 'object', 'example' => 'authToken', 'title' => ''], + 'Endpoints' => [ + 'description' => 'Endpoint information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'Endpoint name.', 'type' => 'string', 'example' => 'exampleName', 'title' => ''], + 'AccessHost' => ['description' => 'Endpoint IP address.', 'type' => 'string', 'example' => '127.0.X.X', 'title' => ''], + 'AccessPort' => ['description' => 'Endpoint port.', 'type' => 'string', 'example' => '8080', 'title' => ''], + 'Type' => ['description' => 'Endpoint type. Valid value: Native.', 'type' => 'string', 'example' => 'Native', 'title' => ''], + 'DistrictId' => ['description' => 'Area ID. Valid values:'."\n" + ."\n" + .'- huadong'."\n" + ."\n" + .'- xinan'."\n" + ."\n" + .'- huanan'."\n" + ."\n" + .'- huabei'."\n" + ."\n" + .'- huazhong', 'type' => 'string', 'example' => 'huabei', 'title' => ''], + 'Isp' => ['description' => 'Carrier. Valid values:'."\n" + ."\n" + .'- MOBILE: China Mobile.'."\n" + ."\n" + .'- UNICOM: China Unicom.'."\n" + ."\n" + .'- TELECOM: China Telecom.'."\n" + ."\n" + .'- BGP: Border Gateway Protocol (BGP).', 'type' => 'string', 'example' => 'BGP', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppId\\": \\"4384****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', - ], - 'ModifyApp' => [ - 'summary' => '应用修改服务', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"CustomSessionId\\": \\"1ADE0****\\",\\n \\"PlatformSessionId\\": \\"100****\\",\\n \\"AppId\\": \\"13027****\\",\\n \\"AppVersion\\": \\"35067****\\",\\n \\"BizInfo\\": {\\n \\"Biz\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Endpoints\\": [\\n {\\n \\"Name\\": \\"exampleName\\",\\n \\"AccessHost\\": \\"127.0.X.X\\",\\n \\"AccessPort\\": \\"8080\\",\\n \\"Type\\": \\"Native\\",\\n \\"DistrictId\\": \\"huabei\\",\\n \\"Isp\\": \\"BGP\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Synchronize to create an application session ', + 'description' => '- After a session is created successfully, the event type is `APP_START`. The result of application startup is notified through the following message. '."\n" + .'><notice>Available only in API integration mode and not applicable to H5 SDK integration mode.></notice>'."\n" + ."\n" + .'|Name | Type | Required |Description|'."\n" + .'| ------ | ------ | ------ |------ |'."\n" + .'| success | Boolean | Yes |Indicates whether the startup succeeded.<br> Valid values:<br>true: Startup succeeded.<br>false: Startup failed.|'."\n" + .'|eventType|String|Yes|Event type.|'."\n" + .'|customSessionId|String|Yes|Custom session ID.|'."\n" + .'|platformSessionId|String|Yes|Platform session ID.|'."\n" + .'|customTaskId|String|No|Custom task ID.|'."\n" + .'|platformTaskId|String|No|Platform task ID.|'."\n" + .'|eventDetail|Object[EventDetail]|Yes|Event details.|'."\n" + .'|errorMessage|Object[EventDetail]|No|Error Details.<br>This parameter is returned when startup fails.|'."\n" + .'|tags|Map<String,String>|No|Session labels.|'."\n" + ."\n" + .'The data structure of EventDetail is as follows.'."\n" + .'|Name|Type|Required|Description|'."\n" + .'| ------ | ------ | ------ |------ |'."\n" + .'|appId|String|Yes|Application ID.|'."\n" + .'|appVersion|String|Yes|Application Version ID.|'."\n" + .'|appBizConfig|String|No|Custom business configuration data used during platform adaptation.|'."\n" + .'|streamingToken|String|No|Streaming authentication information. This field is included only when a streaming service exists.|'."\n" + .'|endpoint|Object[Endpoint]|No|Event details.<br>This parameter is returned when startup succeeds.|'."\n" + ."\n" + .'The data structure of Endpoint is as follows.'."\n" + .'|Name|Type|Required|Description|'."\n" + .'|-------|-------|-------|-------|'."\n" + .'|name|String|Yes|Name.|'."\n" + .'|type|String|Yes|Type.|'."\n" + .'|accessHost|String|Yes|Endpoint IP address.|'."\n" + .'|accessPort|String|Yes|Endpoint port.|'."\n" + .'|isp|String|Yes|<br>Carrier identity.<br>Valid values:<br>MOBILE: China Mobile.<br>UNICOM: China Unicom.<br>TELECOM: China Telecom.<br>BGP: Border Gateway Protocol (BGP).|'."\n" + .'|districtId|String|Yes|Area ID.|'."\n" + .'|regionId|String|Yes|Region ID.|'."\n" + ."\n" + .'The data structure of ErrorMessage is as follows.'."\n" + .'|Name|Type|Required|Description|'."\n" + .'|------|------|------|------|'."\n" + .'|code|String|Yes|Error code.|'."\n" + .'|msg|String|Yes|Error Details.|'."\n" + .'- After a session involving streaming is created successfully, the event type is `APP_STREAMING_INIT`. Streaming initialization information is notified through the following message. '."\n" + .'><notice>Available only in API integration mode and not applicable to H5 SDK integration mode.></notice>'."\n" + ."\n" + .'| Name | Type | Required |Description|'."\n" + .'| ------ | ------ | ------ |------ |'."\n" + .'| success | Boolean | Yes |Indicates whether streaming initialization succeeded.<br> Valid values:<br>true: Initialization succeeded.<br>false: Initialization failed.|'."\n" + .'|eventType|String|Yes|Event type.|'."\n" + .'|customSessionId|String|Yes|Custom session ID.|'."\n" + .'|platformSessionId|String|Yes|Platform session ID.|'."\n" + .'|customTaskId|String|No|Custom task ID.|'."\n" + .'|platformTaskId|String|No|Platform task ID.|'."\n" + .'|eventDetail|Object[EventDetail]|Yes|Event details.|'."\n" + ."\n" + .'The data structure of EventDetail is as follows.'."\n" + .'|Name|Type|Required|Description|'."\n" + .'| ------ | ------ | ------ |------ |'."\n" + .'|appId|String|Yes|Application ID.|'."\n" + .'|appVersion|String|Yes|Application Version ID.|'."\n" + .'|appBizConfig|String|No|Custom business configuration data used during platform adaptation.|'."\n" + .'|streamingToken|String|No|Streaming authentication information. This field is included only when a streaming service exists.|'."\n" + .'|eventDetail|Object[EventDetail]|No|Event details.<br>This parameter is returned when session startup succeeds.|'."\n" + .'|errorMessage|Object|No|Error Details.<br>This parameter is returned when session startup fails.|'."\n" + ."\n" + .'The data structure of Endpoint is as follows.'."\n" + .'|Name|Type|Required|Description|'."\n" + .'|-------|-------|-------|-------|'."\n" + .'|name|String|Yes|Name.|'."\n" + .'|type|String|Yes|Type.|'."\n" + .'|accessHost|String|Yes|Endpoint IP address.|'."\n" + .'|accessPort|String|Yes|Endpoint port.|'."\n" + .'|isp|String|Yes|<br>Carrier identity.<br>Valid values:<br>MOBILE: China Mobile.<br>UNICOM: China Unicom.<br>TELECOM: China Telecom.<br>BGP: Border Gateway Protocol (BGP).|'."\n" + .'|districtId|String|Yes|Area ID.|'."\n" + .'|regionId|String|Yes|Region ID.|'."\n" + ."\n" + .'The data structure of ErrorMessage is as follows.'."\n" + .'|Name|Type|Required|Description|'."\n" + .'|------|------|------|------|'."\n" + .'|code|String|Yes|Error code.|'."\n" + .'|msg|String|Yes|Error Details.|', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppSessionSync'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cgcs:CreateAppSessionSync', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateAppVersion' => [ + 'summary' => 'Create a new version for an application.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'create', 'autoTest' => false], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4384****', - ], + 'schema' => ['description' => 'The ID of the application to which the application version belongs.', 'type' => 'string', 'required' => true, 'example' => '4384****', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'AppVersionName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example', - ], + 'schema' => ['description' => 'Application Version Name.'."\n" + ."\n" + .'Supports Unicode characters, with a maximum of 32 characters.', 'type' => 'string', 'required' => true, 'example' => 'exampleVersion', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AppIdDataFlatPopResult', - 'description' => 'AppIdDataFlatPopResult', + 'title' => 'AppVersionIdDataFlatPopResult', + 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4384****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], + 'AppVersionId' => ['description' => 'Application Version ID.', 'type' => 'string', 'example' => '1432****', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppId\\": \\"4384****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', - ], - 'ListApp' => [ - 'summary' => '应用列表接口', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppVersionId\\": \\"1432****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + 'title' => 'Create Version', + 'changeSet' => [ + ['createdAt' => '2022-06-30T12:58:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-23T08:43:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cgcs:CreateAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateCapacityReservation' => [ + 'summary' => 'Create a container reservation job. The reservation can run containers that support a specified number of sessions, and the reservation result is returned via an HTTP API.'."\n", + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'create', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'KeySearch', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example', - ], + 'schema' => ['title' => '', 'description' => 'Project ID.', 'type' => 'string', 'required' => true, 'example' => 'd9a8****'], ], [ - 'name' => 'PageNumber', + 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '0', - ], + 'schema' => ['title' => '', 'description' => 'The application ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '13027****'], ], [ - 'name' => 'PageSize', + 'name' => 'AppVersion', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '0', - ], + 'schema' => ['title' => '', 'description' => 'The Application Version ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '35067****'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'AppListDataFlatPopResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Apps' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4384****', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-04-06 02:00:00', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-04-06 02:00:00', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example', - ], - 'AppType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'end_game', - ], - 'VersionTotalNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '28', - ], - 'VersionAdaptNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - ], - ], - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], - ], - ], + [ + 'name' => 'DistrictId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Area ID. Valid values:'."\n" + ."\n" + .'- huadong'."\n" + ."\n" + .'- xinan'."\n" + ."\n" + .'- huanan'."\n" + ."\n" + .'- huabei'."\n" + ."\n" + .'- huazhong'."\n" + ."\n", 'type' => 'string', 'required' => true, 'example' => 'huadong'], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Apps\\": [\\n {\\n \\"AppId\\": \\"4384****\\",\\n \\"GmtCreate\\": \\"2022-04-06 02:00:00\\",\\n \\"GmtModified\\": \\"2022-04-06 02:00:00\\",\\n \\"AppName\\": \\"example\\",\\n \\"AppType\\": \\"end_game\\",\\n \\"VersionTotalNum\\": 28,\\n \\"VersionAdaptNum\\": 10\\n }\\n ],\\n \\"Total\\": 12,\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', - ], - 'GetApp' => [ - 'summary' => '应用详情接口', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'ExpectResourceReadyTime', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Expected time when resources become ready to serve.'."\n" + ."\n" + .'Time format: `yyyy-mm-dd HH:MM:SS`.'."\n" + ."\n" + .'Time Zone is UTC+8.'."\n" + ."\n" + .'> This parameter applies only to whitelist Users.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '2022-02-02 22:22:22'], ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'autoTest' => false, - ], - 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'ExpectSessionCapacity', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4384****', - ], + 'schema' => ['title' => '', 'description' => 'Expected number of sessions to support.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Custom token used to ensure Request idempotence. '."\n" + .'> ASCII characters are supported, and the length must not exceed 64 characters.'."\n" + ."\n", 'type' => 'string', 'required' => false, 'example' => '2YEF0****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AppInfoFlatPopResult', - 'description' => '', + 'title' => 'PopHttpResult<>', + 'description' => 'Response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4384****', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-04-06 02:00:00', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-04-06 02:00:00', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example', - ], - 'AppType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'end_game', - ], - 'StreamingAppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '47d0bd4d-8815-48a2-b783-6cbba89d****', - ], - 'StreamingSolution' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'self-have-streaming', - ], - 'VersionTotalNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '28', - ], - 'VersionAdaptNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], + 'TaskId' => ['title' => '', 'description' => 'The container reservation job ID.'."\n", 'type' => 'string', 'example' => 'b354****'], + 'CurrMaxAllocatableSessionCapacity' => ['title' => '', 'description' => 'The current maximum number of allocatable containers. '."\n" + .'><notice>If you repeatedly invoke this API, the parameter value may differ.></notice>'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10000'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"b354****\\",\\n \\"CurrMaxAllocatableSessionCapacity\\": 10000,\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + 'title' => 'Create a container reservation job'."\n", + 'description' => 'When the reservation job completes, the HTTP API pushes a message as follows: '."\n" + .'> The HTTP API is a method for receiving messages about session start, stop, streaming, and other events. Currently, messages are retained for 1 Day, and the retry policy is backoff retry, with a maximum of 176 retries.'."\n" + ."\n" + .'The event type is `CAPACITY_RESERVATION_RESULT`. '."\n" + .'><notice>Regardless of pattern, messages are pushed only through the HTTP API.></notice>'."\n" + ."\n" + .'| Name | Type | Required | Description |'."\n" + .'| ------ | ------ | ------ |----- |'."\n" + .'| success | Boolean | Yes | Indicates whether the job succeeded.<br> Valid values: <br>true: The job succeeded.<br>false: The job failed. |'."\n" + .'| eventType | String | Yes | The event type. |'."\n" + .'| eventDetail | Object[EventDetail] | Yes | The event details.<br>This parameter is returned only when the job succeeds. |'."\n" + ."\n" + .'The data structure of EventDetail is as follows:'."\n" + ."\n" + .'| Name | Type | Required | Description |'."\n" + .'| ------ | ------ | ------ |----- |'."\n" + .'| taskId | String | Yes | The job ID. |'."\n" + .'| success | Boolean | Yes | Indicates whether the job succeeded.<br> Valid values:<br>true: The job succeeded.<br>false: The job failed. |'."\n" + .'| projectId | String | Yes | The project ID. |'."\n" + .'| appId | String | Yes | The application ID. |'."\n" + .'| appVersion | String | Yes | The Application Version. |'."\n" + .'| districtId | String | Yes | The area ID. |'."\n" + .'| expectSessionCapacity | Integer | Yes | The expected number of sessions to be supported. |'."\n" + .'| realSessionCapacity | Integer | Yes | The actual number of sessions supported by the produced containers. |'."\n", + 'changeSet' => [ + ['createdAt' => '2022-12-05T07:51:54.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cgcs:CreateCapacityReservation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppId\\": \\"4384****\\",\\n \\"GmtCreate\\": \\"2022-04-06 02:00:00\\",\\n \\"GmtModified\\": \\"2022-04-06 02:00:00\\",\\n \\"AppName\\": \\"example\\",\\n \\"AppType\\": \\"end_game\\",\\n \\"StreamingAppId\\": \\"47d0bd4d-8815-48a2-b783-6cbba89d****\\",\\n \\"StreamingSolution\\": \\"self-have-streaming\\",\\n \\"VersionTotalNum\\": 28,\\n \\"VersionAdaptNum\\": 10,\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', ], 'DeleteApp' => [ - 'summary' => '应用删除接口', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Delete an application.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'delete', 'autoTest' => false], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4384****', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => '4384****', 'title' => ''], ], ], 'responses' => [ @@ -1088,2688 +1467,2043 @@ 'description' => 'AppIdDataFlatPopResult', 'type' => 'object', 'properties' => [ - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4384****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => '4384****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', 'title' => ''], ], + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppId\\": \\"4384****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', - ], - 'CreateAppVersion' => [ - 'summary' => '应用版本创建服务', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'autoTest' => false, - ], - 'parameters' => [ - [ - 'name' => 'AppId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4384****', - ], - ], - [ - 'name' => 'AppVersionName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'exampleVersion', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'AppVersionIdDataFlatPopResult', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AppVersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1432****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], + 'title' => 'Delete Application', + 'changeSet' => [ + ['createdAt' => '2022-06-30T12:58:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-23T08:43:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cgcs:DeleteApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppVersionId\\": \\"1432****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', ], - 'ModifyAppVersion' => [ - 'summary' => '应用版本修改服务', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteAppVersion' => [ + 'summary' => 'Delete a version of an application.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'delete', 'autoTest' => false], 'parameters' => [ [ 'name' => 'AppVersionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1432****', - ], - ], - [ - 'name' => 'AppVersionName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'exampleVersion', - ], + 'schema' => ['description' => 'Application Version ID.', 'type' => 'string', 'required' => true, 'example' => '1432****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'AppVersionIdDataFlatPopResult', - 'description' => '', + 'description' => 'AppVersionIdDataFlatPopResult', 'type' => 'object', 'properties' => [ - 'AppVersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1432****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], + 'AppVersionId' => ['description' => 'Application Version ID.', 'type' => 'string', 'example' => '1432****', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', 'title' => ''], ], + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppVersionId\\": \\"1432****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', - ], - 'ListAppVersion' => [ - 'summary' => '应用版本列表接口', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Delete Version', + 'changeSet' => [ + ['createdAt' => '2022-06-30T12:58:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-23T08:43:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cgcs:DeleteAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeInstanceStatsInfo' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'list', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'formData', + 'name' => 'ProjectIds', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '4384****', + 'description' => 'List of project IDs. If left blank, all project IDs are included by default.', + 'type' => 'array', + 'items' => ['description' => 'Project ID', 'type' => 'string', 'required' => false, 'example' => '6733705348307226241003', 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageNumber', - 'in' => 'formData', + 'name' => 'InstanceTypes', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'List of instance types. If left blank, all instance types are included by default.', + 'type' => 'array', + 'items' => ['description' => 'Instance type', 'type' => 'string', 'required' => false, 'example' => 'gcs.r1c1m1.1xlarge', 'title' => ''], 'required' => false, - 'example' => '1', - 'default' => '0', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'formData', + 'name' => 'DistrictIds', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'List of District IDs. If left blank, all District IDs are included by default.', + 'type' => 'array', + 'items' => ['description' => 'District ID', 'type' => 'string', 'required' => false, 'example' => 'huabei', 'title' => ''], 'required' => false, - 'example' => '10', - 'default' => '0', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AppVersionListDataFlatPopResult', - 'description' => 'AppVersionListDataFlatPopResult', + 'title' => 'Response<DescribeInstanceStatsInfoPopResponse>', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Versions' => [ - 'description' => '', + 'Data' => [ + 'title' => '', + 'description' => 'Statistics data', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'List of instance statistics data.', 'type' => 'object', 'properties' => [ - 'AppVersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1432****', - ], - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4384****', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-04-06 02:00:00', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-04-06 02:00:00', - ], - 'AppVersionName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'exampleVersion', - ], - 'FileUploadType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud_file_download', - ], - 'FileAddress' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://www.example.com/exampleFile.tar', - ], - 'AppVersionStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'file_uploading', - ], - 'AppVersionStatusMemo' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'FileSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1024', - ], - 'FileUploadFinishTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-04-06 02:00:00', - ], - 'ConsumeCu' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.31', - ], + 'ProjectId' => ['description' => 'Project ID', 'type' => 'string', 'title' => '', 'example' => '6733705348307226241003'], + 'DistrictId' => ['description' => 'District ID', 'type' => 'string', 'title' => '', 'example' => 'huabei'], + 'InstanceType' => ['description' => 'Instance type', 'type' => 'string', 'title' => '', 'example' => 'gcs.r1c1m1.1xlarge'."\n"], + 'TotalCount' => ['description' => 'Total number of instances', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '4'], + 'RunningInstanceCount' => ['description' => 'Number of running instances', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'OperatingInstanceCount' => ['description' => 'Number of O\\&M instances', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'ReservingInstanceCount' => ['description' => 'Number of creating instances', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'ReleasingInstanceCount' => ['description' => 'Number of releasing instances', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0977'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Versions\\": [\\n {\\n \\"AppVersionId\\": \\"1432****\\",\\n \\"AppId\\": \\"4384****\\",\\n \\"GmtCreate\\": \\"2022-04-06 02:00:00\\",\\n \\"GmtModified\\": \\"2022-04-06 02:00:00\\",\\n \\"AppVersionName\\": \\"exampleVersion\\",\\n \\"FileUploadType\\": \\"cloud_file_download\\",\\n \\"FileAddress\\": \\"https://www.example.com/exampleFile.tar\\",\\n \\"AppVersionStatus\\": \\"file_uploading\\",\\n \\"AppVersionStatusMemo\\": \\"文件大于上限\\",\\n \\"FileSize\\": 1024,\\n \\"FileUploadFinishTime\\": \\"2022-04-06 02:00:00\\",\\n \\"ConsumeCu\\": 0.31\\n }\\n ],\\n \\"Total\\": 16,\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', - ], - 'GetAppVersion' => [ - 'summary' => '应用版本详情接口', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"ProjectId\\": \\"6733705348307226241003\\",\\n \\"DistrictId\\": \\"huabei\\",\\n \\"InstanceType\\": \\"gcs.r1c1m1.1xlarge\\\\n\\",\\n \\"TotalCount\\": 4,\\n \\"RunningInstanceCount\\": 1,\\n \\"OperatingInstanceCount\\": 1,\\n \\"ReservingInstanceCount\\": 1,\\n \\"ReleasingInstanceCount\\": 1\\n }\\n ],\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0977\\"\\n}","type":"json"}]', + 'title' => 'Query instance statistics', + 'summary' => 'This API queries statistics information about Graphic Computing Service instances purchased by users, across various dimensions. You can use this API to obtain instance statistics information based on conditions such as Project ID (ProjectId), District ID (DistrictId), and Instance Type (InstanceType). The instance statistics information includes the number of instances in states such as creating, running, O&M, and releasing.', + 'responseParamsDescription' => '### Return example'."\n" + ."\n" + .'Normal return example in JSON format.'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0977",'."\n" + .' "Data": ['."\n" + .' {'."\n" + .' "ProjectId": "6733705348307226241003",'."\n" + .' "DistrictId": "huabei",'."\n" + .' "InstanceType": "gcs.r1c1m1.1xlarge",'."\n" + .' "TotalCount": 4,'."\n" + .' "RunningInstanceCount": 1,'."\n" + .' "OperatingInstanceCount": 1,'."\n" + .' "ReservingInstanceCount": 1,'."\n" + .' "ReleasingInstanceCount": 1'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cgcs:DescribeInstanceStatsInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetAdaptation' => [ + 'summary' => 'Query the details of an adaptation request.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'get', 'autoTest' => false], 'parameters' => [ [ 'name' => 'AppVersionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1432****', - ], + 'schema' => ['description' => 'Application Version ID. '."\n" + .'> Specify either `AppVersionId` or `AdaptApplyId`. If both are provided, this parameter takes precedence. ', 'type' => 'string', 'required' => false, 'example' => '5435****', 'title' => ''], + ], + [ + 'name' => 'AdaptApplyId', + 'in' => 'formData', + 'schema' => ['description' => 'Adaptation Request ID. '."\n" + .'> Either `AppVersionId` or `AdaptApplyId` must be specified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1432****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AppVersionInfoFlatPopResult', - 'description' => 'AppVersionInfoFlatPopResult', + 'title' => 'AdaptApplyDataFlatPopResult', + 'description' => 'AdaptApplyDataFlatPopResult', 'type' => 'object', 'properties' => [ - 'AppVersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1432****', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-04-06 02:00:00', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-04-06 02:00:00', - ], - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4384****', - ], - 'AppVersionName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'exampleVersion', - ], - 'FileUploadType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'local_file_upload', - ], - 'FileAddress' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://www.example.com/exampleFile.tar', - ], - 'AppVersionStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'file_uploading', - ], - 'AppVersionStatusMemo' => [ - 'description' => '', - 'type' => 'string', + 'AdaptApplyId' => ['description' => 'Application Adaptation Request ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '5435****', 'title' => ''], + 'GmtCreate' => ['description' => 'Creation Time of the application adaptation.', 'type' => 'string', 'example' => '2022-04-06 02:00:00', 'title' => ''], + 'GmtModified' => ['description' => 'Last Updated At time of the application adaptation.', 'type' => 'string', 'example' => '2022-04-06 02:00:00', 'title' => ''], + 'AppId' => ['description' => 'Application ID.', 'type' => 'string', 'example' => '4384****', 'title' => ''], + 'AppVersionId' => ['description' => 'Application Version ID.', 'type' => 'string', 'example' => '1432****', 'title' => ''], + 'AdaptTarget' => [ + 'description' => 'Target adaptation information.', + 'type' => 'object', + 'properties' => [ + 'StartProgram' => ['description' => 'Start program.'."\n" + ."\n" + .'> This parameter is displayed when `AppType` is `end_game`, `hand_game`, or `render_app`.', 'type' => 'string', 'example' => '/example/example.exe', 'title' => ''], + 'Resolution' => ['description' => 'Resolution.'."\n" + ."\n" + .'> This parameter is displayed when `AppType` is `end_game` or `hand_game`.', 'type' => 'string', 'example' => '1080p', 'title' => ''], + 'FrameRate' => ['description' => 'Frame rate.'."\n" + ."\n" + .'Unit: Fps.'."\n" + ."\n" + .'> This parameter is displayed when `AppType` is `end_game` or `hand_game`.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'BitRate' => ['description' => 'Bitrate.'."\n" + ."\n" + .'Unit: Mbps.'."\n" + ."\n" + .'> This parameter is displayed when `AppType` is `end_game` or `hand_game`.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'FileUploadFinishTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-04-06 02:00:00', - ], - 'FileSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1024', - ], - 'ConsumeCu' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.31', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppVersionId\\": \\"1432****\\",\\n \\"GmtCreate\\": \\"2022-04-06 02:00:00\\",\\n \\"GmtModified\\": \\"2022-04-06 02:00:00\\",\\n \\"AppId\\": \\"4384****\\",\\n \\"AppVersionName\\": \\"exampleVersion\\",\\n \\"FileUploadType\\": \\"local_file_upload\\",\\n \\"FileAddress\\": \\"https://www.example.com/exampleFile.tar\\",\\n \\"AppVersionStatus\\": \\"file_uploading\\",\\n \\"AppVersionStatusMemo\\": \\"文件大于上限\\",\\n \\"FileUploadFinishTime\\": \\"2022-04-06 02:00:00\\",\\n \\"FileSize\\": 1024,\\n \\"ConsumeCu\\": 0.31,\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', - ], - 'DeleteAppVersion' => [ - 'summary' => '应用版本删除接口', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AdaptApplyId\\": 0,\\n \\"GmtCreate\\": \\"2022-04-06 02:00:00\\",\\n \\"GmtModified\\": \\"2022-04-06 02:00:00\\",\\n \\"AppId\\": \\"4384****\\",\\n \\"AppVersionId\\": \\"1432****\\",\\n \\"AdaptTarget\\": {\\n \\"StartProgram\\": \\"/example/example.exe\\",\\n \\"Resolution\\": \\"1080p\\",\\n \\"FrameRate\\": 30,\\n \\"BitRate\\": 30\\n },\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + 'title' => 'Query Adaptation Details', + 'changeSet' => [ + ['createdAt' => '2022-06-30T12:58:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-23T08:43:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cgcs:GetAdaptation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetApp' => [ + 'summary' => 'Query the details of a single application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'get', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'AppVersionId', + 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1432****', - ], + 'schema' => ['description' => 'Application ID.', 'type' => 'string', 'required' => true, 'example' => '4384****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AppVersionIdDataFlatPopResult', - 'description' => 'AppVersionIdDataFlatPopResult', + 'title' => 'AppInfoFlatPopResult', + 'description' => 'Returned parameters.', 'type' => 'object', 'properties' => [ - 'AppVersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1432****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], + 'AppId' => ['description' => 'Application ID.', 'type' => 'string', 'example' => '4384****', 'title' => ''], + 'GmtCreate' => ['description' => 'Application Creation Time.', 'type' => 'string', 'example' => '2022-04-06 02:00:00', 'title' => ''], + 'GmtModified' => ['description' => 'Application Updated At.', 'type' => 'string', 'example' => '2022-04-06 02:00:00', 'title' => ''], + 'AppName' => ['description' => 'Application Name.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'AppType' => ['description' => 'Application Type. Valid values:'."\n" + ."\n" + .'- end_game: PC game (client-based game).'."\n" + .'- hand_game: Mobile game (mobile device game).'."\n" + .'- ai_app: Artificial intelligence application.'."\n" + .'- render_app: Rendering application.'."\n" + .'- cluster_compute: Scientific computing application.'."\n" + .'- compute: Scientific rendering application.', 'type' => 'string', 'example' => 'end_game', 'title' => ''], + 'StreamingAppId' => ['description' => 'Graphic Computing Service streaming instance ID.', 'type' => 'string', 'example' => '47d0bd4d-8815-48a2-b783-6cbba89d****', 'title' => ''], + 'StreamingSolution' => ['description' => 'Streaming solution. '."\n" + .'Valid values:'."\n" + ."\n" + .'- video-cloud-streaming: Use Graphic Computing Service streaming.'."\n" + .'- self-have-streaming: Use your own streaming solution.', 'type' => 'string', 'example' => 'self-have-streaming', 'title' => ''], + 'VersionTotalNum' => ['description' => 'The total number of versions created for the application.', 'type' => 'integer', 'format' => 'int64', 'example' => '28', 'title' => ''], + 'VersionAdaptNum' => ['description' => 'The total number of versions successfully adapted for the application.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppVersionId\\": \\"1432****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', - ], - 'CreateAdaptation' => [ - 'summary' => '提交适配请求', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppId\\": \\"4384****\\",\\n \\"GmtCreate\\": \\"2022-04-06 02:00:00\\",\\n \\"GmtModified\\": \\"2022-04-06 02:00:00\\",\\n \\"AppName\\": \\"example\\",\\n \\"AppType\\": \\"end_game\\",\\n \\"StreamingAppId\\": \\"47d0bd4d-8815-48a2-b783-6cbba89d****\\",\\n \\"StreamingSolution\\": \\"self-have-streaming\\",\\n \\"VersionTotalNum\\": 28,\\n \\"VersionAdaptNum\\": 10,\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + 'title' => 'Query Application Details', + 'changeSet' => [ + ['createdAt' => '2022-12-22T12:17:30.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-30T12:35:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-23T08:43:32.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cgcs:GetApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetAppCcu' => [ + 'summary' => 'Query the details of running sessions. ', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'get', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'AppVersionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1432****', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Project ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'd9a8****'], ], [ - 'name' => 'AdaptTarget', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Application ID. ', 'type' => 'string', 'required' => false, 'example' => '13027****'], + ], + [ + 'name' => 'AppVersion', + 'in' => 'query', + 'schema' => ['description' => 'Application Version ID. ', 'type' => 'string', 'required' => false, 'example' => '35067****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'Returned parameters. ', 'type' => 'object', 'properties' => [ - 'StartProgram' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '/example/example.exe', - ], - 'Resolution' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1080p', - ], - 'FrameRate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - 'BitRate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'], + 'Timestamp' => ['title' => '', 'description' => 'UNIX timestamp. ', 'type' => 'string', 'example' => '1665560460990'], + 'DetailList' => [ + 'description' => 'List of detailed statistics information for current sessions. ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['title' => '', 'description' => 'Project ID. ', 'type' => 'string', 'example' => 'd9a8****'], + 'AppId' => ['description' => 'Application ID. ', 'type' => 'string', 'example' => '13027****', 'title' => ''], + 'DistrictId' => ['description' => 'Area ID. Valid values:'."\n" + ."\n" + .'- huadong'."\n" + ."\n" + .'- xinan'."\n" + ."\n" + .'- huanan'."\n" + ."\n" + .'- huabei'."\n" + ."\n" + .'- huazhong ', 'type' => 'string', 'example' => 'huadong', 'title' => ''], + 'Ccu' => ['description' => 'Total number of currently unended sessions. ', 'type' => 'string', 'example' => '100', 'title' => ''], + 'AppVersion' => ['description' => 'Application Version ID. ', 'type' => 'string', 'example' => '35067****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '30', + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"Timestamp\\": \\"1665560460990\\",\\n \\"DetailList\\": [\\n {\\n \\"ProjectId\\": \\"d9a8****\\",\\n \\"AppId\\": \\"13027****\\",\\n \\"DistrictId\\": \\"huadong\\",\\n \\"Ccu\\": \\"100\\",\\n \\"AppVersion\\": \\"35067****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query statistics information of running sessions ', + 'changeSet' => [ + ['createdAt' => '2022-11-22T12:59:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-07-25T03:00:00.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAppCcu'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cgcs:GetAppCcu', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + 'GetAppSession' => [ + 'summary' => 'Obtain application session details.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'autoTest' => false], + 'parameters' => [ + [ + 'name' => 'PlatformSessionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Platform session ID, which uniquely identifies a session in the platform.'."\n" + ."\n" + .'Note: Either PlatformSessionId or CustomSessionId must be specified. If both parameters are set, PlatformSessionId takes precedence.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '100XXXX'], + ], + [ + 'name' => 'CustomSessionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Custom session ID, used to query the most recent application session record that has not ended.'."\n" + ."\n" + .'Note: You must specify either PlatformSessionId or CustomSessionId. If both parameters are set, PlatformSessionId takes precedence.', 'type' => 'string', 'required' => false, 'example' => '1ADE0XXXX'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AdaptIdDataFlatPopResult', - 'description' => '', 'type' => 'object', 'properties' => [ - 'AdaptApplyId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5435****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'], + 'CustomSessionId' => ['title' => '', 'description' => 'Custom session ID ', 'type' => 'string', 'example' => '1ADE0XXXX'], + 'PlatformSessionId' => ['title' => '', 'description' => 'Platform session ID ', 'type' => 'string', 'example' => '100XXXX'], + 'AppId' => ['title' => '', 'description' => 'Application ID ', 'type' => 'string', 'example' => '13027XXXX'], + 'AppVersion' => ['title' => '', 'description' => 'Application Version ID ', 'type' => 'string', 'example' => '35067XXXX'], + 'Status' => ['title' => '', 'description' => 'Application session status, including:'."\n" + .'- starting: Starting'."\n" + .'- running: Running'."\n" + .'- stopping: Stopping', 'type' => 'string', 'example' => 'running'], + 'BizInfo' => [ + 'description' => '业务特定的信息，如会话启动/停止时间。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => '会话启动时间', 'type' => 'string', 'example' => '2022-07-20 17:58:51', 'title' => ''], + 'StopTime' => ['description' => '会话停止时间', 'type' => 'string', 'example' => '2022-07-20 17:58:57', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AdaptApplyId\\": 0,\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', - ], - 'GetAdaptation' => [ - 'summary' => '获取适配申请详情', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"CustomSessionId\\": \\"1ADE0XXXX\\",\\n \\"PlatformSessionId\\": \\"100XXXX\\",\\n \\"AppId\\": \\"13027XXXX\\",\\n \\"AppVersion\\": \\"35067XXXX\\",\\n \\"Status\\": \\"running\\",\\n \\"BizInfo\\": {\\n \\"StartTime\\": \\"2022-07-20 17:58:51\\",\\n \\"StopTime\\": \\"2022-07-20 17:58:57\\"\\n }\\n}","type":"json"}]', + 'title' => 'Obtain Application Session Details', + 'changeSet' => [ + ['createdAt' => '2022-03-03T09:19:30.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2022-03-03T09:19:30.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetAppSession'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cgcs:GetAppSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetAppVersion' => [ + 'summary' => 'Query the details of a specific application version. ', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'get', 'autoTest' => false], 'parameters' => [ [ 'name' => 'AppVersionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5435****', - ], - ], - [ - 'name' => 'AdaptApplyId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1432****', - ], + 'schema' => ['description' => 'Application Version ID. ', 'type' => 'string', 'required' => true, 'example' => '1432****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AdaptApplyDataFlatPopResult', - 'description' => 'AdaptApplyDataFlatPopResult', + 'title' => 'AppVersionInfoFlatPopResult', + 'description' => 'AppVersionInfoFlatPopResult', 'type' => 'object', 'properties' => [ - 'AdaptApplyId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5435****', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-04-06 02:00:00', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-04-06 02:00:00', - ], - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4384****', - ], - 'AppVersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1432****', - ], - 'AdaptTarget' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StartProgram' => [ - 'description' => '', - 'type' => 'string', - 'example' => '/example/example.exe', - ], - 'Resolution' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1080p', - ], - 'FrameRate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'BitRate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], + 'AppVersionId' => ['description' => 'Application version ID. ', 'type' => 'string', 'example' => '1432****', 'title' => ''], + 'GmtCreate' => ['description' => 'Creation time of the application version. ', 'type' => 'string', 'example' => '2022-04-06 02:00:00', 'title' => ''], + 'GmtModified' => ['description' => 'Last modification time of the application. ', 'type' => 'string', 'example' => '2022-04-06 02:00:00', 'title' => ''], + 'AppId' => ['description' => 'Application ID. ', 'type' => 'string', 'example' => '4384****', 'title' => ''], + 'AppVersionName' => ['description' => 'Application version name. ', 'type' => 'string', 'example' => 'exampleVersion', 'title' => ''], + 'FileUploadType' => ['description' => 'File upload method. Valid values: '."\n" + ."\n" + .'- cloud_file_download: Cloud-based offline download. '."\n" + .'- local_file_upload: Local file upload. ', 'type' => 'string', 'example' => 'local_file_upload', 'title' => ''], + 'FileAddress' => ['description' => 'File address. ', 'type' => 'string', 'example' => 'https://www.example.com/exampleFile.tar', 'title' => ''], + 'AppVersionStatus' => ['description' => 'Application version status. Valid values: '."\n" + ."\n" + .'- file_uploading: Uploading. '."\n" + .'- file_upload_fail: Upload failed. '."\n" + .'- file_upload_success: Upload succeeded. '."\n" + .'- app_adapting: Adapting application. '."\n" + .'- app_adapt_fail: Application adaptation failed. '."\n" + .'- app_adapt_success: Application adapted. '."\n" + .'- app_deploy_success: Application deployed. '."\n" + .'- app_deleting: Deleting application. '."\n" + .'- app_deleted: Application deleted. ', 'type' => 'string', 'example' => 'file_uploading', 'title' => ''], + 'AppVersionStatusMemo' => ['description' => 'Description of the application version status, such as the reason for upload failure. ', 'type' => 'string', 'example' => '文件大于上限', 'title' => ''], + 'FileUploadFinishTime' => ['description' => 'File upload completion time for the application. ', 'type' => 'string', 'example' => '2022-04-06 02:00:00', 'title' => ''], + 'FileSize' => ['description' => 'File size of the application. '."\n" + .'Unit: Byte. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''], + 'ConsumeCu' => ['description' => 'Minimum number of CUs required by the version. ', 'type' => 'number', 'format' => 'double', 'example' => '0.31', 'title' => ''], + 'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AdaptApplyId\\": 0,\\n \\"GmtCreate\\": \\"2022-04-06 02:00:00\\",\\n \\"GmtModified\\": \\"2022-04-06 02:00:00\\",\\n \\"AppId\\": \\"4384****\\",\\n \\"AppVersionId\\": \\"1432****\\",\\n \\"AdaptTarget\\": {\\n \\"StartProgram\\": \\"/example/example.exe\\",\\n \\"Resolution\\": \\"1080p\\",\\n \\"FrameRate\\": 30,\\n \\"BitRate\\": 30\\n },\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', - ], - 'CreateCapacityReservation' => [ - 'summary' => '预定session资源', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppVersionId\\": \\"1432****\\",\\n \\"GmtCreate\\": \\"2022-04-06 02:00:00\\",\\n \\"GmtModified\\": \\"2022-04-06 02:00:00\\",\\n \\"AppId\\": \\"4384****\\",\\n \\"AppVersionName\\": \\"exampleVersion\\",\\n \\"FileUploadType\\": \\"local_file_upload\\",\\n \\"FileAddress\\": \\"https://www.example.com/exampleFile.tar\\",\\n \\"AppVersionStatus\\": \\"file_uploading\\",\\n \\"AppVersionStatusMemo\\": \\"文件大于上限\\",\\n \\"FileUploadFinishTime\\": \\"2022-04-06 02:00:00\\",\\n \\"FileSize\\": 1024,\\n \\"ConsumeCu\\": 0.31,\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + 'title' => 'Query Version Details ', + 'changeSet' => [ + ['createdAt' => '2022-06-30T12:58:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-23T08:43:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cgcs:GetAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetCapacity' => [ + 'summary' => 'Query container information.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'get', 'autoTest' => false], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'd9a8****', - ], + 'schema' => ['title' => '', 'description' => 'Project ID.', 'type' => 'string', 'required' => false, 'example' => 'd9a8****'], ], [ 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'title' => '应用ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '13027****', - ], + 'schema' => ['title' => '', 'description' => 'Application ID.', 'type' => 'string', 'required' => false, 'example' => '13027****'], ], [ 'name' => 'AppVersion', 'in' => 'formData', - 'schema' => [ - 'title' => '应用版本ID，如果不填，采用控制台设置的默认版本', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '35067****', - ], + 'schema' => ['title' => '', 'description' => 'Application Version ID.', 'type' => 'string', 'required' => false, 'example' => '35067****'], ], [ 'name' => 'DistrictId', 'in' => 'formData', - 'schema' => [ - 'title' => '大区 id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'huadong', - ], - ], - [ - 'name' => 'ExpectResourceReadyTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '预期资源ready可服务时间 时间格式 yyyy-mm-dd HH:MM:SS 比如', - 'description' => '', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => '2022-02-02 22:22:22', - ], + 'schema' => ['title' => '', 'description' => 'Area ID. Valid values:'."\n" + ."\n" + .'- huadong'."\n" + ."\n" + .'- xinan'."\n" + ."\n" + .'- huanan'."\n" + ."\n" + .'- huabei'."\n" + ."\n" + .'- huazhong'."\n", 'type' => 'string', 'required' => false, 'example' => 'huadong'], ], [ - 'name' => 'ExpectSessionCapacity', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'title' => '预期创建出的容器能支持的 session 数量。GCS 内部会根据适配自动计算出所需要的资源量，以及多种机型的配比。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '100', - ], + 'schema' => ['title' => '', 'description' => 'Number of data rows displayed per page during paging. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '20'], ], [ - 'name' => 'ClientToken', + 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'title' => '客户端 token，保持幂等性。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2YEF0****', - ], + 'schema' => ['title' => '', 'description' => 'Page number. Starting value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PopHttpResult<>', - 'description' => '', + 'description' => 'Return parameters.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'title' => '容器创建任务 id', - 'description' => '', - 'type' => 'string', - 'example' => 'b354****', - ], - 'CurrMaxAllocatableSessionCapacity' => [ - 'title' => '当前最大可分配的 session 库存，注意两次调用之间，该库存值可能有变动', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'RequestId' => [ - 'title' => 'pop的requestId', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', + 'Total' => ['title' => '', 'description' => 'Number of container information records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'PageNum' => ['title' => '', 'description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Number of data rows.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'Capacities' => [ + 'title' => '', + 'description' => 'Container information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DistrictId' => ['title' => '', 'description' => 'Area ID. Valid values:'."\n" + ."\n" + .'- huadong'."\n" + ."\n" + .'- xinan'."\n" + ."\n" + .'- huanan'."\n" + ."\n" + .'- huabei'."\n" + ."\n" + .'- huazhong'."\n", 'type' => 'string', 'example' => 'huadong'."\n"], + 'AppId' => ['title' => '', 'description' => 'Application ID.', 'type' => 'string', 'example' => '13027****'], + 'AppVersion' => ['title' => '', 'description' => 'Application Version ID.', 'type' => 'string', 'example' => '35067****'], + 'SessionCapacity' => ['title' => '', 'description' => 'The number of sessions supported by the container.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'ProjectId' => ['description' => 'Project ID.', 'type' => 'string', 'example' => 'd9a8****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"b354****\\",\\n \\"CurrMaxAllocatableSessionCapacity\\": 10000,\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', - ], - 'CancelReserveTask' => [ - 'summary' => '取消 session 资源预定任务', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 100,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"Capacities\\": [\\n {\\n \\"DistrictId\\": \\"huadong\\\\n\\",\\n \\"AppId\\": \\"13027****\\",\\n \\"AppVersion\\": \\"35067****\\",\\n \\"SessionCapacity\\": 2,\\n \\"ProjectId\\": \\"d9a8****\\"\\n }\\n ],\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + 'title' => 'Query container information', + 'description' => 'Supports specifying query conditions. When multiple conditions are specified, all conditions must be met simultaneously to query container information.', + 'changeSet' => [ + ['createdAt' => '2022-12-05T07:51:54.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-07-19T07:28:22.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cgcs:GetCapacity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetReserveTaskDetail' => [ + 'summary' => 'Query the details of a container reservation job. ', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'get', 'autoTest' => false], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'formData', - 'schema' => [ - 'title' => '创建容量预定任务时返回的 taskId', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'b354****', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'title' => '客户端幂等性 token', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2YEF0****', - ], + 'schema' => ['title' => '', 'description' => 'Capacity reservation job ID.', 'type' => 'string', 'required' => true, 'example' => 'b354****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'PopHttpResult<>', - 'description' => '', + 'description' => 'Returned parameters. ', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'b354****', - ], - 'RequestId' => [ - 'title' => 'pop的requestId', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', + 'TaskId' => ['title' => '', 'description' => 'Container reservation job ID. ', 'type' => 'string', 'example' => 'b354****'], + 'TaskStatus' => ['title' => '', 'description' => 'Task Status. Valid values:'."\n" + ."\n" + .'- created: Created but not running.'."\n" + ."\n" + .'- running: Running.'."\n" + ."\n" + .'- cancelled: Cancelled.'."\n" + ."\n" + .'- cancelling: Cancelling.'."\n" + ."\n" + .'- completed: Completed.'."\n" + ."\n" + .'- failed: Failed.', 'type' => 'string', 'example' => 'created'], + 'ProjectId' => ['title' => '', 'description' => 'Project ID. ', 'type' => 'string', 'example' => 'd9a8****'], + 'AppId' => ['title' => '', 'description' => 'Application ID. ', 'type' => 'string', 'example' => '13027****'], + 'AppVersion' => ['title' => '', 'description' => 'Application Version ID. ', 'type' => 'string', 'example' => '35067****'], + 'DistrictId' => ['title' => '', 'description' => 'Area ID. Valid values:'."\n" + ."\n" + .'- huadong'."\n" + ."\n" + .'- xinan'."\n" + ."\n" + .'- huanan'."\n" + ."\n" + .'- huabei'."\n" + ."\n" + .'- huazhong'."\n", 'type' => 'string', 'example' => 'huadong'], + 'ExpectSessionCapacity' => ['title' => '', 'description' => 'Expected number of session ingest endpoints for the capacity reservation. ', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'CurrCompletedSessionCapacity' => ['title' => '', 'description' => 'Number of ingest endpoints for sessions already completed by the current job. ', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'ExpectResourceReadyTime' => ['title' => '', 'description' => 'Expected effective period for the capacity reservation. '."\n" + .'Format: `YYYY-MM-DD hh:mm:ss`. Time Zone: UTC+8. ', 'type' => 'string', 'example' => '2022-02-02 22:22:22'], + 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'], + 'ResBatchList' => [ + 'description' => 'The resource batches included in this reservation.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResBatchId' => ['description' => 'Batch ID.', 'type' => 'string', 'example' => '726573XXXX', 'title' => ''], + 'ResBatchTagName' => ['description' => 'Tag Name of the batch. The value is currently fixed as resBatchId.', 'type' => 'string', 'example' => 'resBatchId', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"b354****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', - ], - 'GetReserveTaskDetail' => [ - 'summary' => '查询预定任务的详情信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"b354****\\",\\n \\"TaskStatus\\": \\"created\\",\\n \\"ProjectId\\": \\"d9a8****\\",\\n \\"AppId\\": \\"13027****\\",\\n \\"AppVersion\\": \\"35067****\\",\\n \\"DistrictId\\": \\"huadong\\",\\n \\"ExpectSessionCapacity\\": 100,\\n \\"CurrCompletedSessionCapacity\\": 100,\\n \\"ExpectResourceReadyTime\\": \\"2022-02-02 22:22:22\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"ResBatchList\\": [\\n {\\n \\"ResBatchId\\": \\"726573XXXX\\",\\n \\"ResBatchTagName\\": \\"resBatchId\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Container Reservation Job Details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cgcs:GetReserveTaskDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListApp' => [ + 'summary' => 'Query the application list.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'list', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'KeySearch', 'in' => 'formData', - 'schema' => [ - 'title' => '创建容量预定任务时返回的 taskId', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'b354****', - ], + 'schema' => ['description' => 'Search keyword.'."\n" + ."\n" + .'> You can perform a fuzzy query by entering an application ID or application name.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number.'."\n" + ."\n" + .'Starting value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '0', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of data rows displayed per page during paging.'."\n" + ."\n" + .'Valid values: 1 to 9999.'."\n" + ."\n" + .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PopHttpResult<>', - 'description' => '', + 'title' => 'AppListDataFlatPopResult', + 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'title' => '容器创建任务 id', - 'description' => '', - 'type' => 'string', - 'example' => 'b354****', - ], - 'TaskStatus' => [ - 'title' => '任务状态', - 'description' => '', - 'type' => 'string', - 'example' => 'created', - ], - 'ProjectId' => [ - 'title' => '容量预定时的 projectId', - 'description' => '', - 'type' => 'string', - 'example' => 'd9a8****', - ], - 'AppId' => [ - 'title' => '容量预定时的 appId', - 'description' => '', - 'type' => 'string', - 'example' => '13027****', - ], - 'AppVersion' => [ - 'title' => '容量预定时的 appVersion', - 'description' => '', - 'type' => 'string', - 'example' => '35067****', - ], - 'DistrictId' => [ - 'title' => '容量预定时指定的大区id', - 'description' => '', - 'type' => 'string', - 'example' => 'huadong', - ], - 'ExpectSessionCapacity' => [ - 'title' => '容量预定期望的会话路数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'CurrCompletedSessionCapacity' => [ - 'title' => '当前任务已经生产完成的会话路数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'ExpectResourceReadyTime' => [ - 'title' => '容量预定，期望生效时间', - 'description' => '', - 'type' => 'string', - 'example' => '2022-02-02 22:22:22', - ], - 'RequestId' => [ - 'title' => 'pop的requestId', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], - 'ResBatchList' => [ - 'description' => '', + 'Apps' => [ + 'description' => 'Application list.', 'type' => 'array', 'items' => [ + 'description' => 'Application list.', 'type' => 'object', 'properties' => [ - 'ResBatchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '726573XXXX', - ], - 'ResBatchTagName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'resBatchId', - ], + 'AppId' => ['description' => 'Application ID.', 'type' => 'string', 'example' => '4384****', 'title' => ''], + 'GmtCreate' => ['description' => 'Creation Time of the application.', 'type' => 'string', 'example' => '2022-04-06 02:00:00', 'title' => ''], + 'GmtModified' => ['description' => 'Last Updated At time of the application.', 'type' => 'string', 'example' => '2022-04-06 02:00:00', 'title' => ''], + 'AppName' => ['description' => 'Application Name.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'AppType' => ['description' => 'Application Type. Valid values:'."\n" + ."\n" + .'- end_game: PC game (client-based game).'."\n" + .'- hand_game: Mobile game (mobile device game).'."\n" + .'- ai_app: Artificial intelligence application.'."\n" + .'- render_app: Rendering application.'."\n" + .'- cluster_compute: Scientific computing application.'."\n" + .'- compute: Scientific rendering application.', 'type' => 'string', 'example' => 'end_game', 'title' => ''], + 'VersionTotalNum' => ['description' => 'Total number of versions created for the application.', 'type' => 'integer', 'format' => 'int64', 'example' => '28', 'title' => ''], + 'VersionAdaptNum' => ['description' => 'Total number of versions successfully adapted for the application.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'Total' => ['description' => 'Total number of applications.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"b354****\\",\\n \\"TaskStatus\\": \\"created\\",\\n \\"ProjectId\\": \\"d9a8****\\",\\n \\"AppId\\": \\"13027****\\",\\n \\"AppVersion\\": \\"35067****\\",\\n \\"DistrictId\\": \\"huadong\\",\\n \\"ExpectSessionCapacity\\": 100,\\n \\"CurrCompletedSessionCapacity\\": 100,\\n \\"ExpectResourceReadyTime\\": \\"2022-02-02 22:22:22\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"ResBatchList\\": [\\n {\\n \\"ResBatchId\\": \\"726573XXXX\\",\\n \\"ResBatchTagName\\": \\"resBatchId\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'ReleaseCapacity' => [ - 'summary' => '释放 session 资源预定的资源', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Apps\\": [\\n {\\n \\"AppId\\": \\"4384****\\",\\n \\"GmtCreate\\": \\"2022-04-06 02:00:00\\",\\n \\"GmtModified\\": \\"2022-04-06 02:00:00\\",\\n \\"AppName\\": \\"example\\",\\n \\"AppType\\": \\"end_game\\",\\n \\"VersionTotalNum\\": 28,\\n \\"VersionAdaptNum\\": 10\\n }\\n ],\\n \\"Total\\": 12,\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + 'title' => 'Query Application List', + 'changeSet' => [ + ['createdAt' => '2022-06-30T12:58:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-23T08:43:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cgcs:ListApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListAppSessions' => [ + 'summary' => 'Query the application session list. Batch queries are supported. Only information about sessions that have not ended can be queried.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'list', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', + 'name' => 'PlatformSessionIds', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '项目 id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'd9a8****', + 'title' => '', + 'description' => 'List of platform session IDs ', + 'type' => 'array', + 'items' => ['description' => 'One of the IDs', 'type' => 'string', 'required' => false, 'example' => '100XXXX', 'title' => ''], + 'required' => false, + 'docRequired' => false, + 'maxItems' => 50, + 'example' => '', ], ], [ - 'name' => 'AppId', - 'in' => 'formData', + 'name' => 'CustomSessionIds', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => 'app id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '13027****', + 'title' => '', + 'description' => 'List of custom session IDs ', + 'type' => 'array', + 'items' => ['description' => 'One of the IDs ', 'type' => 'string', 'required' => false, 'example' => '1ADE0XXXX', 'title' => ''], + 'required' => false, + 'maxItems' => 50, + 'example' => '', ], ], [ - 'name' => 'DistrictId', - 'in' => 'formData', - 'schema' => [ - 'title' => '大区 id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'huadong', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '', 'description' => 'Number of entries per page for paged query. Maximum value is 100. Default value is 20. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'default' => '10'], ], [ - 'name' => 'ExpectReleaseSessionCapacity', - 'in' => 'formData', - 'schema' => [ - 'title' => '期望释放的会话路数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '100', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '', 'description' => 'Page number of the instance list. Starting value is 1. Default value is 1. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'AppVersion', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '35067****', - ], + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'Application ID ', 'type' => 'string', 'required' => false, 'example' => '13027XXXX', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'Project ID. ', 'type' => 'string', 'required' => false, 'example' => 'd9a8****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PopHttpResult<>', - 'description' => '', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'title' => '容器异步释放任务 id', - 'description' => '', - 'type' => 'string', - 'example' => 'b354****', - ], - 'RequestId' => [ - 'title' => 'pop的requestId', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', + 'RequestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'], + 'AppSessions' => [ + 'description' => 'Session list', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CustomSessionId' => ['title' => '', 'description' => 'Custom session ID ', 'type' => 'string', 'example' => '1ADE0XXXX'], + 'PlatformSessionId' => ['title' => '', 'description' => 'Platform session ID', 'type' => 'string', 'example' => '100XXXX '], + 'AppId' => ['title' => '', 'description' => 'Application ID', 'type' => 'string', 'example' => '13027XXXX'], + 'AppVersion' => ['title' => '', 'description' => 'Application version ID', 'type' => 'string', 'example' => '35067XXXX'], + 'Status' => ['title' => '', 'description' => 'Application session status, including:'."\n" + .'- starting: Starting'."\n" + .'- running: Running'."\n" + .'- stopping: Stopping', 'type' => 'string', 'example' => 'running'], + 'BizInfo' => [ + 'description' => '业务特定的信息，如会话启动/停止时间。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => '会话启动时间', 'type' => 'string', 'example' => '2022-07-20 17:58:51', 'title' => ''], + 'StopTime' => ['description' => '会话停止时间', 'type' => 'string', 'example' => '2022-07-20 17:58:57', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ProjectId' => ['description' => 'Project ID. ', 'type' => 'string', 'example' => 'd9a8****'."\n", 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'PageSize' => ['description' => 'Page size ', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'PageNumber' => ['description' => 'Page number ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'Total count', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"b354****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', - ], - 'ReleaseCapacityByBatch' => [ - 'summary' => '根据资源批次号释放 session 资源预定的资源', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'autoTest' => false, - ], - 'parameters' => [ - [ - 'name' => 'ResBatchId', - 'in' => 'formData', - 'schema' => [ - 'title' => '项目 id', 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '726573XXXX', + 'title' => '', + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'PopHttpResult<>', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'pop的requestId', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'."\n", - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"AppSessions\\": [\\n {\\n \\"CustomSessionId\\": \\"1ADE0XXXX\\",\\n \\"PlatformSessionId\\": \\"100XXXX \\",\\n \\"AppId\\": \\"13027XXXX\\",\\n \\"AppVersion\\": \\"35067XXXX\\",\\n \\"Status\\": \\"running\\",\\n \\"BizInfo\\": {\\n \\"StartTime\\": \\"2022-07-20 17:58:51\\",\\n \\"StopTime\\": \\"2022-07-20 17:58:57\\"\\n },\\n \\"ProjectId\\": \\"d9a8****\\\\n\\"\\n }\\n ],\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100\\n}","type":"json"}]', + 'title' => 'Query application session list ', + 'changeSet' => [ + ['createdAt' => '2023-05-23T08:47:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-05-23T08:24:28.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-05-31T03:14:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-03-03T09:19:30.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAppSessions'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cgcs:ListAppSessions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\\\n\\"\\n}","type":"json"}]', ], - 'GetCapacity' => [ - 'summary' => '查询 session 会话容量信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListAppVersion' => [ + 'summary' => 'Query the version list of an application. ', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'get', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'title' => '项目 id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd9a8****', - ], - ], - [ 'name' => 'AppId', 'in' => 'formData', - 'schema' => [ - 'title' => '按照 appId 来匹配', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13027****', - ], + 'schema' => ['description' => 'Application ID. ', 'type' => 'string', 'required' => true, 'example' => '4384****', 'title' => ''], ], [ - 'name' => 'AppVersion', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'title' => '按照 app 版本来匹配', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '35067****', - ], - ], - [ - 'name' => 'DistrictId', - 'in' => 'formData', - 'schema' => [ - 'title' => '大区 id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'huadong', - ], + 'schema' => ['description' => 'Page number. '."\n" + ."\n" + .'Starting value: 1. Default Value: 1. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '0', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'title' => '一页大小，默认 20，最大 100', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '20', - 'default' => '20', - ], - ], - [ - 'name' => 'PageNum', - 'in' => 'formData', - 'schema' => [ - 'title' => '第几页，默认从 1 开始', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'Number of data entries per page for paging. '."\n" + .'Valid values: 1 to 9999. '."\n" + .'Default Value: 10. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PopHttpResult<>', - 'description' => '', + 'title' => 'AppVersionListDataFlatPopResult', + 'description' => 'AppVersionListDataFlatPopResult', 'type' => 'object', 'properties' => [ - 'Total' => [ - 'title' => '满足匹配条件的总量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNum' => [ - 'title' => '第几页', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '每页大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'Capacities' => [ - 'title' => '回满足匹配的', - 'description' => '', + 'Versions' => [ + 'description' => 'Version list. ', 'type' => 'array', 'items' => [ + 'description' => 'Version list. ', 'type' => 'object', 'properties' => [ - 'DistrictId' => [ - 'title' => '该容器所属大区 id', - 'description' => '', - 'type' => 'string', - 'example' => 'huadong'."\n", - ], - 'AppId' => [ - 'title' => '创建容器时指定的 appId', - 'description' => '', - 'type' => 'string', - 'example' => '13027****', - ], - 'AppVersion' => [ - 'title' => '创建容器时指定的版本', - 'description' => '', - 'type' => 'string', - 'example' => '35067****', - ], - 'SessionCapacity' => [ - 'title' => '可支撑 session 数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'd9a8****', - ], + 'AppVersionId' => ['description' => 'Application Version ID. ', 'type' => 'string', 'example' => '1432****', 'title' => ''], + 'AppId' => ['description' => 'Application ID to which the application version belongs. ', 'type' => 'string', 'example' => '4384****', 'title' => ''], + 'GmtCreate' => ['description' => 'Creation Time of the application version. ', 'type' => 'string', 'example' => '2022-04-06 02:00:00', 'title' => ''], + 'GmtModified' => ['description' => 'Last Updated At time of the application version. ', 'type' => 'string', 'example' => '2022-04-06 02:00:00', 'title' => ''], + 'AppVersionName' => ['description' => 'Application Version Name. ', 'type' => 'string', 'example' => 'exampleVersion', 'title' => ''], + 'FileUploadType' => ['description' => 'File upload method. Valid values: '."\n" + ."\n" + .'- cloud_file_download: Cloud-based offline download. '."\n" + .'- local_file_upload: Local file upload. ', 'type' => 'string', 'example' => 'cloud_file_download', 'title' => ''], + 'FileAddress' => ['description' => 'File address. ', 'type' => 'string', 'example' => 'https://www.example.com/exampleFile.tar', 'title' => ''], + 'AppVersionStatus' => ['description' => 'Application Version status. Valid values: '."\n" + ."\n" + .'- file_uploading: Uploading. '."\n" + .'- file_upload_fail: Upload failed. '."\n" + .'- file_upload_success: Upload succeeded. '."\n" + .'- app_adapting: Adapting application. '."\n" + .'- app_adapt_fail: Application adaptation failed. '."\n" + .'- app_adapt_success: Application adapted. '."\n" + .'- app_deploy_success: Application deployed. '."\n" + .'- app_deleting: Deleting application. '."\n" + .'- app_deleted: Application deleted. ', 'type' => 'string', 'example' => 'file_uploading', 'title' => ''], + 'AppVersionStatusMemo' => ['description' => 'Status description of the application version, such as the reason for upload failure.', 'type' => 'string', 'example' => '文件大于上限', 'title' => ''], + 'FileSize' => ['description' => 'Application file size. '."\n" + .'Unit: Byte. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''], + 'FileUploadFinishTime' => ['description' => 'Time when the application file upload was completed. ', 'type' => 'string', 'example' => '2022-04-06 02:00:00', 'title' => ''], + 'ConsumeCu' => ['description' => 'CRU consumption per ingest endpoint. ', 'type' => 'number', 'format' => 'double', 'example' => '0.31', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'title' => 'pop的requestId', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], + 'Total' => ['description' => 'Total number of application versions. ', 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''], + 'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 100,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"Capacities\\": [\\n {\\n \\"DistrictId\\": \\"huadong\\\\n\\",\\n \\"AppId\\": \\"13027****\\",\\n \\"AppVersion\\": \\"35067****\\",\\n \\"SessionCapacity\\": 2,\\n \\"ProjectId\\": \\"d9a8****\\"\\n }\\n ],\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', - ], - 'CreateAppSession' => [ - 'summary' => '增加实时生产资源的相关字段', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Versions\\": [\\n {\\n \\"AppVersionId\\": \\"1432****\\",\\n \\"AppId\\": \\"4384****\\",\\n \\"GmtCreate\\": \\"2022-04-06 02:00:00\\",\\n \\"GmtModified\\": \\"2022-04-06 02:00:00\\",\\n \\"AppVersionName\\": \\"exampleVersion\\",\\n \\"FileUploadType\\": \\"cloud_file_download\\",\\n \\"FileAddress\\": \\"https://www.example.com/exampleFile.tar\\",\\n \\"AppVersionStatus\\": \\"file_uploading\\",\\n \\"AppVersionStatusMemo\\": \\"文件大于上限\\",\\n \\"FileSize\\": 1024,\\n \\"FileUploadFinishTime\\": \\"2022-04-06 02:00:00\\",\\n \\"ConsumeCu\\": 0.31\\n }\\n ],\\n \\"Total\\": 16,\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + 'title' => 'Query Application Version List ', + 'changeSet' => [ + ['createdAt' => '2022-06-30T12:58:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-23T08:43:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cgcs:ListAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListInstances' => [ + 'summary' => 'Lists Graphic Computing Service (GCS) instances.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'list', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'title' => '应用ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '13027XXXX', - ], - ], - [ - 'name' => 'AppVersion', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '应用版本', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '35067XXXX', - ], - ], - [ - 'name' => 'CustomUserId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '自定义用户id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2YEF0XXXX', - 'maxLength' => 64, - ], + 'schema' => ['description' => 'The project ID. If not specified, instances from all projects are queried.', 'type' => 'string', 'required' => false, 'example' => '4820372607851300489003', 'title' => ''], ], [ - 'name' => 'CustomSessionId', - 'in' => 'query', - 'schema' => [ - 'title' => '自定义会话id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1ADE0XXXX', - 'maxLength' => 64, - ], - ], - [ - 'name' => 'ClientIp', + 'name' => 'InstanceType', 'in' => 'query', - 'schema' => [ - 'title' => '客户端ip', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.XXX.XXX', - ], + 'schema' => ['description' => 'The instance type of GCS. If not specified, all instance types are included.', 'type' => 'string', 'required' => false, 'example' => 'gcs.r1c1m1.1xlarge', 'title' => ''], ], [ - 'name' => 'StartParameters', + 'name' => 'DistrictId', 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'title' => '启动参数', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => 'key', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'startArgument', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'exampleValue', - 'title' => '', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The district ID. If not specified, all districts are included. Valid values:'."\n" + ."\n" + .'- huadong'."\n" + ."\n" + .'- xinan'."\n" + ."\n" + .'- huanan'."\n" + ."\n" + .'- huabei'."\n" + ."\n" + .'- huazhong', 'type' => 'string', 'required' => false, 'example' => 'huadong', 'title' => ''], ], [ - 'name' => 'SystemInfo', + 'name' => 'InstanceId', 'in' => 'query', - 'style' => 'flat', + 'allowEmptyValue' => false, + 'style' => 'repeatList', 'schema' => [ - 'title' => '系统信息：如端侧机型等信息', - 'description' => '', + 'description' => 'The list of GCS instance IDs to query. If not specified, all instance IDs are included.', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'utdid', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OE0usD+APXXXX', - ], - ], - 'required' => false, - ], + 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'gcs-bmt0kbn7e013aedg9', 'title' => ''], 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Timeout', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1800', - ], - ], - [ - 'name' => 'EnablePostpaid', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'The token returned from the previous query. Leave empty for the first query.', 'type' => 'string', 'required' => false, 'example' => 'BEXZPF01W23U46598WVf', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '项目ID。如果已将应用关联到项目，创建会话时需填写正确的项目ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'd9a8****', - ], + 'schema' => ['description' => 'The maximum number of results. Valid values: 1 to 200. Default: 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'AdapterFileId', - 'in' => 'query', - 'schema' => [ - 'description' => '适配文件ID。此功能灰度开放，如未约定使用请勿传入。', - 'type' => 'string', - 'required' => false, - 'example' => '501716211209548966XXXX', - ], - ], - [ - 'name' => 'DistrictId', + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The status of GCS instances. Valid values:'."\n" + ."\n" + .'- CREATING: Creating'."\n" + ."\n" + .'- RUNNING: during instance runtime'."\n" + ."\n" + .'- OPERATING: O\\&M'."\n" + ."\n" + .'- DELETING: Deleting'."\n" + ."\n" + .'- MIGRATING: instance migration', 'type' => 'string', + 'enum' => ['CREATING', 'RUNNING', 'OPERATING', 'DELETING', 'MIGRATING'], 'required' => false, - 'example' => 'huadong', + 'example' => 'CREATING', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], - 'CustomSessionId' => [ - 'title' => '自定义会话id', - 'description' => '', - 'type' => 'string', - 'example' => '1ADE0XXXX', - ], - 'PlatformSessionId' => [ - 'title' => '平台会话id', - 'description' => '', - 'type' => 'string', - 'example' => '100XXXX', - ], - 'AppId' => [ - 'title' => '应用id', - 'description' => '', - 'type' => 'string', - 'example' => '13027XXXX', - ], - 'AppVersion' => [ - 'title' => '应用版本', - 'description' => '', - 'type' => 'string', - 'example' => '35067XXXX', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'], + 'Instances' => [ + 'description' => 'The list of GCS instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'Instance details.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'gcs-bmt0kbn7e013aedg9', 'title' => ''], + 'InstanceType' => ['description' => 'The GCS instance type.', 'type' => 'string', 'example' => 'gcs.r1c1m1.1xlarge', 'title' => ''], + 'DistrictId' => ['description' => 'The district ID. Valid values:'."\n" + ."\n" + .'- huadong'."\n" + ."\n" + .'- xinan'."\n" + ."\n" + .'- huanan'."\n" + ."\n" + .'- huabei'."\n" + ."\n" + .'- huazhong', 'type' => 'string', 'example' => 'huadong', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => '4820372607851300489003', 'title' => ''], + 'Status' => ['description' => 'The status of GCS instances. Valid values:'."\n" + ."\n" + .'- CREATING: Creating'."\n" + ."\n" + .'- RUNNING: during instance runtime'."\n" + ."\n" + .'- OPERATING: O\\&M'."\n" + ."\n" + .'- DELETING: Deleting'."\n" + ."\n" + .'- MIGRATING: instance migration', 'type' => 'string', 'example' => 'CREATING', 'title' => ''], + 'CreationTime' => ['description' => 'The creation time in [ISO 8601](~~25696~~) format using UTC+0. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'example' => '2023-12-13T11:12:11Z', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'NextToken' => ['description' => 'The pagination token. Use the NextToken value returned by the previous API call.', 'type' => 'string', 'example' => 'BEXZPF01W23U46598WVf', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of records returned in this request.', 'type' => 'string', 'example' => '50', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"CustomSessionId\\": \\"1ADE0XXXX\\",\\n \\"PlatformSessionId\\": \\"100XXXX\\",\\n \\"AppId\\": \\"13027XXXX\\",\\n \\"AppVersion\\": \\"35067XXXX\\"\\n}","type":"json"}]', - ], - 'StopAppSession' => [ - 'summary' => '停止App会话', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidNextToken', 'errorMessage' => 'invalid nextToken.', 'description' => 'Invalid token'], + ['errorCode' => 'InvalidArgs', 'errorMessage' => 'invalid status.', 'description' => 'Invalid parameter state'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"gcs-bmt0kbn7e013aedg9\\",\\n \\"InstanceType\\": \\"gcs.r1c1m1.1xlarge\\",\\n \\"DistrictId\\": \\"huadong\\",\\n \\"ProjectId\\": \\"4820372607851300489003\\",\\n \\"Status\\": \\"CREATING\\",\\n \\"CreationTime\\": \\"2023-12-13T11:12:11Z\\"\\n }\\n ],\\n \\"NextToken\\": \\"BEXZPF01W23U46598WVf\\",\\n \\"MaxResults\\": \\"50\\"\\n}","type":"json"}]', + 'title' => 'Query the list of cloud rendering instances', + 'responseParamsDescription' => '### Sample response'."\n" + ."\n" + .'Successful response in JSON format'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "Instances": ['."\n" + .' {'."\n" + .' "Status": "RUNNING",'."\n" + .' "InstanceId": "gcs-bmt0kbn7e013aedg8",'."\n" + .' "DistrictId": "huadong",'."\n" + .' "ProjectId": "4820372607851300489003",'."\n" + .' "CreationTime": "2023-12-13T11:12:11Z",'."\n" + .' "InstanceType": "gcs.r1c1m1.1xlarge"'."\n" + .' },'."\n" + .' {'."\n" + .' "Status": "RUNNING",'."\n" + .' "InstanceId": "gcs-bmt0kbn7e013aedg9",'."\n" + .' "DistrictId": "huadong",'."\n" + .' "ProjectId": "4820372607851300489003",'."\n" + .' "CreationTime": "2023-12-13T11:12:11Z",'."\n" + .' "InstanceType": "gcs.r1c1m1.1xlarge"'."\n" + .' }'."\n" + .' ],'."\n" + .' "RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986",'."\n" + .' "NextToken": "BEXZPF01W23U46598WVf",'."\n" + .' "MaxResults": 200'."\n" + .'}'."\n" + .'```', + 'changeSet' => [ + ['createdAt' => '2024-08-28T05:38:36.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cgcs:ListInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ModifyApp' => [ + 'summary' => 'Modify the name of an application.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'update', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'PlatformSessionId', - 'in' => 'query', - 'schema' => [ - 'title' => '自定义用户id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '100XXXX', - ], - ], - [ - 'name' => 'CustomSessionId', - 'in' => 'query', - 'schema' => [ - 'title' => '自定义会话id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1ADE0XXXX', - ], + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => '4384****', 'title' => ''], ], [ - 'name' => 'StopParam', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '停止容器参数。此参数将透传到Agent。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '目前支持的枚举值包括：'."\n" - .'- reason：停止原因。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'reason', - ], - 'Value' => [ - 'description' => 'key对应的取值。', - 'type' => 'any', - 'required' => false, - 'example' => 'exampleValue', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'The application Name.'."\n" + ."\n" + .'Supports Unicode characters, with a maximum of 64 characters.', 'type' => 'string', 'required' => true, 'example' => 'example', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'AppIdDataFlatPopResult', + 'description' => 'AppIdDataFlatPopResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], - 'CustomSessionId' => [ - 'title' => '自定义会话id', - 'description' => '', - 'type' => 'string', - 'example' => '1ADE0XXXX', - ], - 'PlatformSessionId' => [ - 'title' => '平台会话id', - 'description' => '', - 'type' => 'string', - 'example' => '100XXXX', - ], - 'AppId' => [ - 'title' => '应用id', - 'description' => '', - 'type' => 'string', - 'example' => '13027XXXX', - ], - 'AppVersion' => [ - 'title' => '应用版本', - 'description' => '', - 'type' => 'string', - 'example' => '35067XXXX', - ], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => '4384****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"CustomSessionId\\": \\"1ADE0XXXX\\",\\n \\"PlatformSessionId\\": \\"100XXXX\\",\\n \\"AppId\\": \\"13027XXXX\\",\\n \\"AppVersion\\": \\"35067XXXX\\"\\n}","type":"json"}]', - ], - 'GetAppSession' => [ - 'summary' => '获取App会话信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppId\\": \\"4384****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + 'title' => 'Modify application information', + 'changeSet' => [ + ['createdAt' => '2022-06-30T12:58:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-23T08:43:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cgcs:ModifyApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ModifyAppVersion' => [ + 'summary' => 'Modify the version information of an application.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'list', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'PlatformSessionId', - 'in' => 'query', - 'schema' => [ - 'title' => '平台会话id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '100XXXX', - ], + 'name' => 'AppVersionId', + 'in' => 'formData', + 'schema' => ['description' => 'Application Version ID.', 'type' => 'string', 'required' => true, 'example' => '1432****', 'title' => ''], ], [ - 'name' => 'CustomSessionId', - 'in' => 'query', - 'schema' => [ - 'title' => '自定义会话id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1ADE0XXXX', - ], + 'name' => 'AppVersionName', + 'in' => 'formData', + 'schema' => ['description' => 'Application Version Name.'."\n" + ."\n" + .'Supports Unicode characters, with a maximum of 32 characters.', 'type' => 'string', 'required' => true, 'example' => 'exampleVersion', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'AppVersionIdDataFlatPopResult', + 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], - 'CustomSessionId' => [ - 'title' => '自定义会话id', - 'description' => '', - 'type' => 'string', - 'example' => '1ADE0XXXX', - ], - 'PlatformSessionId' => [ - 'title' => '平台会话id', - 'description' => '', - 'type' => 'string', - 'example' => '100XXXX', - ], - 'AppId' => [ - 'title' => '应用id', - 'description' => '', - 'type' => 'string', - 'example' => '13027XXXX', - ], - 'AppVersion' => [ - 'title' => '应用版本', - 'description' => '', - 'type' => 'string', - 'example' => '35067XXXX', - ], - 'Status' => [ - 'title' => '状态', - 'description' => '', - 'type' => 'string', - 'example' => 'running', - ], - 'BizInfo' => [ - 'description' => '业务特定的信息，如会话启动/停止时间。', - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'description' => '会话启动时间', - 'type' => 'string', - 'example' => '2022-07-20 17:58:51', - ], - 'StopTime' => [ - 'description' => '会话停止时间', - 'type' => 'string', - 'example' => '2022-07-20 17:58:57', - ], - ], - ], + 'AppVersionId' => ['description' => 'Application Version ID.', 'type' => 'string', 'example' => '1432****', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"CustomSessionId\\": \\"1ADE0XXXX\\",\\n \\"PlatformSessionId\\": \\"100XXXX\\",\\n \\"AppId\\": \\"13027XXXX\\",\\n \\"AppVersion\\": \\"35067XXXX\\",\\n \\"Status\\": \\"running\\",\\n \\"BizInfo\\": {\\n \\"StartTime\\": \\"2022-07-20 17:58:51\\",\\n \\"StopTime\\": \\"2022-07-20 17:58:57\\"\\n }\\n}","type":"json"}]', - ], - 'ListAppSessions' => [ - 'summary' => '查询App会话', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppVersionId\\": \\"1432****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + 'title' => 'Modify Version Information', + 'changeSet' => [ + ['createdAt' => '2022-06-30T12:58:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-23T08:43:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cgcs:ModifyAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ReleaseCapacity' => [ + 'summary' => 'Release the reserved container. The container is released only when all specified conditions are met simultaneously. The release result is returned through an HTTP API.'."\n", + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'delete', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'PlatformSessionIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '自定义用户id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '100XXXX', - ], - 'required' => false, - 'docRequired' => false, - 'maxItems' => 50, - ], - ], - [ - 'name' => 'CustomSessionIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '自定义会话id', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1ADE0XXXX', - ], - 'required' => false, - 'maxItems' => 50, - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The project ID. ', 'type' => 'string', 'required' => true, 'example' => 'd9a8****'], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '分页大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'default' => '10', - ], + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => ['title' => 'app id', 'description' => 'The application ID. ', 'type' => 'string', 'required' => true, 'example' => '13027****'], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'name' => 'DistrictId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The area ID. Valid values: '."\n" + ."\n" + .'- huadong '."\n" + ."\n" + .'- xinan '."\n" + ."\n" + .'- huanan '."\n" + ."\n" + .'- huabei '."\n" + ."\n" + .'- huazhong '."\n", 'type' => 'string', 'required' => true, 'example' => 'huadong'], ], [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13027XXXX', - ], + 'name' => 'ExpectReleaseSessionCapacity', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The expected number of ingest endpoints of sessions to release. ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100'], ], [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd9a8****', - ], + 'name' => 'AppVersion', + 'in' => 'formData', + 'schema' => ['description' => 'The version ID. ', 'type' => 'string', 'required' => false, 'example' => '35067****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'PopHttpResult<>', + 'description' => 'Response parameters. ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], - 'AppSessions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CustomSessionId' => [ - 'title' => '自定义会话id', - 'description' => '', - 'type' => 'string', - 'example' => '1ADE0XXXX', - ], - 'PlatformSessionId' => [ - 'title' => '平台会话id', - 'description' => '', - 'type' => 'string', - 'example' => '100XXXX ', - ], - 'AppId' => [ - 'title' => '应用id', - 'description' => '', - 'type' => 'string', - 'example' => '13027XXXX', - ], - 'AppVersion' => [ - 'title' => '应用版本', - 'description' => '', - 'type' => 'string', - 'example' => '35067XXXX', - ], - 'Status' => [ - 'title' => '状态', - 'description' => '', - 'type' => 'string', - 'example' => 'running', - ], - 'BizInfo' => [ - 'description' => '业务特定的信息，如会话启动/停止时间。', - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'description' => '会话启动时间', - 'type' => 'string', - 'example' => '2022-07-20 17:58:51', - ], - 'StopTime' => [ - 'description' => '会话停止时间', - 'type' => 'string', - 'example' => '2022-07-20 17:58:57', - ], - ], - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'd9a8****'."\n", - ], - ], - ], - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], + 'TaskId' => ['title' => '', 'description' => 'The ID of the container reservation job. ', 'type' => 'string', 'example' => 'b354****'], + 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"AppSessions\\": [\\n {\\n \\"CustomSessionId\\": \\"1ADE0XXXX\\",\\n \\"PlatformSessionId\\": \\"100XXXX \\",\\n \\"AppId\\": \\"13027XXXX\\",\\n \\"AppVersion\\": \\"35067XXXX\\",\\n \\"Status\\": \\"running\\",\\n \\"BizInfo\\": {\\n \\"StartTime\\": \\"2022-07-20 17:58:51\\",\\n \\"StopTime\\": \\"2022-07-20 17:58:57\\"\\n },\\n \\"ProjectId\\": \\"d9a8****\\\\n\\"\\n }\\n ],\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100\\n}","type":"json"}]', - ], - 'CreateAppSessionSync' => [ - 'summary' => '同步创建会话', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"b354****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + 'title' => 'Release Reserved Container '."\n", + 'description' => 'The operation to release a reserved container is atomic, meaning there is no scenario of partial success or partial failure.'."\n" + ."\n" + .'When the release job succeeds, the HTTP API sends a notification message as follows: '."\n" + .'> The HTTP API is a method for receiving notifications about session start, stop, streaming, and other events. Currently, messages are retained for 1 Day, and the retry policy is a backoff strategy with up to 176 retries.'."\n" + ."\n" + .'The event type is `RELEASE_CAPACITY_RESULT`. '."\n" + .'><notice>Pattern is not distinguished; notifications are pushed only via the HTTP API.></notice> '."\n" + .'| Name | Type | Required | Description |'."\n" + .'| ------ | ------ |----|------ |'."\n" + .'| success | Boolean | Yes | Indicates whether the job succeeded.<br> Valid values:<br>true: The job succeeded.<br>false: The job failed. |'."\n" + .'| eventType | String | Yes | The event type. |'."\n" + .'| eventDetail | Object[EventDetail] | Yes | The event details.<br>This parameter is returned only when the job succeeds. |'."\n" + ."\n" + .'The data structure of EventDetail is as follows. '."\n" + .'| Name | Type | Required | Description |'."\n" + .'| ------ | ------ |----|------ |'."\n" + .'| taskId | String | Yes | The ID of the asynchronous container release job. |'."\n" + .'| success | Boolean | Yes | Indicates whether the release succeeded.<br> Valid values:<br>true: The release succeeded.<br>false: The release failed. |'."\n" + .'| expectReleaseSessionCapacity | Integer | Yes | The expected number of ingest endpoints of sessions to release. |'."\n", + 'changeSet' => [ + ['createdAt' => '2022-07-19T07:28:22.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cgcs:ReleaseCapacity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ReleaseCapacityByBatch' => [ + 'summary' => 'Release the machines in the specified batch. This is typically performed when the dry run fails, to release the machines in the specified batch. The release result is returned via a message.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'delete', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'query', + 'name' => 'ResBatchId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The resource batch ID returned during reservation.', 'type' => 'string', 'required' => true, 'example' => '726573XXXX'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '应用ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '13027****', + 'title' => 'PopHttpResult<>', + 'description' => 'Response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'."\n"], + ], + 'example' => '', ], ], - [ - 'name' => 'AppVersion', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '应用版本', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '35067****', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\\\n\\"\\n}","type":"json"}]', + 'title' => 'Release resources by batch ID', + 'description' => 'When the release job succeeds, the following message notification is sent:'."\n" + .'| Name | Type | Required | Description |'."\n" + .'| ------ | ------ | ------ | ------ |'."\n" + .'| resBatchId | String | Yes | The asynchronous container release job ID. |'."\n" + .'| success | Boolean | Yes | Indicates whether the release succeeded.<br> Valid values:<br>true: The release succeeded.<br>false: The release failed. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseCapacityByBatch'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cgcs:ReleaseCapacityByBatch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ReleaseInstances' => [ + 'summary' => 'Release Graphic Computing Service (GCS) instances.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'CustomUserId', - 'in' => 'query', - 'schema' => [ - 'title' => '自定义用户id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2YEF0****', - 'maxLength' => 64, - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'autoTest' => false], + 'parameters' => [ [ - 'name' => 'CustomSessionId', - 'in' => 'query', - 'schema' => [ - 'title' => '自定义会话id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1ADE0****', - 'maxLength' => 64, - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'Project ID.', 'type' => 'string', 'required' => true, 'example' => '4820372607851300489003', 'title' => ''], ], [ - 'name' => 'ClientIp', - 'in' => 'query', + 'name' => 'InstanceType', + 'in' => 'formData', + 'schema' => ['description' => 'The GCS instance type.', 'type' => 'string', 'required' => true, 'example' => 'gcs.r1c1m1.1xlarge', 'title' => ''], + ], + [ + 'name' => 'DistrictId', + 'in' => 'formData', 'schema' => [ - 'title' => '客户端ip', - 'description' => '', + 'description' => 'Region ID. Valid values:'."\n" + ."\n" + .'- East China'."\n" + ."\n" + .'- Southwest China'."\n" + ."\n" + .'- South China'."\n" + ."\n" + .'- North China'."\n" + ."\n" + .'- Central China', + 'enumValueTitles' => ['huanan' => 'South China', 'huabei' => 'North China', 'xinan' => 'Southwest China', 'huazhong' => 'Central China', 'huadong' => 'East China'], 'type' => 'string', - 'required' => false, - 'example' => '192.168.XX.XX', + 'required' => true, + 'example' => 'huadong', + 'title' => '', ], ], [ - 'name' => 'StartParameters', - 'in' => 'query', - 'style' => 'flat', + 'name' => 'Amount', + 'in' => 'formData', + 'schema' => ['description' => 'The number of Graphic Computing Service instances to release. Value range: 1 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '启动参数', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => 'key', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'startArgument', - ], - 'Value' => [ - 'title' => 'value', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'exampleValue', - ], + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'], + 'InstanceIds' => [ + 'description' => 'A list of Graphic Computing Service instance IDs successfully released.', + 'type' => 'array', + 'items' => ['description' => 'Instance ID', 'type' => 'string', 'example' => 'gcs-bmt0kbn7e013aedg9', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => false, + 'example' => '', ], ], - [ - 'name' => 'SystemInfo', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'title' => '系统信息：如端侧机型等信息', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'utdid', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OE0usD+AP****', - ], - ], - 'required' => false, + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidArgs', 'errorMessage' => 'Invalid Args.', 'description' => 'Parameter error'], + ['errorCode' => 'UnsupportedInstanceType', 'errorMessage' => 'unsupported instance type.', 'description' => 'Instance type not supported'], + ['errorCode' => 'InstanceAmountNotMatch', 'errorMessage' => 'release instance amount exceed tenant instance total count.', 'description' => 'The number of released instances is greater than the total number of tenant instances'], + ['errorCode' => 'TooFrequent', 'errorMessage' => 'release instance too frequent.', 'description' => 'Repeat request'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"InstanceIds\\": [\\n \\"gcs-bmt0kbn7e013aedg9\\"\\n ]\\n}","type":"json"}]', + 'title' => 'Unsubscribe from Graphic Computing Service instances', + 'responseParamsDescription' => '### Response Example'."\n" + ."\n" + .'Normal response example in JSON format'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986",'."\n" + .' "InstanceIds": ["gcs-bdbdgetn7e013aedg9", "gcs-xdg0kdbn7e013aedg9"]'."\n" + .'}'."\n" + .'```', + 'changeSet' => [ + ['createdAt' => '2024-08-28T05:38:36.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cgcs:ReleaseInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], + ], + ], + 'ReserveInstances' => [ + 'summary' => 'Reserves Graphic Computing Service (GCS) instances.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Tags', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'exampleTag', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'exampleValue', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'autoTest' => false], + 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd9a8****', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => '5469588382860444937003', 'title' => ''], + ], + [ + 'name' => 'InstanceType', + 'in' => 'formData', + 'schema' => ['description' => 'The instance type of the GCS instance.', 'type' => 'string', 'required' => true, 'example' => 'gcs.r1c1m1.1xlarge', 'title' => ''], ], [ 'name' => 'DistrictId', - 'in' => 'query', + 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'The district ID. Valid values:'."\n" + ."\n" + .'- huadong'."\n" + ."\n" + .'- xinan'."\n" + ."\n" + .'- huanan'."\n" + ."\n" + .'- huabei'."\n" + ."\n" + .'- huazhong', + 'enumValueTitles' => ['huanan' => 'huanan', 'huabei' => 'huabei', 'xinan' => 'xinan', 'huazhong' => 'huazhong', 'huadong' => 'huadong'], 'type' => 'string', - 'required' => false, + 'required' => true, 'example' => 'huadong', + 'title' => '', ], ], [ - 'name' => 'MatchRules', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'in', - ], - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'component', - ], - 'Values' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'exampleTag', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'AdapterFileId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '501716211209548966XXXX', - ], + 'name' => 'Amount', + 'in' => 'formData', + 'schema' => ['description' => 'The number of GCS instances to reserve. The value must be between 1 and 500.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], - 'CustomSessionId' => [ - 'title' => '自定义会话id', - 'description' => '', - 'type' => 'string', - 'example' => '1ADE0****', - ], - 'PlatformSessionId' => [ - 'title' => '平台会话id', - 'description' => '', - 'type' => 'string', - 'example' => '100****', - ], - 'AppId' => [ - 'title' => '应用id', - 'description' => '', - 'type' => 'string', - 'example' => '13027****', - ], - 'AppVersion' => [ - 'title' => '应用版本', - 'description' => '', - 'type' => 'string', - 'example' => '35067****', - ], - 'BizInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Biz' => [ - 'description' => '', - 'type' => 'object', - 'example' => 'authToken', - ], - 'Endpoints' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'exampleName', - ], - 'AccessHost' => [ - 'description' => '', - 'type' => 'string', - 'example' => '127.0.X.X', - ], - 'AccessPort' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8080', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Native', - ], - 'DistrictId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'huabei', - ], - 'Isp' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BGP', - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'], + 'InstanceIds' => [ + 'description' => 'A list of IDs of the successfully reserved GCS instances.', + 'type' => 'array', + 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'gcs-bmt0kbn7e013aedg9', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"CustomSessionId\\": \\"1ADE0****\\",\\n \\"PlatformSessionId\\": \\"100****\\",\\n \\"AppId\\": \\"13027****\\",\\n \\"AppVersion\\": \\"35067****\\",\\n \\"BizInfo\\": {\\n \\"Biz\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Endpoints\\": [\\n {\\n \\"Name\\": \\"exampleName\\",\\n \\"AccessHost\\": \\"127.0.X.X\\",\\n \\"AccessPort\\": \\"8080\\",\\n \\"Type\\": \\"Native\\",\\n \\"DistrictId\\": \\"huabei\\",\\n \\"Isp\\": \\"BGP\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'CreateAppSessionBatchSync' => [ - 'summary' => '同步批量创建多个会话', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidArgs', 'errorMessage' => 'Invalid Args.', 'description' => 'Parameter error'], + ['errorCode' => 'InternalError', 'errorMessage' => 'failed to get project info.', 'description' => 'Failed to obtain project information'], + ['errorCode' => 'NotFoundProject', 'errorMessage' => 'project not exist.', 'description' => 'Item not found'], + ['errorCode' => 'UnsupportedDistrict', 'errorMessage' => 'not found any region for district.', 'description' => 'Region does not exist'], + ['errorCode' => 'NotFoundImage', 'errorMessage' => 'not found tenant image.', 'description' => 'Mirror does not exist'], + ['errorCode' => 'VmStockNotEnough', 'errorMessage' => 'no stock.', 'description' => 'No inventory'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"InstanceIds\\": [\\n \\"gcs-bmt0kbn7e013aedg9\\"\\n ]\\n}","type":"json"}]', + 'title' => 'Reserve Graphic Computing Service instances ', + 'changeSet' => [ + ['createdAt' => '2024-08-28T05:38:36.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cgcs:ReserveInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'StopAppSession' => [ + 'summary' => 'Stop an application session. The result of the stop operation will be returned through a message.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'update', 'autoTest' => false], 'parameters' => [ [ - 'name' => 'BatchId', + 'name' => 'PlatformSessionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '6d4d****', - 'maxLength' => 64, - 'minLength' => 1, - ], + 'schema' => ['title' => '', 'description' => 'Platform session ID, which uniquely identifies a session on the platform.'."\n" + ."\n" + .'Note: PlatformSessionId and CustomSessionId are mutually exclusive. If both parameters are set, PlatformSessionId takes precedence. ', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '100XXXX'], ], [ - 'name' => 'AppInfos', + 'name' => 'CustomSessionId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Custom session ID.'."\n" + ."\n" + .'Note: PlatformSessionId and CustomSessionId are mutually exclusive. If both parameters are set, PlatformSessionId takes precedence. ', 'type' => 'string', 'required' => false, 'example' => '1ADE0XXXX'], + ], + [ + 'name' => 'StopParam', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => '停止容器参数。此参数将透传到Agent。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'CustomerSessionId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1ADE0****', - 'maxLength' => 64, - 'minLength' => 1, - ], - 'CustomUserId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2YEF0****', - ], - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '13027****', - 'maxLength' => 64, - 'minLength' => 1, - ], - 'AppVersion' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '35067****', - ], - 'ClientIp' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.XX.XX', - ], - 'SystemInfo' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'utdid', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'OE0usD+AP****', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'StartParameters' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'startArgument', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'exampleValue', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'Tags' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'exampleTag', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'exampleValue', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd9a8****', - ], - 'DistrictId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'huadong', - ], - 'MatchRules' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'in', - ], - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'component', - ], - 'Values' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'exampleTag', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'AdapterFileId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '501716211209548966XXXX', - ], + 'Key' => ['description' => '目前支持的枚举值包括：'."\n" + .'- reason：停止原因。'."\n", 'type' => 'string', 'required' => false, 'example' => 'reason', 'title' => ''], + 'Value' => ['description' => 'key对应的取值。', 'type' => 'any', 'required' => false, 'example' => 'exampleValue', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - 'required' => true, - 'docRequired' => true, - 'maxItems' => 50, - 'minItems' => 1, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], - 'BatchId' => [ - 'title' => '自定义会话id', - 'description' => '', - 'type' => 'string', - 'example' => '6d4d****', - ], - 'ResultList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CustomSessionId' => [ - 'title' => '自定义会话id', - 'description' => '', - 'type' => 'string', - 'example' => '1ADE0****', - ], - 'PlatformSessionId' => [ - 'title' => '平台会话id', - 'description' => '', - 'type' => 'string', - 'example' => '100****', - ], - 'AppId' => [ - 'title' => '应用id', - 'description' => '', - 'type' => 'string', - 'example' => '13027****', - ], - 'AppVersion' => [ - 'title' => '应用版本', - 'description' => '', - 'type' => 'string', - 'example' => '35067****', - ], - 'BizInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Biz' => [ - 'description' => '', - 'type' => 'object', - 'example' => 'authToken', - ], - 'Endpoints' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'exampleName', - ], - 'AccessHost' => [ - 'description' => '', - 'type' => 'string', - 'example' => '127.0.X.X', - ], - 'AccessPort' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8080', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Native', - ], - 'DistrictId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'huadong', - ], - 'Isp' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'bgp', - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'FailedList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CustomSessionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1ADE0****', - ], - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100****', - ], - 'FailedInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => '400', - ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'App type not support.', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'], + 'CustomSessionId' => ['title' => '', 'description' => 'Custom session ID.', 'type' => 'string', 'example' => '1ADE0XXXX'], + 'PlatformSessionId' => ['title' => '', 'description' => 'Platform session ID.', 'type' => 'string', 'example' => '100XXXX'], + 'AppId' => ['title' => '', 'description' => 'Application ID.', 'type' => 'string', 'example' => '13027XXXX'], + 'AppVersion' => ['title' => '', 'description' => 'Application Version ID.', 'type' => 'string', 'example' => '35067XXXX'], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"CustomSessionId\\": \\"1ADE0XXXX\\",\\n \\"PlatformSessionId\\": \\"100XXXX\\",\\n \\"AppId\\": \\"13027XXXX\\",\\n \\"AppVersion\\": \\"35067XXXX\\"\\n}","type":"json"}]', + 'title' => 'Stop Application Session', + 'description' => 'This message is sent to notify that the application has been stopped due to reasons such as an initiated stop request, the program actively stopping, or a program crash.'."\n" + ."\n" + .'The event type is `APP_STOP`. '."\n" + .'><notice>Applies only to API integration mode and not to H5 SDK integration mode.></notice>'."\n" + ."\n" + .'|Name|Type|Required|Description|'."\n" + .'| ------ | ------ | ------ |------ |'."\n" + .'|success|Boolean|Yes|Indicates whether the stop operation succeeded.<br>Possible values:<br>true: The stop operation succeeded.<br>false: The stop operation failed.|'."\n" + .'|eventType|String|Yes|Event type.|'."\n" + .'|customSessionId|String|Yes|Custom session ID.|'."\n" + .'|platformSessionId|String|Yes|Platform session ID.|'."\n" + .'|normal|Boolean|Yes|Indicates whether the application stopped normally.<br>Possible values:<br>true: Normal stop.<br>false: Abnormal stop.|'."\n" + .'|eventDetail|Object[EventDetail]|No|Event details, returned when the operation succeeds.|'."\n" + .'|errorMessage|Object|No|Error details, returned when the operation fails.|'."\n" + ."\n" + .'The EventDetail data structure is as follows:'."\n" + .'|Name|Type|Required|Description|'."\n" + .'|------|------|------|------|'."\n" + .'|appId|String|Yes|Application ID.|'."\n" + .'|appVersion|String|Yes|Application Version ID.|'."\n" + ."\n" + .'The ErrorMessage data structure is as follows:'."\n" + .'|Name|Type|Required|Description|'."\n" + .'|------|------|------|------|'."\n" + .'|code|String|Yes|Error code.|'."\n" + .'|msg|String|Yes|Error Details.|', + 'changeSet' => [ + ['createdAt' => '2022-03-03T09:19:30.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopAppSession'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cgcs:StopAppSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"BatchId\\": \\"6d4d****\\",\\n \\"ResultList\\": [\\n {\\n \\"CustomSessionId\\": \\"1ADE0****\\",\\n \\"PlatformSessionId\\": \\"100****\\",\\n \\"AppId\\": \\"13027****\\",\\n \\"AppVersion\\": \\"35067****\\",\\n \\"BizInfo\\": {\\n \\"Biz\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Endpoints\\": [\\n {\\n \\"Name\\": \\"exampleName\\",\\n \\"AccessHost\\": \\"127.0.X.X\\",\\n \\"AccessPort\\": \\"8080\\",\\n \\"Type\\": \\"Native\\",\\n \\"DistrictId\\": \\"huadong\\",\\n \\"Isp\\": \\"bgp\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"FailedList\\": [\\n {\\n \\"CustomSessionId\\": \\"1ADE0****\\",\\n \\"AppId\\": \\"100****\\",\\n \\"FailedInfo\\": {\\n \\"ErrorMessage\\": \\"400\\",\\n \\"ErrorCode\\": \\"App type not support.\\"\\n }\\n }\\n ]\\n}","type":"json"}]', ], 'StopAppSessionBatch' => [ - 'summary' => '批量停止会话接口', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Batch stop application sessions. The subsequent stop results are returned through an HTTP API.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3777,80 +3511,50 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'autoTest' => false, - ], + 'systemTags' => ['operationType' => 'update', 'autoTest' => false], 'parameters' => [ [ 'name' => 'BatchId', 'in' => 'query', - 'schema' => [ - 'title' => '自定义用户id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => '6d4d****', - ], + 'schema' => ['title' => '', 'description' => 'Batch operation ID. '."\n" + .'> Supports ASCII characters and cannot exceed 64 characters.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '6d4d****'], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '自定义会话id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd9a8****', - ], + 'schema' => ['title' => '', 'description' => 'Project ID.', 'type' => 'string', 'required' => false, 'example' => 'd9a8****'], ], [ 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13027****', - ], + 'schema' => ['description' => 'Application ID.', 'type' => 'string', 'required' => false, 'example' => '13027****', 'title' => ''], ], [ 'name' => 'AppVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '35067****', - ], + 'schema' => ['description' => 'Application Version ID.', 'type' => 'string', 'required' => false, 'example' => '35067****', 'title' => ''], ], [ 'name' => 'Tags', 'in' => 'query', 'style' => 'flat', 'schema' => [ - 'description' => '', + 'description' => 'Custom tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'exampleTag', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'exampleValue', - ], + 'Key' => ['description' => 'Tag key. Maximum length is 64 characters.', 'type' => 'string', 'required' => false, 'example' => 'exampleTag', 'title' => ''], + 'Value' => ['description' => 'Value corresponding to the key.', 'type' => 'string', 'required' => false, 'example' => 'exampleValue', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ @@ -3858,270 +3562,780 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Stop container parameters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'reason', - ], - 'Value' => [ - 'description' => '', - 'type' => 'any', - 'required' => false, - 'example' => 'exampleValue', - ], + 'Key' => ['description' => 'Currently supported enumeration values. When the value is "reason", it indicates the stop reason.', 'type' => 'string', 'required' => false, 'example' => 'reason', 'title' => ''], + 'Value' => ['description' => 'Value corresponding to the key.', 'type' => 'any', 'required' => false, 'example' => 'exampleValue', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'Response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], - 'BatchId' => [ - 'title' => '自定义会话id', - 'description' => '', - 'type' => 'string', - 'example' => '6d4d****', - ], - 'ProjectId' => [ - 'title' => '平台会话id', - 'description' => '', - 'type' => 'string', - 'example' => 'd9a8****', - ], - 'AppId' => [ - 'title' => '应用id', - 'description' => '', - 'type' => 'string', - 'example' => '13027****', - ], + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'], + 'BatchId' => ['title' => '', 'description' => 'Batch Operations ID.', 'type' => 'string', 'example' => '6d4d****'], + 'ProjectId' => ['title' => '', 'description' => 'Project ID.', 'type' => 'string', 'example' => 'd9a8****'], + 'AppId' => ['title' => '', 'description' => 'Application ID.', 'type' => 'string', 'example' => '13027****'], ], + 'title' => '', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"BatchId\\": \\"6d4d****\\",\\n \\"ProjectId\\": \\"d9a8****\\",\\n \\"AppId\\": \\"13027****\\"\\n}","type":"json"}]', + 'title' => 'Batch Stop Application Sessions', + 'description' => 'After initiating a batch stop, the progress of the batch stop is returned through an HTTP API until the number of online sessions becomes 0 or a timeout occurs. '."\n" + .'> The HTTP API is a method for receiving information such as session start, stop, and streaming. Currently, messages are retained for 1 Day, and the retry policy is backoff retry, with a maximum of 176 retries.'."\n" + ."\n" + .'The event type is **BATCH_STOP**. '."\n" + .'><notice>Regardless of the integration pattern, only the HTTP API is used for push.></notice> '."\n" + ."\n" + .'| Name | Type | Required | Description |'."\n" + .'| ------ | ------ | ------ |------ |'."\n" + .'| eventType | String | Yes | Event type. |'."\n" + .'| eventDetail | Object[EventDetail] | Yes | Event details.<br>This parameter is returned when the job succeeds. |'."\n" + ."\n" + .'The EventDetail data structure is as follows. '."\n" + .'| Name | Type | Required | Description |'."\n" + .'|------|------|------|------|'."\n" + .'| appId | String | Yes | Application ID. |'."\n" + .'| appVersion | String | Yes | Application Version ID. |'."\n" + .'| batchId | String | Yes | Batch ID. |'."\n" + .'| projectId | String | Yes | Project ID. |'."\n" + .'| playersCount | Integer | Yes | Remaining online quantity. |'."\n" + .'| timestamp | String | Yes | Statistics UNIX timestamp. |', + 'changeSet' => [ + ['createdAt' => '2022-07-25T03:00:00.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopAppSessionBatch'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cgcs:StopAppSessionBatch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], - 'GetAppCcu' => [ - 'summary' => '查询会话并发数', - 'methods' => [ - 'get', + ], + 'endpoints' => [ + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cgcs.cn-hangzhou.aliyuncs.com', 'endpoint' => 'cgcs.cn-hangzhou.aliyuncs.com', 'vpc' => 'cgcs-vpc.cn-hangzhou.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'App.NoAdaptation', 'message' => 'The adaptation has not complete , please wait.', 'http_code' => 400, 'description' => ''], + ['code' => 'App.ScheduleFailed', 'message' => 'Schedule failed , please retry.', 'http_code' => 400, 'description' => ''], + ['code' => 'App.Stopping', 'message' => 'The app stopping. try later.', 'http_code' => 400, 'description' => ''], + ['code' => 'App.Type.NotSupport', 'message' => 'session not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'App.version.NotFound', 'message' => 'Schedule failed , please retry.', 'http_code' => 400, 'description' => ''], + ['code' => 'CU.NotEnough', 'message' => 'The cu is not enough.', 'http_code' => 500, 'description' => ''], + ['code' => 'Custom.Session.Id.Duplicate', 'message' => 'Custom session id duplicate.', 'http_code' => 400, 'description' => ''], + ['code' => 'Custom.Session.Id.Exist', 'message' => 'Custom session id exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'InstanceAmountNotMatch', 'message' => 'release instance amount exceed tenant instance total count.', 'http_code' => 400, 'description' => 'The number of released instances is greater than the total number of tenant instances'], + ['code' => 'InternalError', 'message' => 'failed to get project info.', 'http_code' => 400, 'description' => 'Failed to obtain project information'], + ['code' => 'InternalError.Authentication', 'message' => 'Authentication Error', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalError.Server', 'message' => 'Internal Error', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalError.Server', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidAccount', 'message' => 'open service failed.', 'http_code' => 400, 'description' => 'Service provisioning failed'], + ['code' => 'InvalidApp.NotFound', 'message' => 'Throttling User', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidApp.NotFound', 'message' => 'Invalid App', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidArgs', 'message' => 'known gcs instance types.', 'http_code' => 400, 'description' => 'Instance type already exists'], + ['code' => 'InvalidArgs', 'message' => 'Invalid Args.', 'http_code' => 400, 'description' => 'Parameter error'], + ['code' => 'InvalidArgs', 'message' => 'invalid status.', 'http_code' => 400, 'description' => 'Invalid parameter state'], + ['code' => 'InvalidCustomSessionId.NotFound', 'message' => 'Invalid CustomSessionId', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidNextToken', 'message' => 'invalid nextToken.', 'http_code' => 400, 'description' => 'Invalid token'], + ['code' => 'InvalidPlatformSessionId.NotFound', 'message' => 'Invalid PlatformSessionId', 'http_code' => 400, 'description' => ''], + ['code' => 'NotFoundImage', 'message' => 'not found tenant image.', 'http_code' => 400, 'description' => 'Mirror does not exist'], + ['code' => 'NotFoundProject', 'message' => 'project not exist.', 'http_code' => 400, 'description' => 'Item not found'], + ['code' => 'Parameter.Invalid', 'message' => 'The parameter is invalid .', 'http_code' => 500, 'description' => ''], + ['code' => 'Resource.Consume.Error', 'message' => 'vm resource consume error.', 'http_code' => 500, 'description' => ''], + ['code' => 'Resource.NotEnough', 'message' => 'Failed to find free resource.', 'http_code' => 500, 'description' => ''], + ['code' => 'Resource.Run.out', 'message' => 'vm resource run out.', 'http_code' => 500, 'description' => ''], + ['code' => 'Session.Stopped', 'message' => 'Session Stopped', 'http_code' => 400, 'description' => ''], + ['code' => 'TooFrequent', 'message' => 'release instance too frequent.', 'http_code' => 400, 'description' => 'Repeat request'], + ['code' => 'UnsupportedDistrict', 'message' => 'not found any region for district.', 'http_code' => 400, 'description' => 'Region does not exist'], + ['code' => 'UnsupportedInstanceType', 'message' => 'unsupported instance type.', 'http_code' => 400, 'description' => 'Instance type not supported'], + ['code' => 'VersionNameAlreadyExist', 'message' => 'Version name already exist', 'http_code' => 400, 'description' => ''], + ['code' => 'VmStockNotEnough', 'message' => 'no stock.', 'http_code' => 400, 'description' => 'No inventory'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ListInstances'], + ['description' => 'Error codes changed', 'api' => 'ReleaseInstances'], + ['description' => 'Error codes changed', 'api' => 'ReserveInstances'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2024-08-28T05:38:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateAppSession'], ], - 'security' => [ - [ - 'AK' => [], + 'createdAt' => '2024-05-20T07:11:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListAppSessions'], + ], + 'createdAt' => '2023-05-23T08:47:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListAppSessions'], + ], + 'createdAt' => '2023-05-23T08:24:40.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateApp'], + ['description' => 'Response parameters changed', 'api' => 'GetApp'], + ], + 'createdAt' => '2022-12-22T12:17:53.000Z', + 'description' => '无需通知', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CancelReserveTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateCapacityReservation'], + ['description' => 'Response parameters changed', 'api' => 'GetCapacity'], + ], + 'createdAt' => '2022-12-05T07:54:45.000Z', + 'description' => '预定相关API参数优化', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetAppCcu'], + ], + 'createdAt' => '2022-12-05T07:49:02.000Z', + 'description' => '预定有关API参数优化', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetAutoPickPic'], + ], + 'createdAt' => '2022-11-10T02:47:56.000Z', + 'description' => '新增业务接口', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListAppSessions'], + ], + 'createdAt' => '2022-10-17T02:12:10.000Z', + 'description' => 'GCS2应用管理相关API开放', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateAdaptation'], + ['description' => 'OpenAPI offline', 'api' => 'CreateApp'], + ['description' => 'OpenAPI offline', 'api' => 'CreateAppVersion'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteApp'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteAppVersion'], + ['description' => 'OpenAPI offline', 'api' => 'GetAdaptation'], + ['description' => 'OpenAPI offline', 'api' => 'GetApp'], + ['description' => 'OpenAPI offline', 'api' => 'GetAppVersion'], + ['description' => 'OpenAPI offline', 'api' => 'ListApp'], + ['description' => 'OpenAPI offline', 'api' => 'ListAppVersion'], + ], + 'createdAt' => '2022-10-17T02:12:08.000Z', + 'description' => 'GCS2应该管理OpenApi发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetTenantLog'], + ], + 'createdAt' => '2022-09-20T03:06:12.000Z', + 'description' => 'gcs2.3.4 白屏化运维 迭代2', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CheckSLR'], + ['description' => 'OpenAPI offline', 'api' => 'CreateSLR'], + ], + 'createdAt' => '2022-09-20T02:55:00.000Z', + 'description' => 'gcs2.3.4，白屏化运维迭代2', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DownloadDumpfile'], + ['description' => 'OpenAPI offline', 'api' => 'QueryDumpFiles'], + ['description' => 'OpenAPI offline', 'api' => 'QueryOpsChart'], + ], + 'createdAt' => '2022-09-07T08:32:58.000Z', + 'description' => 'gcs2.3.3白屏化运维 迭代1，api发布', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateAppSession'], + ], + 'createdAt' => '2022-08-12T15:16:30.000Z', + 'description' => '2.3.1', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CancelUploadTask'], + ['description' => 'OpenAPI offline', 'api' => 'QueryOfflineTaskProgress'], + ['description' => 'OpenAPI offline', 'api' => 'SubmitOfflineTask'], + ], + 'createdAt' => '2022-08-11T11:15:57.000Z', + 'description' => 'GCS离线上传功能，需发布几个内部调用api', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetAppCcu'], + ['description' => 'Request parameters changed', 'api' => 'StopAppSessionBatch'], + ], + 'createdAt' => '2022-07-29T09:44:31.000Z', + 'description' => '调整限流', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateProject'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteProject'], + ['description' => 'OpenAPI offline', 'api' => 'GetProject'], + ['description' => 'OpenAPI offline', 'api' => 'GetTenant'], + ['description' => 'OpenAPI offline', 'api' => 'ModifyProject'], + ['description' => 'OpenAPI offline', 'api' => 'PageQueryProject'], + ['description' => 'OpenAPI offline', 'api' => 'PageQueryProjectApps'], + ['description' => 'OpenAPI offline', 'api' => 'RefreshDistrictMeta'], + ], + 'createdAt' => '2022-07-19T14:09:43.000Z', + 'description' => '新增项目，预定容器模式', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CancelReserveTask'], + ['description' => 'OpenAPI offline', 'api' => 'GetCapacity'], + ['description' => 'OpenAPI offline', 'api' => 'GetResourcePublicIPs'], + ['description' => 'OpenAPI offline', 'api' => 'ReleaseCapacity'], + ], + 'createdAt' => '2022-07-19T07:29:24.000Z', + 'description' => '新增批量同步下发接口、新增同步下发接口、新增批量停止接口、新增资源预定相关接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateDatasetDeployTask'], + ['description' => 'OpenAPI offline', 'api' => 'GetDataset'], + ], + 'createdAt' => '2022-07-05T01:51:33.000Z', + 'description' => '隐藏数据集的openapi，暂时产品文档层面不公开', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateAdaptation'], + ['description' => 'Response parameters changed', 'api' => 'CreateApp'], + ['description' => 'Response parameters changed', 'api' => 'CreateAppVersion'], + ['description' => 'Response parameters changed', 'api' => 'DeleteApp'], + ['description' => 'Response parameters changed', 'api' => 'DeleteAppVersion'], + ['description' => 'Response parameters changed', 'api' => 'GetAdaptation'], + ['description' => 'Response parameters changed', 'api' => 'GetAppVersion'], + ['description' => 'Response parameters changed', 'api' => 'ListApp'], + ['description' => 'Response parameters changed', 'api' => 'ListAppVersion'], + ['description' => 'Response parameters changed', 'api' => 'ModifyApp'], + ], + 'createdAt' => '2022-06-30T13:00:49.000Z', + 'description' => '更新接口的返回格式', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetApp'], + ], + 'createdAt' => '2022-06-30T12:37:55.000Z', + 'description' => '更新应用OpenApi', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateAppSession'], + ], + 'createdAt' => '2022-05-31T03:12:07.000Z', + 'description' => 'ListAppSessions接口增加会话总数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateAppSession'], + ['description' => 'Response parameters changed', 'api' => 'GetAppSession'], + ], + 'createdAt' => '2022-04-20T06:14:28.000Z', + 'description' => '更新字段属性', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetTenantId'], + ['description' => 'OpenAPI offline', 'api' => 'RecordFinishedFile'], + ], + 'createdAt' => '2022-03-28T09:04:14.000Z', + 'description' => '上传工具新增pop接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetUploadToolUrl'], + ], + 'createdAt' => '2022-03-14T03:47:45.000Z', + 'description' => '部署控制台交互api', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateAppSession'], + ['description' => 'OpenAPI offline', 'api' => 'GetAppSession'], + ['description' => 'OpenAPI offline', 'api' => 'ListAppSessions'], + ['description' => 'OpenAPI offline', 'api' => 'StopAppSession'], + ], + 'createdAt' => '2022-03-03T09:21:15.000Z', + 'description' => '初次发布', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopAppSession'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppSessionSync'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchCheckSession'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppSession'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAppCcu'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopAppSessionBatch'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseCapacityByBatch'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppSessionBatchSync'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAppSessions'], + ['threshold' => '1200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetAppSession'], + ], + ], + 'ram' => [ + 'productCode' => 'CGCS', + 'productName' => 'Graphic Computing Service', + 'ramCodes' => ['cgcs'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'ListApp', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cgcs:ListApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListAppVersion', + 'description' => '', 'operationType' => 'get', - 'autoTest' => false, + 'ramAction' => [ + 'action' => 'cgcs:ListAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '平台会话id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'd9a8****', + [ + 'apiName' => 'GetAppSession', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cgcs:GetAppSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'title' => '自定义会话id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13027****', + ], + [ + 'apiName' => 'CreateAppSessionBatchSync', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cgcs:CreateAppSessionBatchSync', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AppVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '35067****', + ], + [ + 'apiName' => 'ReserveInstances', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cgcs:ReserveInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', - ], - 'Timestamp' => [ - 'title' => '自定义会话id', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'DetailList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'title' => 'key数值，枚举有多个数值，例如： RegionId 大区id ServerIp 服务端 IP ServerPort 端口', - 'description' => '', - 'type' => 'string', - 'example' => 'd9a8****', - ], - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '13027****', - ], - 'DistrictId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'huadong', - ], - 'Ccu' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'AppVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '35067****', - ], - ], - ], - 'required' => false, - ], - ], + [ + 'apiName' => 'DescribeInstanceStatsInfo', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cgcs:DescribeInstanceStatsInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"Timestamp\\": \\"1665560460990\\",\\n \\"DetailList\\": [\\n {\\n \\"ProjectId\\": \\"d9a8****\\",\\n \\"AppId\\": \\"13027****\\",\\n \\"DistrictId\\": \\"huadong\\",\\n \\"Ccu\\": \\"100\\",\\n \\"AppVersion\\": \\"35067****\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'BatchCheckSession' => [ - 'summary' => '批量检查异常会话', - 'methods' => [ - 'post', + [ + 'apiName' => 'StopAppSessionBatch', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cgcs:StopAppSessionBatch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CancelReserveTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cgcs:CancelReserveTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetCapacity', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cgcs:GetCapacity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'BatchCheckSession', + 'description' => '', 'operationType' => 'none', - 'autoTest' => false, + 'ramAction' => [ + 'action' => 'cgcs:BatchCheckSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'Records', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'L1', - 'enum' => [ - 'L1', - 'L2', - 'L3', - ], - ], - 'CustomSessionId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '100XXXX', - ], - 'PlatformSessionId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1ADE0XXXX', - ], - 'ReferenceInfo' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - ], - ], - 'required' => true, - ], - 'required' => true, + [ + 'apiName' => 'ModifyAppVersion', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cgcs:ModifyAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'."\n", - ], - ], + [ + 'apiName' => 'GetReserveTaskDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cgcs:GetReserveTaskDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateApp', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cgcs:CreateApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAppCcu', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cgcs:GetAppCcu', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cgcs:ListInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteApp', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cgcs:DeleteApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAppSession', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cgcs:CreateAppSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ReleaseInstances', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cgcs:ReleaseInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAdaptation', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cgcs:GetAdaptation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopAppSession', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cgcs:StopAppSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAppVersion', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cgcs:GetAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAppSessionSync', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cgcs:CreateAppSessionSync', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ReleaseCapacity', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cgcs:ReleaseCapacity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyApp', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'cgcs:ModifyApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAppSessions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'cgcs:ListAppSessions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetApp', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'cgcs:GetApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAdaptation', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cgcs:CreateAdaptation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateCapacityReservation', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cgcs:CreateCapacityReservation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteAppVersion', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cgcs:DeleteAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAppVersion', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'cgcs:CreateAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ReleaseCapacityByBatch', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'cgcs:ReleaseCapacityByBatch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'CGCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\\\n\\"\\n}","type":"json"}]', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'cgcs.cn-hangzhou.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |