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/zh_cn/metaspace/2022-03-07/api-docs.php | |
| 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/zh_cn/metaspace/2022-03-07/api-docs.php')
| -rw-r--r-- | data/zh_cn/metaspace/2022-03-07/api-docs.php | 448 |
1 files changed, 448 insertions, 0 deletions
diff --git a/data/zh_cn/metaspace/2022-03-07/api-docs.php b/data/zh_cn/metaspace/2022-03-07/api-docs.php new file mode 100644 index 0000000..f1f0b05 --- /dev/null +++ b/data/zh_cn/metaspace/2022-03-07/api-docs.php @@ -0,0 +1,448 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'metaspace', + 'version' => '2022-03-07', + ], + 'directories' => [ + 'GenerateCoordinationCode', + 'ApplyCoordinationWithCode', + 'EndAllCoordinationByOwner', + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'GenerateCoordinationCode' => [ + 'summary' => '为当前账号和连接中的云电脑生成一个协同码,通过将协同码分享给其他账号,可以让其他账号连接到当前云电脑。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREappstreamingD8SMIE', + ], + ], + 'parameters' => [ + [ + 'name' => 'LoginToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '登录令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'v2c4e2ef03d62******'."\n", + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '登录会话ID。', + 'type' => 'string', + 'required' => false, + 'example' => '09e2b2e6-3181******'."\n", + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源ID。'."\n" + ."\n" + .'> 不同的资源类型,对应的资源ID也不相同。'."\n" + .'> - `CloudDesktop` 资源ID为云电脑ID,如`ecd-68a7ddrt0******`。'."\n" + .'> - `CloudApp` 资源ID为应用实例ID,如`ai-0cbg3f097lq******`。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecd-68a7ddrt0******', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CloudDesktop' => '云电脑', + 'CloudApp' => '云应用', + ], + 'example' => 'CloudDesktop', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源所属地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceName', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'demo-desktop', + ], + ], + [ + 'name' => 'LoginRegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '登录地域ID。用户通过办公网络登录时,办公网络所属的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AD2D0761-1FE5-549D-B169******'."\n", + ], + 'CoordinationCode' => [ + 'description' => '协同码。', + 'type' => 'string', + 'example' => 'PA3MU***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169******\\\\n\\",\\n \\"CoordinationCode\\": \\"PA3MU***\\"\\n}","type":"json"}]', + 'title' => '生成协同码', + ], + 'ApplyCoordinationWithCode' => [ + 'summary' => '使用协同码发起协同连接,获取协同连接凭证。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREappstreamingD8SMIE', + ], + ], + 'parameters' => [ + [ + 'name' => 'LoginToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '登录令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'v2c4e2ef03d62******'."\n", + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '登录会话ID。', + 'type' => 'string', + 'required' => false, + 'example' => '09e2b2e6-3181******'."\n", + ], + ], + [ + 'name' => 'CoordinationCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '协同码。', + 'type' => 'string', + 'required' => false, + 'example' => 'PA3MU***'."\n", + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'formData', + 'schema' => [ + 'description' => '登录设备的唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'A8B35215993FBF283F28D61******'."\n", + ], + ], + [ + 'name' => 'LoginRegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '登录地域ID。用户通过办公网络登录时,办公网络所属的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AD2D0761-1FE5-549D-B169******'."\n", + ], + 'Data' => [ + 'description' => '协同信息。', + 'type' => 'object', + 'properties' => [ + 'CoId' => [ + 'description' => '协同任务ID。', + 'type' => 'string', + 'example' => 'co-0ad0f3p4n2******', + ], + 'OwnerUserId' => [ + 'description' => '资源所有者用户ID。', + 'type' => 'string', + 'example' => 'alice', + ], + 'OwnerAliUid' => [ + 'description' => '资源所有者租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1126819517******'."\n", + ], + 'CoordinatorUserId' => [ + 'description' => '协同者用户ID。', + 'type' => 'string', + 'example' => 'bob', + ], + 'CoordinatorAliUid' => [ + 'description' => '协同者租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1126819517******'."\n", + ], + 'CoordinateStatus' => [ + 'description' => '协同任务状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'TERMINATED' => '协同结束', + 'COORDINATING' => '协同中', + 'PENDING' => '协同待接受', + ], + 'example' => 'COORDINATING', + ], + 'ResourceId' => [ + 'description' => '资源ID。', + '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******', + ], + ], + ], + ], + ], + ], + ], + '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' => '使用协同码发起协同', + 'description' => '> 发起协同连接时,需要资源所有者和资源处于连接中状态。', + ], + 'EndAllCoordinationByOwner' => [ + 'summary' => '资源所有者主动结束当前资源的所有协同任务,同步失效协同码。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREappstreamingD8SMIE', + ], + ], + 'parameters' => [ + [ + 'name' => 'LoginToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '登录令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'v2c4e2ef03d62******', + ], + ], + [ + 'name' => 'LoginRegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '登录地域ID。用户通过办公网络登录时,办公网络所属的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '登录会话ID。', + 'type' => 'string', + 'required' => false, + 'example' => '09e2b2e6-3181******', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源ID。'."\n" + ."\n" + .'> 不同的资源类型,对应的资源ID也不相同。'."\n" + .'> - `CloudDesktop`资源ID为云电脑ID,如`ecd-68a7ddrt0******`。'."\n" + .'> - `CloudApp`资源ID为应用实例ID,如`ai-0cbg3f097lq******`。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecd-68a7ddrt0******', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CloudDesktop' => '云电脑', + 'CloudApp' => '云应用', + ], + 'example' => 'CloudDesktop', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源所属地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AD2D0761-1FE5-549D-B169******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169******\\"\\n}","type":"json"}]', + 'title' => '资源所有者结束所有协同', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'metaspace.aliyuncs.com', + ], + ], +]; |
