data/en_us/metaspace/2022-03-07/api-docs.php


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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436

<?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' => '',
                        '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',
                    ],
                ],
                [
                    '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' => '',
                        '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' => '',
                                '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"}]',
        ],
        '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' => '',
                        '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' => '',
                        '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' => '',
                                '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******',
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            '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"}]',
        ],
        'EndAllCoordinationByOwner' => [
            'summary' => 'Owner主动结束本次协同，同步失效协同码',
            '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' => '',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'cn-hangzhou',
                    ],
                ],
                [
                    'name' => 'SessionId',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                        'example' => '09e2b2e6-3181******',
                    ],
                ],
                [
                    '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',
                    ],
                ],
                [
                    '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' => '',
                                'type' => 'string',
                                'example' => 'AD2D0761-1FE5-549D-B169******',
                            ],
                        ],
                    ],
                ],
            ],
            'staticInfo' => [
                'returnType' => 'synchronous',
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"RequestId\\": \\"AD2D0761-1FE5-549D-B169******\\"\\n}","type":"json"}]',
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'cn-shanghai',
            'endpoint' => 'metaspace.aliyuncs.com',
        ],
    ],
];