summaryrefslogtreecommitdiff
path: root/data/wss/2021-12-21/api-docs.php
blob: ee22d8a70a203e311f03033e00873fa1553fb07e (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
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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'RPC', 'product' => 'wss', 'version' => '2021-12-21'],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'CreateMultiOrder' => [
            'methods' => ['get', 'post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'OrderItems',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => [
                            'type' => 'object',
                            'required' => false,
                            'properties' => [
                                'Amount' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                'ResourceType' => ['type' => 'string', 'required' => true],
                                'AutoPay' => ['type' => 'boolean', 'required' => false],
                                'AutoRenew' => ['type' => 'boolean', 'required' => false],
                                'PeriodUnit' => ['type' => 'string', 'required' => false],
                                'Components' => [
                                    'type' => 'array',
                                    'required' => false,
                                    'items' => [
                                        'type' => 'object',
                                        'required' => false,
                                        'properties' => [
                                            'Key' => ['type' => 'string', 'required' => false],
                                            'Value' => ['type' => 'string', 'required' => false],
                                        ],
                                    ],
                                    'maxItems' => 100,
                                ],
                                'PromotionId' => ['type' => 'string', 'required' => false],
                                'Period' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                'ResourceIds' => [
                                    'type' => 'array',
                                    'required' => false,
                                    'items' => ['type' => 'string', 'required' => false],
                                    'maxItems' => 100,
                                ],
                                'BuyChange' => ['type' => 'boolean', 'required' => false],
                                'InstanceIds' => [
                                    'type' => 'array',
                                    'items' => ['type' => 'string'],
                                    'maxItems' => 100,
                                ],
                            ],
                        ],
                        'maxItems' => 20,
                    ],
                ],
                [
                    'name' => 'OrderType',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Properties',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'additionalProperties' => ['type' => 'string'],
                    ],
                ],
                [
                    'name' => 'ResellerOwnerUid',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                ],
                [
                    'name' => 'ChannelCookie',
                    'in' => 'query',
                    'schema' => ['type' => 'string'],
                ],
            ],
        ],
        'DescribeCreditPackageAgents' => [
            'path' => '',
            'methods' => ['get', 'post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'BizType',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'AgentType',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'AgentIds',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => ['type' => 'string', 'required' => false],
                        'minItems' => 0,
                        'maxItems' => 100,
                    ],
                ],
                [
                    'name' => 'MaxResults',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'NextToken',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
        ],
        'DescribeCreditUsageInfo' => [
            'path' => '',
            'methods' => ['get', 'post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'BizType',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'UsageType',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'InstanceIds',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => ['type' => 'string', 'required' => false],
                        'minItems' => 0,
                        'maxItems' => 100,
                    ],
                ],
            ],
        ],
        'DescribeDeductionStatistic' => [
            'path' => '',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'Periods',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => [
                            'type' => 'object',
                            'required' => false,
                            'properties' => [
                                'PeriodUnit' => ['type' => 'string', 'required' => false],
                                'BaseTime' => ['type' => 'string', 'required' => false],
                            ],
                        ],
                        'maxItems' => 100,
                    ],
                ],
                [
                    'name' => 'ResourceTypes',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => ['type' => 'string', 'required' => false],
                        'maxItems' => 100,
                    ],
                ],
                [
                    'name' => 'StartTime',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                ],
                [
                    'name' => 'EndTime',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                ],
                [
                    'name' => 'InstanceIds',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => ['type' => 'string', 'required' => false],
                        'maxItems' => 100,
                    ],
                ],
            ],
        ],
        'DescribeDeliveryAddress' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [],
        ],
        'DescribeMultiPrice' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'OrderItems',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => [
                            'type' => 'object',
                            'required' => false,
                            'properties' => [
                                'Amount' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                'ResourceType' => ['type' => 'string', 'required' => false],
                                'PeriodUnit' => ['type' => 'string', 'required' => false],
                                'Components' => [
                                    'type' => 'array',
                                    'required' => false,
                                    'items' => [
                                        'type' => 'object',
                                        'required' => false,
                                        'properties' => [
                                            'Key' => ['type' => 'string', 'required' => false],
                                            'Value' => ['type' => 'string', 'required' => false],
                                        ],
                                    ],
                                    'maxItems' => 100,
                                ],
                                'PromotionId' => ['type' => 'string', 'required' => false],
                                'Period' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                                'InstanceIds' => [
                                    'type' => 'array',
                                    'required' => false,
                                    'items' => ['type' => 'string', 'required' => false],
                                    'minItems' => 0,
                                    'maxItems' => 100,
                                ],
                                'ResourceIds' => [
                                    'type' => 'array',
                                    'required' => false,
                                    'items' => ['type' => 'string', 'required' => false],
                                    'minItems' => 0,
                                    'maxItems' => 100,
                                ],
                                'SavingPlanPeriod' => ['type' => 'string', 'required' => false],
                                'Data' => ['type' => 'string'],
                            ],
                        ],
                        'maxItems' => 20,
                    ],
                ],
                [
                    'name' => 'OrderType',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'PackageCode',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'ResellerOwnerUid',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                ],
            ],
        ],
        'DescribePackageDeductions' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'ResourceType',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'PackageIds',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => ['type' => 'string', 'required' => false],
                        'maxItems' => 100,
                    ],
                ],
                [
                    'name' => 'InstanceIds',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => ['type' => 'string', 'required' => false],
                        'maxItems' => 100,
                    ],
                ],
                [
                    'name' => 'PageNum',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'PageSize',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100'],
                ],
                [
                    'name' => 'StartTime',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                ],
                [
                    'name' => 'EndTime',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                ],
                [
                    'name' => 'ResourceTypes',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => ['type' => 'string', 'required' => false],
                        'maxItems' => 100,
                    ],
                ],
            ],
        ],
        'ModifyInstanceProperties' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'ResourceType',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'InstanceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Key',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Value',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'InstanceIds',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => ['type' => 'string', 'required' => false],
                        'maxItems' => 200,
                    ],
                ],
            ],
        ],
        'SetAgentCreditQuota' => [
            'path' => '',
            'methods' => ['get', 'post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'BizType',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'AgentType',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'AgentIds',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => ['type' => 'string', 'required' => false],
                        'maxItems' => 100,
                    ],
                ],
                [
                    'name' => 'CreditQuota',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
            ],
        ],
    ],
    'endpoints' => [
        ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'wss.ap-southeast-1.aliyuncs.com', 'endpoint' => 'wss.ap-southeast-1.aliyuncs.com', 'vpc' => 'wss-vpc.ap-southeast-1.aliyuncs.com'],
        ['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'wss.cn-shanghai.aliyuncs.com', 'endpoint' => 'wss.cn-shanghai.aliyuncs.com', 'vpc' => 'wss.vpc-proxy.aliyuncs.com'],
    ],
];