summaryrefslogtreecommitdiff
path: root/data/en_us/appstream-center/2021-02-18/api-docs.php
blob: 4b300f46b47e505b50c1bb3f17e9397f87d779f8 (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
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
<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'RPC',
        'product' => 'appstream-center',
        'version' => '2021-02-18',
    ],
    'directories' => [
        'GetAuthCode',
        [
            'id' => 354391,
            'title' => null,
            'type' => 'directory',
            'children' => [
                'ExpireLoginToken',
                'GetStsToken',
            ],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'GetAuthCode' => [
            'summary' => 'Obtains an authorization code that includes the identity and permission information of a user. You can use the code to launch cloud apps in integration scenarios.',
            'methods' => [
                'get',
                'post',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'ExternalUserId',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'alice',
                    ],
                ],
                [
                    'name' => 'EndUserId',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'alice',
                    ],
                ],
                [
                    'name' => 'Policy',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                        'example' => '{'."\n"
                            .'      "Version": "1",'."\n"
                            .'      "Resource": {'."\n"
                            .'            "Type": "AppInstanceGroup",'."\n"
                            .'            "Id": "aig-9ciijz60n4xsv****"'."\n"
                            .'      }'."\n"
                            .'}',
                    ],
                ],
                [
                    'name' => 'AutoCreateUser',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'boolean',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'description' => '',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => [
                                'title' => 'Id of the request',
                                'description' => '',
                                'type' => 'string',
                                'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
                            ],
                            'AuthModel' => [
                                'description' => '',
                                'type' => 'object',
                                'properties' => [
                                    'AuthCode' => [
                                        'description' => '',
                                        'type' => 'string',
                                        'example' => 'acv2ZEq2TNSqOlX+DvyetHGRT08iPhbWg/os1W4HojpBxkMQZkAnbKSfz/wNvS0E149IQZ5TogvBUE8ghCSVV+QBnv48Y+sn4z9fY5ywZA1peI5s4TplQI0TADBhPZXEIzMOdmbNsDGGlGcKOAq8ixd1Epzdu9XfvRzdLOO6o3zQwTZxXsjOgGBW8JTcgCP9W9iYiIjHIdZ2VCAnmMzuyVkyED8gymEevH10QoclyH/O3s8Yq6VF34gMXihDQeiI8PyiAZrW0JWXSWpdy3n4yGtAqMAgv46FzTA+XJ6C********',
                                    ],
                                    'EndUserId' => [
                                        'description' => '',
                                        'type' => 'string',
                                        'example' => 'alice',
                                    ],
                                    'ExpireTime' => [
                                        'description' => '',
                                        'type' => 'string',
                                        'example' => '2015-01-23T12:33:18Z',
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n  \\"AuthModel\\": {\\n    \\"AuthCode\\": \\"acv2ZEq2TNSqOlX+DvyetHGRT08iPhbWg/os1W4HojpBxkMQZkAnbKSfz/wNvS0E149IQZ5TogvBUE8ghCSVV+QBnv48Y+sn4z9fY5ywZA1peI5s4TplQI0TADBhPZXEIzMOdmbNsDGGlGcKOAq8ixd1Epzdu9XfvRzdLOO6o3zQwTZxXsjOgGBW8JTcgCP9W9iYiIjHIdZ2VCAnmMzuyVkyED8gymEevH10QoclyH/O3s8Yq6VF34gMXihDQeiI8PyiAZrW0JWXSWpdy3n4yGtAqMAgv46FzTA+XJ6C********\\",\\n    \\"EndUserId\\": \\"alice\\",\\n    \\"ExpireTime\\": \\"2015-01-23T12:33:18Z\\"\\n  }\\n}","type":"json"}]',
            'title' => 'GetAuthCode',
        ],
        'ExpireLoginToken' => [
            'summary' => 'Manually invalidates a logon token.',
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'SessionId',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => true,
                        'example' => 'a863f4c3-2f1d-4971-8cf7-e2b92ae9****',
                    ],
                ],
                [
                    'name' => 'LoginToken',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => true,
                        'example' => 'v185fdd7f6d39fa7861981639366085772e150a390a5bb7b43c4e62440d94fc392b945770e1596cebe90085ce0af4d****',
                    ],
                ],
                [
                    'name' => 'EndUserId',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => true,
                        'example' => 'testuser',
                    ],
                ],
                [
                    'name' => 'OfficeSiteId',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'cn-beijing+dir-172301****',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'description' => '',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => [
                                'title' => 'Id of the request',
                                'description' => '',
                                'type' => 'string',
                                'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
                            ],
                        ],
                    ],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
            'title' => 'ExpireLoginToken',
        ],
        'GetStsToken' => [
            'summary' => '获取stsToken',
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'none',
                'riskType' => 'none',
                'chargeType' => 'free',
                'abilityTreeNodes' => [
                    'FEATUREappstreamingV87T4P',
                ],
                'autoTest' => false,
                'notSupportAutoTestReason' => '参数无阿里云资源id',
                'tenantRelevance' => 'tenant',
            ],
            'parameters' => [
                [
                    'name' => 'ExternalId',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'Alex',
                    ],
                ],
                [
                    'name' => 'EndUserId',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'Alex',
                    ],
                ],
                [
                    'name' => 'Expiration',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '',
                        'type' => 'integer',
                        'format' => 'int64',
                        'required' => false,
                        'example' => '600',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'description' => '',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => [
                                'title' => 'Id of the request',
                                'description' => '',
                                'type' => 'string',
                                'example' => 'CCF92035-6231-5ABB-930E-1E003C32****',
                            ],
                            'StsTokenModel' => [
                                'description' => '',
                                'type' => 'object',
                                'properties' => [
                                    'SessionId' => [
                                        'description' => '',
                                        'type' => 'string',
                                        'example' => 'be4be09e-cd00-4b4c-add7-11b4d8****',
                                    ],
                                    'StsToken' => [
                                        'description' => '',
                                        'type' => 'string',
                                        'example' => 'sts****',
                                    ],
                                    'AliUid' => [
                                        'description' => '',
                                        'type' => 'integer',
                                        'format' => 'int64',
                                        'example' => '105552640689****',
                                    ],
                                    'TenantId' => [
                                        'description' => '',
                                        'type' => 'integer',
                                        'format' => 'int64',
                                        'example' => '105552640689****',
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"RequestId\\": \\"CCF92035-6231-5ABB-930E-1E003C32****\\",\\n  \\"StsTokenModel\\": {\\n    \\"SessionId\\": \\"be4be09e-cd00-4b4c-add7-11b4d8****\\",\\n    \\"StsToken\\": \\"sts****\\",\\n    \\"AliUid\\": 0,\\n    \\"TenantId\\": 0\\n  }\\n}","type":"json"}]',
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'cn-shanghai',
            'endpoint' => 'appstream-center.cn-shanghai.aliyuncs.com',
        ],
        [
            'regionId' => 'ap-southeast-1',
            'endpoint' => 'appstream-center.ap-southeast-1.aliyuncs.com',
        ],
    ],
];