diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/cgcs | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/cgcs')
| -rw-r--r-- | data/en_us/cgcs/2021-11-11/api-docs.php | 4127 |
1 files changed, 4127 insertions, 0 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 new file mode 100644 index 0000000..89f0681 --- /dev/null +++ b/data/en_us/cgcs/2021-11-11/api-docs.php @@ -0,0 +1,4127 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'CGCS', + 'version' => '2021-11-11', + ], + 'directories' => [ + [ + 'id' => 188216, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ReserveInstances', + 'ReleaseInstances', + 'ListInstances', + 'DescribeInstanceStatsInfo', + ], + ], + [ + 'id' => 168896, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateApp', + 'ModifyApp', + 'ListApp', + 'GetApp', + 'DeleteApp', + ], + ], + [ + 'id' => 168902, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateAppVersion', + 'ModifyAppVersion', + 'ListAppVersion', + 'GetAppVersion', + 'DeleteAppVersion', + ], + ], + [ + 'id' => 168908, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateAdaptation', + 'GetAdaptation', + ], + ], + [ + 'id' => 169658, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateCapacityReservation', + 'CancelReserveTask', + 'GetReserveTaskDetail', + 'ReleaseCapacity', + 'ReleaseCapacityByBatch', + 'GetCapacity', + ], + ], + [ + 'id' => 168895, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateAppSession', + 'StopAppSession', + 'GetAppSession', + 'ListAppSessions', + 'CreateAppSessionSync', + 'CreateAppSessionBatchSync', + 'StopAppSessionBatch', + 'GetAppCcu', + 'BatchCheckSession', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'ReserveInstances' => [ + 'summary' => '预定GCS实例', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '5469588382860444937003', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'gcs.r1c1m1.1xlarge', + ], + ], + [ + 'name' => 'DistrictId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'huanan' => 'huanan', + 'huabei' => 'huabei', + 'xinan' => 'xinan', + 'huazhong' => 'huazhong', + 'huadong' => 'huadong', + ], + 'example' => 'huadong', + ], + ], + [ + 'name' => 'Amount', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + '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', + ], + 'InstanceIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gcs-bmt0kbn7e013aedg9', + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '4820372607851300489003', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'gcs.r1c1m1.1xlarge', + ], + ], + [ + 'name' => 'DistrictId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'huanan' => 'huanan', + 'huabei' => 'huabei', + 'xinan' => 'xinan', + 'huazhong' => 'huazhong', + 'huadong' => 'huadong', + ], + 'example' => 'huadong', + ], + ], + [ + 'name' => 'Amount', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + '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', + ], + 'InstanceIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gcs-bmt0kbn7e013aedg9', + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '4820372607851300489003', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'gcs.r1c1m1.1xlarge', + ], + ], + [ + 'name' => 'DistrictId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'huadong', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'gcs-bmt0kbn7e013aedg9', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'BEXZPF01W23U46598WVf', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CREATING', + 'enum' => [ + 'CREATING', + 'RUNNING', + 'OPERATING', + 'DELETING', + 'MIGRATING', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidNextToken', + 'errorMessage' => 'invalid nextToken.', + ], + [ + 'errorCode' => 'InvalidArgs', + 'errorMessage' => 'invalid status.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'ProjectIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6733705348307226241003', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'InstanceTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + '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', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Response<DescribeInstanceStatsInfoPopResponse>', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '释放的 instanceIds', + 'description' => '', + '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', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'pop的requestId', + 'description' => '', + 'type' => 'string', + 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0977', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'example', + ], + ], + [ + 'name' => 'AppType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'end_game', + ], + ], + [ + 'name' => 'StreamingAppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '47d0bd4d-8815-48a2-b783-6cbba89d****', + ], + ], + [ + 'name' => 'StreamingSolution', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'self-have-streaming', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppId\\": \\"4384****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + ], + 'ModifyApp' => [ + 'summary' => '应用修改服务', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '4384****', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'example', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppId\\": \\"4384****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + ], + 'ListApp' => [ + 'summary' => '应用列表接口', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'KeySearch', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'example', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '0', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '4384****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'AppInfoFlatPopResult', + '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', + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '4384****', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppVersionId\\": \\"1432****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + ], + 'ModifyAppVersion' => [ + 'summary' => '应用版本修改服务', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppVersionId\\": \\"1432****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + ], + 'ListAppVersion' => [ + 'summary' => '应用版本列表接口', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '4384****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'AppVersionListDataFlatPopResult', + 'description' => 'AppVersionListDataFlatPopResult', + 'type' => 'object', + 'properties' => [ + 'Versions' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + ], + ], + 'Total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'AppVersionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1432****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'AppVersionInfoFlatPopResult', + 'description' => 'AppVersionInfoFlatPopResult', + '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', + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'AppVersionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1432****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'AppVersionIdDataFlatPopResult', + 'description' => 'AppVersionIdDataFlatPopResult', + 'type' => 'object', + 'properties' => [ + 'AppVersionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1432****', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppVersionId\\": \\"1432****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + ], + 'CreateAdaptation' => [ + 'summary' => '提交适配请求', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'AppVersionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1432****', + ], + ], + [ + 'name' => 'AdaptTarget', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AdaptApplyId\\": 0,\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + ], + 'GetAdaptation' => [ + 'summary' => '获取适配申请详情', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => 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****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'AdaptApplyDataFlatPopResult', + 'description' => 'AdaptApplyDataFlatPopResult', + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'd9a8****', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => '应用ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '13027****', + ], + ], + [ + 'name' => 'AppVersion', + 'in' => 'formData', + 'schema' => [ + 'title' => '应用版本ID，如果不填，采用控制台设置的默认版本', + 'description' => '', + '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', + ], + ], + [ + 'name' => 'ExpectSessionCapacity', + 'in' => 'formData', + 'schema' => [ + 'title' => '预期创建出的容器能支持的 session 数量。GCS 内部会根据适配自动计算出所需要的资源量，以及多种机型的配比。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '客户端 token，保持幂等性。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2YEF0****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PopHttpResult<>', + 'description' => '', + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + '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****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PopHttpResult<>', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'b354****', + ], + 'RequestId' => [ + 'title' => 'pop的requestId', + 'description' => '', + 'type' => 'string', + 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"b354****\\",\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\"\\n}","type":"json"}]', + ], + 'GetReserveTaskDetail' => [ + 'summary' => '查询预定任务的详情信息', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => [ + 'title' => '创建容量预定任务时返回的 taskId', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'b354****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PopHttpResult<>', + 'description' => '', + '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' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResBatchId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '726573XXXX', + ], + 'ResBatchTagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'resBatchId', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目 id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'd9a8****', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'app id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '13027****', + ], + ], + [ + 'name' => 'DistrictId', + 'in' => 'formData', + 'schema' => [ + 'title' => '大区 id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'huadong', + ], + ], + [ + 'name' => 'ExpectReleaseSessionCapacity', + 'in' => 'formData', + 'schema' => [ + 'title' => '期望释放的会话路数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'AppVersion', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '35067****', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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\\"\\n}","type":"json"}]', + ], + 'GetCapacity' => [ + 'summary' => '查询 session 会话容量信息', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => 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****', + ], + ], + [ + 'name' => 'AppVersion', + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PopHttpResult<>', + 'description' => '', + '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' => '', + 'type' => 'array', + 'items' => [ + '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****', + ], + ], + ], + ], + 'RequestId' => [ + 'title' => 'pop的requestId', + 'description' => '', + 'type' => 'string', + 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + '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', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义用户id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2YEF0XXXX', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'CustomSessionId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义会话id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1ADE0XXXX', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端ip', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XXX.XXX', + ], + ], + [ + 'name' => 'StartParameters', + '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, + ], + ], + [ + '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+APXXXX', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1800', + ], + ], + [ + 'name' => 'EnablePostpaid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '项目ID。如果已将应用关联到项目，创建会话时需填写正确的项目ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'd9a8****', + ], + ], + [ + 'name' => 'AdapterFileId', + 'in' => 'query', + 'schema' => [ + 'description' => '适配文件ID。此功能灰度开放，如未约定使用请勿传入。', + 'type' => 'string', + 'required' => false, + 'example' => '501716211209548966XXXX', + ], + ], + [ + 'name' => 'DistrictId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'huadong', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => 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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + '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' => 'PageSize', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '分页大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '13027XXXX', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'd9a8****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '13027****', + ], + ], + [ + 'name' => 'AppVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '应用版本', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '35067****', + ], + ], + [ + 'name' => 'CustomUserId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义用户id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2YEF0****', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'CustomSessionId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义会话id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1ADE0****', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端ip', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'StartParameters', + 'in' => 'query', + 'style' => 'flat', + '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', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + '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, + ], + 'required' => false, + ], + ], + [ + '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, + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'd9a8****', + ], + ], + [ + 'name' => 'DistrictId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'huadong', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'BatchId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '6d4d****', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + [ + 'name' => 'AppInfos', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + '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', + ], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 50, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + '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.', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'BatchId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义用户id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => '6d4d****', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义会话id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'd9a8****', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '13027****', + ], + ], + [ + 'name' => 'AppVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '35067****', + ], + ], + [ + '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, + ], + ], + [ + 'name' => 'StopParam', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'reason', + ], + 'Value' => [ + 'description' => '', + 'type' => 'any', + 'required' => false, + 'example' => 'exampleValue', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + '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****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\",\\n \\"BatchId\\": \\"6d4d****\\",\\n \\"ProjectId\\": \\"d9a8****\\",\\n \\"AppId\\": \\"13027****\\"\\n}","type":"json"}]', + ], + 'GetAppCcu' => [ + 'summary' => '查询会话并发数', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '平台会话id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'd9a8****', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义会话id', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '13027****', + ], + ], + [ + 'name' => 'AppVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '35067****', + ], + ], + ], + '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, + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'autoTest' => false, + ], + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => '46329898-489C-4E63-9BA1-C1DA5C5D0986'."\n", + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46329898-489C-4E63-9BA1-C1DA5C5D0986\\\\n\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'cgcs.cn-hangzhou.aliyuncs.com', + ], + ], +]; |