summaryrefslogtreecommitdiff
path: root/data/zh_cn/metaspace/2022-03-07/api-docs.php
blob: 43ef5ea7b33d395fb6e70eb70be82cdcc773839c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'RPC', 'product' => 'metaspace', 'version' => '2022-03-07'],
    'directories' => ['ApplyCoordinationWithCode', 'EndAllCoordinationByOwner', 'GenerateCoordinationCode'],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        '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' => '> 发起协同连接时,需要资源所有者和资源处于连接中状态。',
            'changeSet' => [],
        ],
        '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' => '资源所有者结束所有协同',
            'changeSet' => [],
        ],
        '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' => '生成协同码',
            'changeSet' => [],
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '无影云应用',
        'ramCodes' => ['appstreaming', 'ecd'],
        'ramLevel' => '操作级',
        'ramConditions' => [],
        'ramActions' => [],
        'resourceTypes' => [],
    ],
];