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/metaspace | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/metaspace')
| -rw-r--r-- | data/en_us/metaspace/2022-03-07/api-docs.php | 433 |
1 files changed, 149 insertions, 284 deletions
diff --git a/data/en_us/metaspace/2022-03-07/api-docs.php b/data/en_us/metaspace/2022-03-07/api-docs.php index f81464f..b648579 100644 --- a/data/en_us/metaspace/2022-03-07/api-docs.php +++ b/data/en_us/metaspace/2022-03-07/api-docs.php @@ -1,29 +1,15 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'metaspace', - 'version' => '2022-03-07', - ], - 'directories' => [ - 'GenerateCoordinationCode', - 'ApplyCoordinationWithCode', - 'EndAllCoordinationByOwner', - ], + 'info' => ['style' => 'RPC', 'product' => 'metaspace', 'version' => '2022-03-07'], + 'directories' => ['ApplyCoordinationWithCode', 'EndAllCoordinationByOwner', 'GenerateCoordinationCode'], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'GenerateCoordinationCode' => [ - 'summary' => '生成协同码', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ApplyCoordinationWithCode' => [ + 'summary' => 'Use a coordination code to initiate a coordination connection and retrieve a coordination connection credential.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -32,126 +18,96 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREappstreamingD8SMIE', - ], + 'abilityTreeNodes' => ['FEATUREappstreamingD8SMIE'], ], 'parameters' => [ [ 'name' => 'LoginToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'v2c4e2ef03d62******'."\n", - ], + 'schema' => ['description' => 'Login token.', 'type' => 'string', 'required' => false, 'example' => 'v2c4e2ef03d62******'."\n", 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '09e2b2e6-3181******'."\n", - ], - ], - [ - 'name' => 'ResourceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-68a7ddrt0******', - ], - ], - [ - 'name' => 'ResourceType', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CloudDesktop' => '', - 'CloudApp' => '', - ], - 'example' => 'CloudDesktop', - ], + 'schema' => ['description' => 'Login session ID.', 'type' => 'string', 'required' => false, 'example' => '09e2b2e6-3181******'."\n", 'title' => ''], ], [ - 'name' => 'ResourceRegionId', + 'name' => 'CoordinationCode', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Coordination code.', 'type' => 'string', 'required' => false, 'example' => 'PA3MU***'."\n", 'title' => ''], ], [ - 'name' => 'ResourceName', + 'name' => 'Uuid', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'demo-desktop', - ], + 'schema' => ['description' => 'Unique identifier of the login device.', 'type' => 'string', 'required' => false, 'example' => 'A8B35215993FBF283F28D61******'."\n", 'title' => ''], ], [ 'name' => 'LoginRegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Login region ID. This is the region ID of your office network when you log in from it.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Response information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'AD2D0761-1FE5-549D-B169******'."\n", - ], - 'CoordinationCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PA3MU***', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'AD2D0761-1FE5-549D-B169******'."\n"], + 'Data' => [ + 'description' => 'Coordination information.', + 'type' => 'object', + 'properties' => [ + 'CoId' => ['description' => 'Coordination task ID.', 'type' => 'string', 'example' => 'co-0ad0f3p4n2******', 'title' => ''], + 'OwnerUserId' => ['description' => 'Resource owner user ID.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'OwnerAliUid' => ['description' => 'Resource owner tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1126819517******'."\n", 'title' => ''], + 'CoordinatorUserId' => ['description' => 'Coordinator user ID.', 'type' => 'string', 'example' => 'bob', 'title' => ''], + 'CoordinatorAliUid' => ['description' => 'Coordinator tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1126819517******'."\n", 'title' => ''], + 'CoordinateStatus' => [ + 'description' => 'Coordination task status.', + 'enumValueTitles' => ['TERMINATED' => 'Collaboration ended', 'COORDINATING' => 'Collaborating', 'PENDING' => 'Pending invitations'], + 'type' => 'string', + 'example' => 'COORDINATING', + 'title' => '', + ], + 'ResourceId' => ['description' => 'Resource ID.', 'type' => 'string', 'example' => 'ecd-3vv4mf8zxg******', 'title' => ''], + 'ResourceName' => ['description' => 'Resource name.', 'type' => 'string', 'example' => 'demo-desktop', 'title' => ''], + 'ResourceType' => [ + 'description' => 'Resource type.', + 'enumValueTitles' => ['CloudDesktop' => 'Cloud Desktop', 'CloudApp' => 'Cloud Application'], + 'type' => 'string', + 'example' => 'CloudDesktop', + 'title' => '', + ], + 'ResourceRegionId' => ['description' => 'Region where the resource resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'CoordinateTicket' => ['description' => 'Coordination connection credential.', 'type' => 'string', 'example' => 'DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQ******', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169******\\\\n\\",\\n \\"Data\\": {\\n \\"CoId\\": \\"co-0ad0f3p4n2******\\",\\n \\"OwnerUserId\\": \\"alice\\",\\n \\"OwnerAliUid\\": 0,\\n \\"CoordinatorUserId\\": \\"bob\\",\\n \\"CoordinatorAliUid\\": 0,\\n \\"CoordinateStatus\\": \\"COORDINATING\\",\\n \\"ResourceId\\": \\"ecd-3vv4mf8zxg******\\",\\n \\"ResourceName\\": \\"demo-desktop\\",\\n \\"ResourceType\\": \\"CloudDesktop\\",\\n \\"ResourceRegionId\\": \\"cn-hangzhou\\",\\n \\"CoordinateTicket\\": \\"DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQ******\\"\\n }\\n}","type":"json"}]', + 'title' => 'Initiate collaboration using a coordination code', + 'description' => '> The resource owner and the resource must both be online when you initiate a coordination connection.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169******\\\\n\\",\\n \\"CoordinationCode\\": \\"PA3MU***\\"\\n}","type":"json"}]', + 'ramActions' => [], ], - 'ApplyCoordinationWithCode' => [ - 'summary' => '用协同码发起协同', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'EndAllCoordinationByOwner' => [ + 'summary' => 'The resource owner ends all active coordination tasks for a resource and synchronizes the deactivation of its coordination codes.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -163,166 +119,79 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREappstreamingD8SMIE', - ], + 'abilityTreeNodes' => ['FEATUREappstreamingD8SMIE'], ], 'parameters' => [ [ 'name' => 'LoginToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'v2c4e2ef03d62******'."\n", - ], + 'schema' => ['description' => 'Login token.', 'type' => 'string', 'required' => false, 'example' => 'v2c4e2ef03d62******', 'title' => ''], + ], + [ + 'name' => 'LoginRegionId', + 'in' => 'formData', + 'schema' => ['description' => 'Login region ID. The region ID of the office network when a user logs in through the office network.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '09e2b2e6-3181******'."\n", - ], + 'schema' => ['description' => 'Login session ID.', 'type' => 'string', 'required' => false, 'example' => '09e2b2e6-3181******', 'title' => ''], ], [ - 'name' => 'CoordinationCode', + 'name' => 'ResourceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PA3MU***'."\n", - ], + 'schema' => ['description' => 'Resource ID.'."\n" + ."\n" + .'> Resource IDs vary by resource type.'."\n" + .'>'."\n" + .'> - The resource ID for `CloudDesktop` is the cloud desktop ID, such as `ecd-68a7ddrt0******`.'."\n" + .'>'."\n" + .'> - The resource ID for `CloudApp` is the application instance ID, such as `ai-0cbg3f097lq******`.', 'type' => 'string', 'required' => false, 'example' => 'ecd-68a7ddrt0******', 'title' => ''], ], [ - 'name' => 'Uuid', + 'name' => 'ResourceType', 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'Resource type.', + 'enumValueTitles' => ['CloudDesktop' => 'Cloud desktop', 'CloudApp' => 'Cloud application'], 'type' => 'string', 'required' => false, - 'example' => 'A8B35215993FBF283F28D61******'."\n", + 'example' => 'CloudDesktop', + 'title' => '', ], ], [ - 'name' => 'LoginRegionId', + 'name' => 'ResourceRegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Region where the resource resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Response information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'AD2D0761-1FE5-549D-B169******'."\n", - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CoId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'co-0ad0f3p4n2******', - ], - 'OwnerUserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'alice', - ], - 'OwnerAliUid' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1126819517******'."\n", - ], - 'CoordinatorUserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'bob', - ], - 'CoordinatorAliUid' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1126819517******'."\n", - ], - 'CoordinateStatus' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'TERMINATED' => '', - 'COORDINATING' => '', - 'PENDING' => '', - ], - 'example' => 'COORDINATING', - ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ecd-3vv4mf8zxg******', - ], - 'ResourceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'demo-desktop', - ], - 'ResourceType' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'CloudDesktop' => '', - 'CloudApp' => '', - ], - 'example' => 'CloudDesktop', - ], - 'ResourceRegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'CoordinateTicket' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQ******', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'AD2D0761-1FE5-549D-B169******'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169******\\"\\n}","type":"json"}]', + 'title' => 'Resource Owner Ends All Collaboration', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169******\\\\n\\",\\n \\"Data\\": {\\n \\"CoId\\": \\"co-0ad0f3p4n2******\\",\\n \\"OwnerUserId\\": \\"alice\\",\\n \\"OwnerAliUid\\": 0,\\n \\"CoordinatorUserId\\": \\"bob\\",\\n \\"CoordinatorAliUid\\": 0,\\n \\"CoordinateStatus\\": \\"COORDINATING\\",\\n \\"ResourceId\\": \\"ecd-3vv4mf8zxg******\\",\\n \\"ResourceName\\": \\"demo-desktop\\",\\n \\"ResourceType\\": \\"CloudDesktop\\",\\n \\"ResourceRegionId\\": \\"cn-hangzhou\\",\\n \\"CoordinateTicket\\": \\"DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQ******\\"\\n }\\n}","type":"json"}]', + 'ramActions' => [], ], - 'EndAllCoordinationByOwner' => [ - 'summary' => 'Owner主动结束本次协同,同步失效协同码', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GenerateCoordinationCode' => [ + 'summary' => 'Generates a coordination code for the current account\'s connected cloud desktop. You can share this code with other accounts to allow them to connect to the same cloud desktop.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -331,106 +200,102 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREappstreamingD8SMIE', - ], + 'abilityTreeNodes' => ['FEATUREappstreamingD8SMIE'], ], 'parameters' => [ [ 'name' => 'LoginToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'v2c4e2ef03d62******', - ], - ], - [ - 'name' => 'LoginRegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Login token.', 'type' => 'string', 'required' => false, 'example' => 'v2c4e2ef03d62******'."\n", 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '09e2b2e6-3181******', - ], + 'schema' => ['description' => 'Login session ID.', 'type' => 'string', 'required' => false, 'example' => '09e2b2e6-3181******'."\n", 'title' => ''], ], [ 'name' => 'ResourceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-68a7ddrt0******', - ], + 'schema' => ['description' => 'Resource ID.'."\n" + ."\n" + .'> Resource IDs vary by resource type.'."\n" + .'>'."\n" + .'> - `CloudDesktop`: The resource ID is the cloud desktop ID, such as `ecd-68a7ddrt0******`.'."\n" + .'>'."\n" + .'> - `CloudApp`: The resource ID is the application instance ID, such as `ai-0cbg3f097lq******`.', 'type' => 'string', 'required' => false, 'example' => 'ecd-68a7ddrt0******', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'Resource type.', + 'enumValueTitles' => ['CloudDesktop' => 'Cloud desktop', 'CloudApp' => 'Cloud application'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'CloudDesktop' => '', - 'CloudApp' => '', - ], 'example' => 'CloudDesktop', + 'title' => '', ], ], [ 'name' => 'ResourceRegionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Region where the resource resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ResourceName', + 'in' => 'formData', + 'schema' => ['description' => 'Resource name.', 'type' => 'string', 'required' => false, 'example' => 'demo-desktop', 'title' => ''], + ], + [ + 'name' => 'LoginRegionId', + 'in' => 'formData', + 'schema' => ['description' => 'Login region ID. This is the region ID of the office network when users log on through an office network.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Response information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'AD2D0761-1FE5-549D-B169******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'AD2D0761-1FE5-549D-B169******'."\n"], + 'CoordinationCode' => ['description' => 'Coordination code.', 'type' => 'string', 'example' => 'PA3MU***', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169******\\\\n\\",\\n \\"CoordinationCode\\": \\"PA3MU***\\"\\n}","type":"json"}]', + 'title' => 'Generate Coordination Code ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169******\\"\\n}","type":"json"}]', + 'ramActions' => [], ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'metaspace.aliyuncs.com', + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'metaspace.aliyuncs.com', 'endpoint' => 'metaspace.aliyuncs.com', 'vpc' => 'metaspace.vpc-proxy.aliyuncs.com'], + ], + 'errorCodes' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], ], ], + 'ram' => [ + 'productCode' => 'AppStreaming', + 'productName' => 'App Streaming', + 'ramCodes' => ['appstreaming', 'ecd'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [], + 'resourceTypes' => [], + ], ]; |
