summaryrefslogtreecommitdiff
path: root/data/openanalytics-open/2020-09-28/api-docs.php
blob: 6b59fae8c7032165dca7a563cbe50576a75d5a97 (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
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'RPC', 'product' => 'openanalytics-open', 'version' => '2020-09-28'],
    'components' => [
        'schemas' => [
            'DatabaseModel' => [
                'type' => 'object',
                'properties' => [
                    'DBId' => ['type' => 'string'],
                    'TenantId' => ['type' => 'string'],
                    'Name' => ['type' => 'string'],
                    'LocationURI ' => ['type' => 'string'],
                    'Description' => ['type' => 'string'],
                    'Parameters' => [
                        'type' => 'object',
                        'additionalProperties' => ['type' => 'string'],
                    ],
                    'OwnerName' => ['type' => 'string'],
                    'OwnerType' => ['type' => 'string'],
                    'CatalogType' => ['type' => 'string'],
                ],
            ],
            'FieldSchemaModel' => [
                'type' => 'object',
                'properties' => [
                    'Name' => ['type' => 'string'],
                    'Type' => ['type' => 'string'],
                    'Comment' => ['type' => 'string'],
                    'SchemaName' => ['type' => 'string'],
                    'TableName' => ['type' => 'string'],
                    'MappedName' => ['type' => 'string'],
                    'DataType' => ['type' => 'string'],
                    'IsPrimaryKey' => ['type' => 'boolean'],
                    'CreateTime' => ['type' => 'integer', 'format' => 'int64'],
                    'UpdateTime' => ['type' => 'integer', 'format' => 'int64'],
                    ' PkPosition' => ['type' => 'integer', 'format' => 'int32'],
                    'IsPartitionKey' => ['type' => 'boolean'],
                ],
            ],
        ],
    ],
    'apis' => [
        'CreateDatabase' => [
            'methods' => ['post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'Name',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'Description',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'LocationUri',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'Parameters',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'object',
                        'required' => false,
                        'additionalProperties' => ['type' => 'string'],
                    ],
                ],
            ],
        ],
        'GetAllDatabases' => [
            'methods' => ['post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [],
        ],
        'AddPartitions' => [
            'methods' => ['post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'Partition',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => [
                        'type' => 'array',
                        'required' => true,
                        'items' => [
                            'type' => 'object',
                            'required' => false,
                            'properties' => [
                                'DbName' => ['type' => 'string', 'required' => true],
                                'Parameters' => [
                                    'type' => 'object',
                                    'required' => false,
                                    'additionalProperties' => ['type' => 'string'],
                                ],
                                'StorageDescriptor' => [
                                    'type' => 'object',
                                    'required' => true,
                                    'properties' => [
                                        'Col' => [
                                            'type' => 'array',
                                            'required' => true,
                                            'items' => [
                                                'type' => 'object',
                                                'required' => false,
                                                'properties' => [
                                                    'Comment' => ['type' => 'string', 'required' => false],
                                                    'Name' => ['type' => 'string', 'required' => false],
                                                    'Type' => ['type' => 'string', 'required' => false],
                                                ],
                                            ],
                                        ],
                                        'InputFormat' => ['type' => 'string', 'required' => true],
                                        'Location' => ['type' => 'string', 'required' => false],
                                        'OutputFormat' => ['type' => 'string', 'required' => true],
                                        'Parameters' => [
                                            'type' => 'object',
                                            'required' => false,
                                            'additionalProperties' => ['type' => 'string'],
                                        ],
                                        'SerDeInfo' => [
                                            'type' => 'object',
                                            'required' => true,
                                            'properties' => [
                                                'Name' => ['type' => 'string', 'required' => false],
                                                'Parameters' => [
                                                    'type' => 'object',
                                                    'required' => false,
                                                    'additionalProperties' => ['type' => 'string'],
                                                ],
                                                'SerializationLib' => ['type' => 'string', 'required' => true],
                                            ],
                                        ],
                                    ],
                                ],
                                'TableName' => ['type' => 'string', 'required' => true],
                                'Values' => [
                                    'type' => 'array',
                                    'required' => true,
                                    'items' => ['type' => 'string', 'required' => true],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ],
        'GetTable' => [
            'methods' => ['post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'DbName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'TableName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'GetAllTables' => [
            'methods' => ['post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'DbName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'DropTable' => [
            'methods' => ['post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'DbName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'TableName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-beijing', 'endpoint' => 'openanalytics.cn-beijing.aliyuncs.com'],
        ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'openanalytics.cn-zhangjiakou.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou', 'endpoint' => 'openanalytics.cn-hangzhou.aliyuncs.com'],
        ['regionId' => 'cn-shanghai', 'endpoint' => 'openanalytics.cn-shanghai.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen', 'endpoint' => 'openanalytics.cn-shenzhen.aliyuncs.com'],
        ['regionId' => 'cn-hongkong', 'endpoint' => 'openanalytics.cn-hongkong.aliyuncs.com'],
        ['regionId' => 'ap-southeast-1', 'endpoint' => 'openanalytics.ap-southeast-1.aliyuncs.com'],
        ['regionId' => 'ap-southeast-2', 'endpoint' => 'datalakeanalytics.ap-southeast-2.aliyuncs.com'],
        ['regionId' => 'ap-southeast-3', 'endpoint' => 'openanalytics.ap-southeast-3.aliyuncs.com'],
        ['regionId' => 'ap-northeast-1', 'endpoint' => 'datalakeanalytics.ap-northeast-1.aliyuncs.com'],
        ['regionId' => 'eu-west-1', 'endpoint' => 'openanalytics.eu-west-1.aliyuncs.com'],
        ['regionId' => 'us-west-1', 'endpoint' => 'openanalytics.us-west-1.aliyuncs.com'],
        ['regionId' => 'us-east-1', 'endpoint' => 'datalakeanalytics.us-east-1.aliyuncs.com'],
        ['regionId' => 'eu-central-1', 'endpoint' => 'datalakeanalytics.eu-central-1.aliyuncs.com'],
        ['regionId' => 'ap-south-1', 'endpoint' => 'openanalytics.ap-south-1.aliyuncs.com'],
        ['regionId' => 'ap-northeast-2-pop', 'endpoint' => 'openanalytics.ap-northeast-1.aliyuncs.com'],
        ['regionId' => 'ap-southeast-5', 'endpoint' => 'openanalytics.ap-southeast-5.aliyuncs.com'],
        ['regionId' => 'cn-beijing-finance-1', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-beijing-finance-pop', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-beijing-gov-1', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-beijing-nu16-b01', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-chengdu', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-edge-1', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-fujian', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-haidian-cm12-c01', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou-bj-b01', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou-finance', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou-internal-prod-1', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou-internal-test-1', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou-internal-test-2', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou-internal-test-3', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou-test-306', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-hongkong-finance-pop', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-huhehaote', 'endpoint' => 'openanalytics.cn-huhehaote.aliyuncs.com'],
        ['regionId' => 'cn-north-2-gov-1', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-qingdao', 'endpoint' => 'openanalytics.cn-qingdao.aliyuncs.com'],
        ['regionId' => 'cn-qingdao-nebula', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-shanghai-et15-b01', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-shanghai-et2-b01', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-shanghai-inner', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-shanghai-internal-test-1', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen-inner', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen-st4-d01', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen-su18-b01', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-wuhan', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-yushanfang', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-zhangbei-na61-b01', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-zhangjiakou-na62-a01', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'cn-zhengzhou-nebula-1', 'endpoint' => 'openanalytics.aliyuncs.com'],
        ['regionId' => 'eu-west-1-oxs', 'endpoint' => 'openanalytics.ap-northeast-1.aliyuncs.com'],
        ['regionId' => 'me-east-1', 'endpoint' => 'openanalytics.me-east-1.aliyuncs.com'],
        ['regionId' => 'rus-west-1-pop', 'endpoint' => 'openanalytics.ap-northeast-1.aliyuncs.com'],
    ],
];