data/zh_cn/arms/2018-12-19/api-docs.php


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

<?php return [
    'version' => '1.0',
    'info' => ['style' => 'V3', 'product' => 'ARMS', 'version' => '2018-12-19'],
    'directories' => [
        [
            'id' => 0,
            'title' => '其它',
            'type' => 'directory',
            'children' => ['ARMSQueryDataSet', 'GetServices', 'MetricQuery', 'GetTrace', 'SearchTraces'],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'ARMSQueryDataSet' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'readAndWrite',
            'systemTags' => ['operationType' => 'get'],
            'parameters' => [
                [
                    'name' => 'IntervalInSec',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'DateStr',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'MinTime',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'MaxTime',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'IsDrillDown',
                    'in' => 'query',
                    'schema' => ['type' => 'boolean', 'required' => false],
                ],
                [
                    'name' => 'OrderByKey',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Limit',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'ReduceTail',
                    'in' => 'query',
                    'schema' => ['type' => 'boolean', 'required' => false],
                ],
                [
                    'name' => 'HungryMode',
                    'in' => 'query',
                    'schema' => ['type' => 'boolean', 'required' => false],
                ],
                [
                    'name' => 'DatasetId',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'Dimensions',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'items' => [
                            'type' => 'object',
                            'properties' => [
                                'Key' => ['type' => 'string', 'required' => false],
                                'Type' => ['type' => 'string', 'required' => false],
                                'Value' => ['type' => 'string', 'required' => false],
                            ],
                        ],
                        'required' => false,
                        'maxItems' => 5,
                    ],
                ],
                [
                    'name' => 'Measures',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'items' => ['type' => 'string'],
                        'required' => false,
                        'maxItems' => 5,
                    ],
                ],
                [
                    'name' => 'RequiredDims',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'items' => [
                            'type' => 'object',
                            'properties' => [
                                'Key' => ['type' => 'string', 'required' => false],
                                'Type' => ['type' => 'string', 'required' => false],
                                'Value' => ['type' => 'string', 'required' => false],
                            ],
                        ],
                        'required' => false,
                        'maxItems' => 5,
                    ],
                ],
                [
                    'name' => 'OptionalDims',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'items' => [
                            'type' => 'object',
                            'properties' => [
                                'Key' => ['type' => 'string', 'required' => false],
                                'Type' => ['type' => 'string', 'required' => false],
                                'Value' => ['type' => 'string', 'required' => false],
                            ],
                        ],
                        'required' => false,
                        'maxItems' => 10,
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'Data' => ['type' => 'string'],
                            'RequestId' => ['type' => 'string'],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                500 => [
                    ['errorCode' => 'InternalError', 'errorMessage' => '必选参数不能为空'],
                ],
            ],
            'responseDemo' => '',
        ],
        'GetServices' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'systemTags' => ['operationType' => 'get'],
            'parameters' => [
                [
                    'name' => 'RegionId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'AppType',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['type' => 'string'],
                            'Data' => [
                                'type' => 'object',
                                'properties' => [
                                    'Details' => [
                                        'type' => 'object',
                                        'itemNode' => true,
                                        'properties' => [
                                            'Details' => [
                                                'type' => 'array',
                                                'items' => [
                                                    'type' => 'object',
                                                    'properties' => [
                                                        'ServiceName' => ['type' => 'string'],
                                                        'Pid' => ['type' => 'string'],
                                                        'RegionId' => ['type' => 'string'],
                                                    ],
                                                ],
                                            ],
                                        ],
                                    ],
                                    'Services' => [
                                        'type' => 'object',
                                        'itemNode' => true,
                                        'properties' => [
                                            'Services' => [
                                                'type' => 'array',
                                                'items' => ['type' => 'string'],
                                            ],
                                        ],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                500 => [
                    ['errorCode' => 'InternalError', 'errorMessage' => '必选参数不能为空'],
                ],
            ],
            'responseDemo' => '',
        ],
        'MetricQuery' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'readAndWrite',
            'systemTags' => ['operationType' => 'get'],
            'parameters' => [
                [
                    'name' => 'IintervalInSec',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'StartTime',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'EndTime',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'Metric',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'OrderBy',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Limit',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'Order',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Filters',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'items' => [
                            'type' => 'object',
                            'properties' => [
                                'Key' => ['type' => 'string', 'required' => false],
                                'Value' => ['type' => 'string', 'required' => false],
                            ],
                        ],
                        'required' => false,
                        'maxItems' => 5,
                    ],
                ],
                [
                    'name' => 'Measures',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'items' => ['type' => 'string'],
                        'required' => true,
                        'maxItems' => 5,
                    ],
                ],
                [
                    'name' => 'Dimensions',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'items' => ['type' => 'string'],
                        'required' => false,
                        'maxItems' => 5,
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'Data' => ['type' => 'string'],
                            'RequestId' => ['type' => 'string'],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                500 => [
                    ['errorCode' => 'InternalError', 'errorMessage' => '必选参数不能为空'],
                ],
            ],
            'responseDemo' => '',
        ],
        'GetTrace' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'systemTags' => ['operationType' => 'get'],
            'parameters' => [
                [
                    'name' => 'TraceID',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'AppType',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'RegionId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['type' => 'string'],
                            'Data' => [
                                'type' => 'object',
                                'itemNode' => true,
                                'properties' => [
                                    'CallChainInfo' => [
                                        'type' => 'array',
                                        'items' => [
                                            'type' => 'object',
                                            'properties' => [
                                                'HaveStack' => ['type' => 'boolean'],
                                                'ServiceIp' => ['type' => 'string'],
                                                'OperationName' => ['type' => 'string'],
                                                'ResultCode' => ['type' => 'string'],
                                                'Duration' => ['type' => 'integer', 'format' => 'int32'],
                                                'RpcId' => ['type' => 'string'],
                                                'Timestamp' => ['type' => 'integer', 'format' => 'int64'],
                                                'ServiceName' => ['type' => 'string'],
                                                'TraceID' => ['type' => 'string'],
                                                'TagEntryList' => [
                                                    'type' => 'object',
                                                    'itemNode' => true,
                                                    'properties' => [
                                                        'TagEntry' => [
                                                            'type' => 'array',
                                                            'items' => [
                                                                'type' => 'object',
                                                                'properties' => [
                                                                    'Key' => ['type' => 'string'],
                                                                    'Value' => ['type' => 'string'],
                                                                ],
                                                            ],
                                                        ],
                                                    ],
                                                ],
                                                'LogEventList' => [
                                                    'type' => 'object',
                                                    'itemNode' => true,
                                                    'properties' => [
                                                        'LogEvent' => [
                                                            'type' => 'array',
                                                            'items' => [
                                                                'type' => 'object',
                                                                'properties' => [
                                                                    'Timestamp' => ['type' => 'integer', 'format' => 'int64'],
                                                                    'TagEntryList' => [
                                                                        'type' => 'object',
                                                                        'itemNode' => true,
                                                                        'properties' => [
                                                                            'TagEntry' => [
                                                                                'type' => 'array',
                                                                                'items' => [
                                                                                    'type' => 'object',
                                                                                    'properties' => [
                                                                                        'Key' => ['type' => 'string'],
                                                                                        'Value' => ['type' => 'string'],
                                                                                    ],
                                                                                ],
                                                                            ],
                                                                        ],
                                                                    ],
                                                                ],
                                                            ],
                                                        ],
                                                    ],
                                                ],
                                            ],
                                        ],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                500 => [
                    ['errorCode' => 'InternalError', 'errorMessage' => '必选参数不能为空'],
                ],
            ],
            'responseDemo' => '',
        ],
        'SearchTraces' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'systemTags' => ['operationType' => 'get'],
            'parameters' => [
                [
                    'name' => 'StartTime',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'EndTime',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'RegionId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
                ],
                [
                    'name' => 'ServiceName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'OperationName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'MinDuration',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                ],
                [
                    'name' => 'AppType',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Tag1',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Tag2',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['type' => 'string'],
                            'Data' => [
                                'type' => 'object',
                                'itemNode' => true,
                                'properties' => [
                                    'TraceInfo' => [
                                        'type' => 'array',
                                        'items' => [
                                            'type' => 'object',
                                            'properties' => [
                                                'OperationName' => ['type' => 'string'],
                                                'ServiceIp' => ['type' => 'string'],
                                                'Duration' => ['type' => 'integer', 'format' => 'int32'],
                                                'Timestamp' => ['type' => 'integer', 'format' => 'int64'],
                                                'ServiceName' => ['type' => 'string'],
                                                'TraceID' => ['type' => 'string'],
                                            ],
                                        ],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                500 => [
                    ['errorCode' => 'InternalError', 'errorMessage' => '必选参数不能为空'],
                ],
            ],
            'responseDemo' => '',
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-qingdao', 'endpoint' => 'arms.cn-qingdao.aliyuncs.com'],
        ['regionId' => 'cn-beijing', 'endpoint' => 'arms.cn-beijing.aliyuncs.com'],
        ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'arms.cn-zhangjiakou.aliyuncs.com'],
        ['regionId' => 'cn-zhengzhou-jva', 'endpoint' => 'arms.cn-zhengzhou-jva.aliyuncs.com'],
        ['regionId' => 'cn-huhehaote', 'endpoint' => 'arms.cn-huhehaote.aliyuncs.com'],
        ['regionId' => 'cn-wulanchabu', 'endpoint' => 'arms.cn-wulanchabu.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou', 'endpoint' => 'arms.cn-hangzhou.aliyuncs.com'],
        ['regionId' => 'cn-shanghai', 'endpoint' => 'arms.cn-shanghai.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen', 'endpoint' => 'arms.cn-shenzhen.aliyuncs.com'],
        ['regionId' => 'cn-heyuan', 'endpoint' => 'arms.cn-heyuan.aliyuncs.com'],
        ['regionId' => 'cn-guangzhou', 'endpoint' => 'arms.cn-guangzhou.aliyuncs.com'],
        ['regionId' => 'cn-chengdu', 'endpoint' => 'arms.cn-chengdu.aliyuncs.com'],
        ['regionId' => 'cn-hongkong', 'endpoint' => 'arms.cn-hongkong.aliyuncs.com'],
        ['regionId' => 'ap-northeast-1', 'endpoint' => 'arms.ap-northeast-1.aliyuncs.com'],
        ['regionId' => 'ap-northeast-2', 'endpoint' => 'arms.ap-northeast-2.aliyuncs.com'],
        ['regionId' => 'ap-southeast-1', 'endpoint' => 'arms.ap-southeast-1.aliyuncs.com'],
        ['regionId' => 'ap-southeast-2', 'endpoint' => 'arms.ap-southeast-2.aliyuncs.com'],
        ['regionId' => 'ap-southeast-3', 'endpoint' => 'arms.ap-southeast-3.aliyuncs.com'],
        ['regionId' => 'ap-southeast-5', 'endpoint' => 'arms.ap-southeast-5.aliyuncs.com'],
        ['regionId' => 'ap-southeast-6', 'endpoint' => 'arms.ap-southeast-6.aliyuncs.com'],
        ['regionId' => 'us-east-1', 'endpoint' => 'arms.us-east-1.aliyuncs.com'],
        ['regionId' => 'us-west-1', 'endpoint' => 'arms.us-west-1.aliyuncs.com'],
        ['regionId' => 'eu-west-1', 'endpoint' => 'arms.eu-west-1.aliyuncs.com'],
        ['regionId' => 'eu-central-1', 'endpoint' => 'arms.eu-central-1.aliyuncs.com'],
        ['regionId' => 'ap-south-1', 'endpoint' => 'arms.ap-south-1.aliyuncs.com'],
        ['regionId' => 'me-east-1', 'endpoint' => 'arms.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou-finance', 'endpoint' => 'arms.cn-hangzhou-finance.aliyuncs.com'],
        ['regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'arms.cn-shanghai-finance-1.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'arms.cn-shenzhen-finance-1.aliyuncs.com'],
        ['regionId' => 'ap-southeast-7', 'endpoint' => 'arms.ap-southeast-7.aliyuncs.com'],
        ['regionId' => 'cn-beijing-finance-1', 'endpoint' => 'arms.aliyuncs.com'],
        ['regionId' => 'me-central-1', 'endpoint' => 'arms.me-central-1.aliyuncs.com'],
        ['regionId' => 'cn-heyuan-acdr-1', 'endpoint' => 'arms.cn-heyuan-acdr-1.aliyuncs.com'],
    ],
];