summaryrefslogtreecommitdiff
path: root/data/en_us/cms/2015-10-20/api-docs.php
blob: 6be1eaa739a02d6660a8ed07739b9bd6c261be96 (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
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'RPC', 'product' => 'Cms', 'version' => '2015-10-20'],
    'directories' => [
        [
            'id' => 0,
            'title' => '其它',
            'type' => 'directory',
            'children' => ['DescribeMetricDatum', 'PutDimTableData', 'QueryMetric', 'QueryMetricList'],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'DescribeMetricDatum' => [
            'summary' => 'DescribeMetricDatum',
            'methods' => ['get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
            'parameters' => [
                [
                    'name' => 'callby_cms_owner',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Project',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Metric',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Period',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'StartTime',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'EndTime',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Dimensions',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Page',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Length',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Extend',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'Code' => ['type' => 'string'],
                            'Message' => ['type' => 'string'],
                            'NextToken' => ['type' => 'integer', 'format' => 'int32'],
                            'TraceId' => ['type' => 'string'],
                            'Success' => ['type' => 'string'],
                            'Datapoints' => [
                                'type' => 'object',
                                'itemNode' => true,
                                'properties' => [
                                    'Datapoint' => [
                                        'type' => 'array',
                                        'items' => ['type' => 'string'],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                403 => [
                    ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.'],
                ],
                500 => [
                    ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
                ],
            ],
            'responseDemo' => null,
        ],
        'PutDimTableData' => [
            'summary' => 'PutDimTableData',
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'write',
            'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '当前接口限制了用户以及VPC访问'],
            'parameters' => [
                [
                    'name' => 'callby_cms_owner',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'DimTableName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Body',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'Code' => ['type' => 'string'],
                            'Message' => ['type' => 'string'],
                            'TraceId' => ['type' => 'string'],
                            'Success' => ['type' => 'string'],
                        ],
                    ],
                ],
            ],
            'responseDemo' => null,
        ],
        'QueryMetric' => [
            'summary' => 'QueryMetric',
            'methods' => ['get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
            'parameters' => [
                [
                    'name' => 'callby_cms_owner',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Project',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Metric',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Period',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'StartTime',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'EndTime',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Dimensions',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Page',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Length',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Extend',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'NextToken' => ['type' => 'integer', 'format' => 'int32'],
                            'Success' => ['type' => 'string'],
                            'Code' => ['type' => 'string'],
                            'Message' => ['type' => 'string'],
                            'TraceId' => ['type' => 'string'],
                            'Period' => ['type' => 'string'],
                            'Datapoints' => [
                                'type' => 'object',
                                'itemNode' => true,
                                'properties' => [
                                    'Datapoint' => [
                                        'type' => 'array',
                                        'items' => ['type' => 'string'],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'responseDemo' => null,
        ],
        'QueryMetricList' => [
            'summary' => 'QueryMetricList',
            'methods' => ['get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
            'parameters' => [
                [
                    'name' => 'callby_cms_owner',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Project',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'Metric',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'Period',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'StartTime',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'EndTime',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Dimensions',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Page',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Cursor',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Length',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Express',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'NextToken' => ['type' => 'integer', 'format' => 'int32'],
                            'Cursor' => ['type' => 'string'],
                            'Datapoints' => ['type' => 'string'],
                            'Success' => ['type' => 'string'],
                            'Size' => ['type' => 'string'],
                            'Code' => ['type' => 'string'],
                            'Message' => ['type' => 'string'],
                            'TraceId' => ['type' => 'string'],
                            'Period' => ['type' => 'string'],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                403 => [
                    ['errorCode' => 'Forbidden', 'errorMessage' => 'You are not authorized to operate the specified resource.'],
                ],
                500 => [
                    ['errorCode' => 'InternalUnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.'],
                ],
            ],
            'responseDemo' => null,
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-qingdao', 'endpoint' => 'metrics.cn-qingdao.aliyuncs.com'],
        ['regionId' => 'cn-beijing', 'endpoint' => 'metrics.cn-beijing.aliyuncs.com'],
        ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'metrics.cn-zhangjiakou.aliyuncs.com'],
        ['regionId' => 'cn-zhengzhou-jva', 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com'],
        ['regionId' => 'cn-huhehaote', 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com'],
        ['regionId' => 'cn-wulanchabu', 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou', 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com'],
        ['regionId' => 'cn-shanghai', 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com'],
        ['regionId' => 'cn-nanjing', 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com'],
        ['regionId' => 'cn-fuzhou', 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen', 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com'],
        ['regionId' => 'cn-heyuan', 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com'],
        ['regionId' => 'cn-guangzhou', 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com'],
        ['regionId' => 'cn-chengdu', 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com'],
        ['regionId' => 'cn-hongkong', 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com'],
        ['regionId' => 'cn-wuhan-lr', 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com'],
        ['regionId' => 'cn-zhongwei', 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com'],
        ['regionId' => 'ap-northeast-1', 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com'],
        ['regionId' => 'ap-northeast-2', 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com'],
        ['regionId' => 'ap-southeast-1', 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com'],
        ['regionId' => 'ap-southeast-2', 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com'],
        ['regionId' => 'ap-southeast-3', 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com'],
        ['regionId' => 'ap-southeast-5', 'endpoint' => 'metrics.ap-southeast-5.aliyuncs.com'],
        ['regionId' => 'ap-southeast-6', 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com'],
        ['regionId' => 'ap-southeast-7', 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com'],
        ['regionId' => 'ap-southeast-8', 'endpoint' => 'metrics.ap-southeast-8.aliyuncs.com'],
        ['regionId' => 'us-east-1', 'endpoint' => 'metrics.us-east-1.aliyuncs.com'],
        ['regionId' => 'us-west-1', 'endpoint' => 'metrics.us-west-1.aliyuncs.com'],
        ['regionId' => 'us-southeast-1', 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com'],
        ['regionId' => 'eu-west-1', 'endpoint' => 'metrics.eu-west-1.aliyuncs.com'],
        ['regionId' => 'eu-west-2', 'endpoint' => 'metrics.eu-west-2.aliyuncs.com'],
        ['regionId' => 'na-south-1', 'endpoint' => 'metrics.na-south-1.aliyuncs.com'],
        ['regionId' => 'eu-central-1', 'endpoint' => 'metrics.eu-central-1.aliyuncs.com'],
        ['regionId' => 'ap-south-1', 'endpoint' => 'metrics.ap-south-1.aliyuncs.com'],
        ['regionId' => 'me-east-1', 'endpoint' => 'metrics.me-east-1.aliyuncs.com'],
        ['regionId' => 'me-central-1', 'endpoint' => 'metrics.me-central-1.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou-finance', 'endpoint' => 'metrics.cn-hangzhou-finance.aliyuncs.com'],
        ['regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com'],
        ['regionId' => 'cn-beijing-finance-1', 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com'],
        ['regionId' => 'cn-heyuan-acdr-1', 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com'],
        ['regionId' => 'cn-north-2-gov-1', 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com'],
        ['regionId' => 'cn-wulanchabu-gic-1', 'endpoint' => 'metrics.cn-wulanchabu-gic-1.aliyuncs.com'],
    ],
];