summaryrefslogtreecommitdiff
path: root/data/rds-data/2022-03-30/api-docs.php
blob: c99da1ac6638c2105484e62a11f1f9b0d0f5cfa7 (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
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'RPC',
        'product' => 'rds-data',
        'version' => '2022-03-30',
    ],
    'components' => [
        'schemas' => [
            'BatchExecuteStatementResult' => [
                'type' => 'object',
                'properties' => [
                    'GeneratedFieldsList' => [
                        'type' => 'array',
                        'items' => [
                            'type' => 'array',
                            'items' => [
                                '$ref' => '#/components/schemas/Field',
                            ],
                        ],
                    ],
                ],
            ],
            'BeginTransactionResult' => [
                'type' => 'object',
                'properties' => [
                    'TransactionId' => [
                        'type' => 'string',
                    ],
                ],
            ],
            'ColumnMetadata' => [
                'type' => 'object',
                'properties' => [
                    'ArrayBaseColumnType' => [
                        'type' => 'integer',
                        'format' => 'int32',
                    ],
                    'IsAutoIncrement' => [
                        'type' => 'boolean',
                    ],
                    'IsCaseSensitive' => [
                        'type' => 'boolean',
                    ],
                    'IsCurrency' => [
                        'type' => 'boolean',
                    ],
                    'IsSigned' => [
                        'type' => 'boolean',
                    ],
                    'Label' => [
                        'type' => 'string',
                    ],
                    'Name' => [
                        'type' => 'string',
                    ],
                    'Nullable' => [
                        'type' => 'integer',
                        'format' => 'int32',
                    ],
                    'Precision' => [
                        'type' => 'integer',
                        'format' => 'int32',
                    ],
                    'Scale' => [
                        'type' => 'integer',
                        'format' => 'int32',
                    ],
                    'SchemaName' => [
                        'type' => 'string',
                    ],
                    'TableName' => [
                        'type' => 'string',
                    ],
                    'Type' => [
                        'type' => 'integer',
                        'format' => 'int32',
                    ],
                    'TypeName' => [
                        'type' => 'string',
                    ],
                ],
            ],
            'CommitTransactionResult' => [
                'type' => 'object',
                'properties' => [
                    'TransactionStatus' => [
                        'type' => 'string',
                    ],
                ],
            ],
            'DeleteResult' => [
                'type' => 'object',
                'properties' => [
                    'NumberOfRecordsUpdated' => [
                        'type' => 'integer',
                        'format' => 'int64',
                    ],
                ],
            ],
            'ExecuteStatementResult' => [
                'type' => 'object',
                'properties' => [
                    'ColumnMetadata' => [
                        'type' => 'array',
                        'items' => [
                            '$ref' => '#/components/schemas/ColumnMetadata',
                        ],
                    ],
                    'FormattedRecords' => [
                        'type' => 'string',
                    ],
                    'GeneratedFields' => [
                        'type' => 'array',
                        'items' => [
                            '$ref' => '#/components/schemas/Field',
                        ],
                    ],
                    'NumberOfRecordsUpdated' => [
                        'type' => 'integer',
                        'format' => 'int64',
                    ],
                    'Records' => [
                        'type' => 'array',
                        'items' => [
                            'type' => 'array',
                            'items' => [
                                '$ref' => '#/components/schemas/Field',
                            ],
                        ],
                    ],
                ],
            ],
            'Field' => [
                'type' => 'object',
                'properties' => [
                    'ArrayValue' => [
                        'type' => 'string',
                    ],
                    'BlobValue' => [
                        'type' => 'string',
                    ],
                    'BooleanValue' => [
                        'type' => 'boolean',
                    ],
                    'IsNull' => [
                        'type' => 'boolean',
                    ],
                    'LongValue' => [
                        'type' => 'integer',
                        'format' => 'int64',
                    ],
                    'StringValue' => [
                        'type' => 'string',
                    ],
                ],
            ],
            'InsertListResult' => [
                'type' => 'object',
                'properties' => [
                    'NumberOfRecordsUpdated' => [
                        'type' => 'integer',
                        'format' => 'int64',
                    ],
                    'AutoIncrementKeys' => [
                        'type' => 'array',
                        'items' => [
                            'type' => 'integer',
                            'format' => 'int64',
                        ],
                    ],
                ],
            ],
            'InsertResult' => [
                'type' => 'object',
                'properties' => [
                    'NumberOfRecordsUpdated' => [
                        'type' => 'integer',
                        'format' => 'int64',
                    ],
                    'AutoIncrementKey' => [
                        'type' => 'integer',
                        'format' => 'int64',
                    ],
                ],
            ],
            'ResultSetOptions' => [
                'type' => 'object',
                'properties' => [
                    'DecimalReturnType' => [
                        'type' => 'string',
                    ],
                    'LongReturnType' => [
                        'type' => 'string',
                    ],
                ],
            ],
            'RollbackTransactionResult' => [
                'type' => 'object',
                'properties' => [
                    'TransactionStatus' => [
                        'type' => 'string',
                    ],
                ],
            ],
            'SelectResult' => [
                'type' => 'object',
                'properties' => [
                    'Records' => [
                        'type' => 'array',
                        'items' => [
                            'type' => 'object',
                            'additionalProperties' => [
                                'type' => 'any',
                            ],
                        ],
                    ],
                ],
            ],
            'Selector' => [
                'type' => 'object',
                'properties' => [
                    'Lt' => [
                        'type' => 'string',
                    ],
                    'Le' => [
                        'type' => 'string',
                    ],
                    'Gt' => [
                        'type' => 'string',
                    ],
                    'Ge' => [
                        'type' => 'string',
                    ],
                    'Eq' => [
                        'type' => 'string',
                    ],
                    'Ne' => [
                        'type' => 'string',
                    ],
                    'Like' => [
                        'type' => 'string',
                    ],
                ],
            ],
            'SqlParameter' => [
                'type' => 'object',
                'properties' => [
                    'Name' => [
                        'type' => 'string',
                    ],
                    'TypeHint' => [
                        'type' => 'string',
                    ],
                    'Value' => [
                        '$ref' => '#/components/schemas/Field',
                    ],
                ],
            ],
            'UpdateResult' => [
                'type' => 'object',
                'properties' => [
                    'NumberOfRecordsUpdated' => [
                        'type' => 'integer',
                        'format' => 'int64',
                    ],
                ],
            ],
        ],
    ],
    'apis' => [
        'BeginTransaction' => [
            'methods' => [
                'post',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'SecretArn',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
                [
                    'name' => 'ResourceArn',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
                [
                    'name' => 'Database',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
            ],
        ],
        'CommitTransaction' => [
            'methods' => [
                'post',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'SecretArn',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
                [
                    'name' => 'ResourceArn',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
                [
                    'name' => 'TransactionId',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
            ],
        ],
        'RollbackTransaction' => [
            'methods' => [
                'post',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'SecretArn',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
                [
                    'name' => 'ResourceArn',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
                [
                    'name' => 'TransactionId',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
            ],
        ],
        'InsertList' => [
            'methods' => [
                'post',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'SecretArn',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
                [
                    'name' => 'ResourceArn',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
                [
                    'name' => 'Database',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'Table',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
                [
                    'name' => 'TransactionId',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'Records',
                    'in' => 'formData',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => [
                            'type' => 'object',
                            'required' => false,
                            'additionalProperties' => [
                                'type' => 'any',
                            ],
                        ],
                    ],
                ],
            ],
        ],
        'ExecuteStatement' => [
            'methods' => [
                'post',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'SecretArn',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
                [
                    'name' => 'ResourceArn',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
                [
                    'name' => 'Database',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
                [
                    'name' => 'ContinueAfterTimeout',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'boolean',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'FormatRecordsAs',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'IncludeResultMetadata',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'boolean',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'Sql',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
                [
                    'name' => 'TransactionId',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'Parameters',
                    'in' => 'formData',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => [
                            '$ref' => '#/components/schemas/SqlParameter',
                            'required' => false,
                        ],
                    ],
                ],
                [
                    'name' => 'ResultSetOptions',
                    'in' => 'formData',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'properties' => [
                            'DecimalReturnType' => [
                                'type' => 'string',
                                'required' => false,
                            ],
                            'LongReturnType' => [
                                'type' => 'string',
                                'required' => false,
                            ],
                        ],
                    ],
                ],
            ],
        ],
        'BatchExecuteStatement' => [
            'methods' => [
                'post',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'SecretArn',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
                [
                    'name' => 'ResourceArn',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
                [
                    'name' => 'Database',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'Sql',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                    ],
                ],
                [
                    'name' => 'TransactionId',
                    'in' => 'formData',
                    'schema' => [
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'ParameterSets',
                    'in' => 'formData',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => [
                            'type' => 'array',
                            'required' => false,
                            'items' => [
                                '$ref' => '#/components/schemas/SqlParameter',
                                'required' => false,
                            ],
                        ],
                    ],
                ],
            ],
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'cn-hangzhou',
            'endpoint' => 'rds-data.cn-hangzhou.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-beijing',
            'endpoint' => 'rds-data.cn-beijing.aliyuncs.com',
        ],
    ],
];