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
|
<?php return [
'version' => '1.0',
'info' => [
'style' => 'RPC',
'product' => 'cms-export',
'version' => '2021-11-01',
],
'directories' => [
[
'id' => 120930,
'title' => '数据导出',
'type' => 'directory',
'children' => [
'BatchGet',
'Cursor',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'BatchGet' => [
'summary' => '导出在Cursor接口中定义的监控数据。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'formData',
'schema' => [
'description' => '云产品的数据命名空间。'."\n"
."\n"
.'关于如何获取云产品的数据命名空间,请参见[云产品监控项](~~163515~~)。'."\n"
."\n"
.'> 本参数必须与Cursor接口中的请求参数`Namespace`相同。',
'type' => 'string',
'required' => true,
'example' => 'acs_ecs_dashboard',
],
],
[
'name' => 'Metric',
'in' => 'formData',
'schema' => [
'description' => '云产品的监控项名称。'."\n"
."\n"
.'关于如何获取云产品的监控项名称,请参见[云产品监控项](~~163515~~)。'."\n"
."\n"
.'> 本参数必须与Cursor接口中的请求参数`Metric`相同。',
'type' => 'string',
'required' => true,
'example' => 'cpu_idle',
],
],
[
'name' => 'Cursor',
'in' => 'formData',
'schema' => [
'description' => '循环调用本接口导出数据时,必须输入`Cursor`的值。`Cursor`值的获取方法如下:'."\n"
."\n"
.'- 当您初次调用本接口时,必须先调用Cursor接口,获取`Cursor`的值。更多信息,请参见[Cursor](~~391206~~)。'."\n"
."\n"
.'- 当您再次调用本接口时,可以从上次调用本接口的返回数据中获取`Cursor`的值。'."\n",
'type' => 'string',
'required' => true,
'example' => 'eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****',
],
],
[
'name' => 'Length',
'in' => 'formData',
'schema' => [
'description' => '每次最多返回的数据条数。'."\n"
."\n"
.'取值范围:1~10000。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1000',
],
],
[
'name' => 'CompressionType',
'in' => 'formData',
'schema' => [
'description' => '监控数据的压缩类型。'."\n"
."\n"
.'目前仅支持`normal`(不压缩)。',
'type' => 'string',
'required' => false,
'example' => 'normal',
],
],
[
'name' => 'RecordKeyWhiteList',
'in' => 'formData',
'schema' => [
'description' => '监控项统计方法的白名单。'."\n"
."\n"
.'- 如果不设置该参数,则表示返回监控项的所有统计方法的监控数据。'."\n"
."\n"
.'- 如果设置该参数,则表示仅返回白名单中统计方法的监控数据。'."\n"
."\n"
.'关于如何获取监控项的统计方法,请参见[云产品监控项](~~163515~~)中的参数`Statistics`。',
'type' => 'string',
'required' => false,
'example' => 'Maximum',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '251402CD-305C-1617-808E-D8C11FC8138D',
],
'Message' => [
'description' => '返回信息。',
'type' => 'string',
'example' => 'success',
],
'Data' => [
'description' => '返回的数据体。',
'type' => 'object',
'properties' => [
'Cursor' => [
'description' => '用于再次调用本接口。'."\n"
."\n"
.'> 如果返回结果为`null`,则说明监控数据导出完成。'."\n",
'type' => 'string',
'example' => 'eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0=',
],
'Records' => [
'description' => '监控数据导出列表。',
'type' => 'array',
'items' => [
'description' => '-',
'type' => 'object',
'properties' => [
'Namespace' => [
'description' => '云产品的数据命名空间。',
'type' => 'string',
'example' => 'acs_ecs_dashboard',
],
'Metric' => [
'description' => '云产品的监控项名称。',
'type' => 'string',
'example' => 'cpu_idle',
],
'MeasureLabels' => [
'description' => '监控项统计方法的键。'."\n"
."\n"
.'监控项统计方法的格式:key-value键值对形式的集合。',
'type' => 'array',
'items' => [
'description' => '监控项统计方法的键。'."\n"
."\n"
.'监控项统计方法的格式:key-value键值对形式的集合。',
'type' => 'string',
'example' => '[Minimum, Maximum, Average]',
],
],
'MeasureValues' => [
'description' => '监控项统计方法的值。'."\n"
."\n"
.'监控项统计方法的格式:key-value键值对形式的集合。',
'type' => 'array',
'items' => [
'description' => '监控项统计方法的值。'."\n"
."\n"
.'监控项统计方法的格式:key-value键值对形式的集合。',
'type' => 'string',
'example' => '[0.71, 0.81, 0.91]',
],
],
'Labels' => [
'description' => '监控项维度的键。'."\n"
."\n"
.'监控项维度的格式:key-value键值对形式的集合。',
'type' => 'array',
'items' => [
'description' => '监控项维度的键。'."\n"
."\n"
.'监控项维度的格式:key-value键值对形式的集合。',
'type' => 'string',
'example' => '[instanceId, userId]',
],
],
'LabelValues' => [
'description' => '监控项维度的值。'."\n"
."\n"
.'监控项维度的格式:key-value键值对形式的集合。',
'type' => 'array',
'items' => [
'description' => '监控项维度的值。'."\n"
."\n"
.'监控项维度的格式:key-value键值对形式的集合。',
'type' => 'string',
'example' => '[i-0jl0z6wbjh8w4xcv****, 173651113438****]',
],
],
'Tags' => [
'description' => '资源的标签键。'."\n"
."\n"
.'> 目前该参数为空。',
'type' => 'array',
'items' => [
'description' => '资源的标签键。'."\n"
."\n"
.'> 目前该参数为空。',
'type' => 'string',
'example' => '-',
],
],
'TagValues' => [
'description' => '资源的标签值。'."\n"
."\n"
.'> 目前该参数为空。',
'type' => 'array',
'items' => [
'description' => '资源的标签值。'."\n"
."\n"
.'> 目前该参数为空。',
'type' => 'string',
'example' => '-',
],
],
'Timestamp' => [
'description' => '监控数据的时间戳。'."\n"
."\n"
.'单位:毫秒。'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1641454680000',
],
'Period' => [
'description' => '监控数据的统计周期。'."\n"
."\n"
.'单位:秒。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
],
],
],
'Length' => [
'description' => '每次最多返回的数据条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000',
],
'CompressionKeys' => [
'description' => '监控数据压缩类型的键。'."\n"
."\n"
.'> 当`CompressionType`为`normal`时,该参数为空。',
'type' => 'array',
'items' => [
'description' => '监控数据压缩类型的键。'."\n"
."\n"
.'> 当`CompressionType`为`normal`时,该参数为空。',
'type' => 'string',
'example' => '-',
],
],
'CompressionValues' => [
'description' => '监控数据压缩类型的值。',
'type' => 'array',
'items' => [
'description' => '监控数据压缩类型的值。'."\n"
."\n"
.'> 当`CompressionType`为`normal`时,该参数为空。',
'type' => 'array',
'items' => [
'description' => '监控数据压缩类型的值。'."\n"
."\n"
.'> 当`CompressionType`为`normal`时,该参数为空。',
'type' => 'string',
'example' => '-',
],
],
],
'__anchorTs__' => [
'description' => '锚定时间戳',
'type' => 'integer',
'format' => 'int64',
'example' => '1727085162975',
],
],
],
'Code' => [
'description' => '状态码。'."\n"
."\n"
.'> 200表示成功。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Success' => [
'description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"251402CD-305C-1617-808E-D8C11FC8138D\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Cursor\\": \\"eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0=\\",\\n \\"Records\\": [\\n {\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"Metric\\": \\"cpu_idle\\",\\n \\"MeasureLabels\\": [\\n \\"[Minimum, Maximum, Average]\\"\\n ],\\n \\"MeasureValues\\": [\\n \\"[0.71, 0.81, 0.91]\\"\\n ],\\n \\"Labels\\": [\\n \\"[instanceId, userId]\\"\\n ],\\n \\"LabelValues\\": [\\n \\"[i-0jl0z6wbjh8w4xcv****, 173651113438****]\\"\\n ],\\n \\"Tags\\": [\\n \\"-\\"\\n ],\\n \\"TagValues\\": [\\n \\"-\\"\\n ],\\n \\"Timestamp\\": 1641454680000,\\n \\"Period\\": 60\\n }\\n ],\\n \\"Length\\": 1000,\\n \\"CompressionKeys\\": [\\n \\"-\\"\\n ],\\n \\"CompressionValues\\": [\\n [\\n \\"-\\"\\n ]\\n ],\\n \\"__anchorTs__\\": 1727085162975\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<BatchGetResponse>\\n\\t<RequestId>251402CD-305C-1617-808E-D8C11FC8138D</RequestId>\\n\\t<Message>success</Message>\\n\\t<Data>\\n\\t\\t<Cursor>eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0=</Cursor>\\n\\t\\t<Records>\\n\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\n\\t\\t\\t<Metric>cpu_idle</Metric>\\n\\t\\t\\t<MeasureLabels>[Minimum, Maximum, Average]</MeasureLabels>\\n\\t\\t\\t<MeasureValues>[0.71, 0.81, 0.91]</MeasureValues>\\n\\t\\t\\t<Labels>[instanceId, userId]</Labels>\\n\\t\\t\\t<LabelValues>[i-0jl0z6wbjh8w4xcv****, 173651113438****]</LabelValues>\\n\\t\\t\\t<Timestamp>1641454680000</Timestamp>\\n\\t\\t\\t<Period>60</Period>\\n\\t\\t</Records>\\n\\t\\t<Length>1000</Length>\\n\\t</Data>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</BatchGetResponse>\\t","errorExample":""}]',
'title' => '获取导出数据',
'description' => '### 前提条件'."\n"
.'请确保您已调用Cursor接口获取初始的`Cursor`。更多信息,请参见[Cursor](~~391206~~)。'."\n"
."\n"
.'### 使用说明'."\n"
.'本文将提供一个示例,导出云产品`acs_ecs_dashboard`的监控项`cpu_idle`的某个初始`Cursor`的监控数据,且每次最多返回1000条数据。'."\n",
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~382265~~)。',
],
'Cursor' => [
'summary' => '定义导出监控数据的范围并返回用于初始调用BatchGet接口的Cursor参数。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Namespace',
'in' => 'formData',
'schema' => [
'description' => '云产品的数据命名空间。'."\n"
."\n"
.'关于如何获取云产品的数据命名空间,请参见[云产品监控项](~~163515~~)。',
'type' => 'string',
'required' => true,
'example' => 'acs_ecs_dashboard',
],
],
[
'name' => 'Metric',
'in' => 'formData',
'schema' => [
'description' => '云产品的监控项名称。'."\n"
."\n"
.'关于如何获取云产品的监控项名称,请参见[云产品监控项](~~163515~~)。',
'type' => 'string',
'required' => true,
'example' => 'cpu_idle',
],
],
[
'name' => 'Period',
'in' => 'formData',
'schema' => [
'description' => '监控项的时间间隔。'."\n"
."\n"
.'单位:秒。'."\n"
."\n"
.'> 监控项的时间间隔通常为60秒。特殊取值,请参见[云产品监控项](~~163515~~)中的参数`Period`。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '60',
],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => [
'description' => '开始时间戳。'."\n"
."\n"
.'单位:毫秒。'."\n"
."\n"
.'> 由于云监控中的监控数据只能保存90天,建议开始时间与当前时间间隔小于等于90天。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1641627000000',
],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => [
'description' => '结束时间戳。'."\n"
."\n"
.'单位:毫秒。'."\n"
."\n"
.'> 结束时间无限制,可以设置为未来的某个时间。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1641645000000',
],
],
[
'name' => 'Matchers',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '监控项的维度信息。',
'type' => 'array',
'items' => [
'description' => '-',
'type' => 'object',
'properties' => [
'Label' => [
'description' => '监控项维度的键。'."\n"
."\n"
.'监控项维度的格式:key-value键值对形式的集合,例如:`instanceId:i-2ze2d6j5uhg20x47****`或`userId:120886317861****`。'."\n"
."\n"
.'关于如何获取监控项的维度,请参见[云产品监控项](~~163515~~)中的参数`Dimension`。'."\n"
."\n",
'type' => 'string',
'required' => false,
'example' => 'userId',
],
'Value' => [
'description' => '监控项维度的值。'."\n"
."\n"
.'监控项维度的格式:key-value键值对形式的集合,例如:`instanceId:i-2ze2d6j5uhg20x47****`或`userId:120886317861****`。'."\n"
."\n"
.'关于如何获取监控项的维度,请参见[云产品监控项](~~163515~~)中的参数`Dimension`。'."\n",
'type' => 'string',
'required' => false,
'example' => '120886317861****',
],
'Operator' => [
'description' => '监控项维度的匹配关系。'."\n"
."\n"
.'目前仅支持EQUALS(等于)。',
'type' => 'string',
'required' => false,
'example' => 'EQUALS',
],
],
'required' => false,
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '915C2D7A-E6A4-17C3-8E13-4DBDD61E7919',
],
'Message' => [
'description' => '返回信息。',
'type' => 'string',
'example' => 'success',
],
'Data' => [
'description' => '返回的数据体。',
'type' => 'object',
'properties' => [
'Cursor' => [
'description' => '用于首次调用BatchGet接口。',
'type' => 'string',
'example' => 'eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****',
],
],
],
'Code' => [
'description' => '状态码。'."\n"
."\n"
.'> 200表示成功。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Success' => [
'description' => '操作是否成功。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"915C2D7A-E6A4-17C3-8E13-4DBDD61E7919\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Cursor\\": \\"eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****\\"\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CursorResponse>\\n\\t<RequestId>915C2D7A-E6A4-17C3-8E13-4DBDD61E7919</RequestId>\\n\\t<Message>success</Message>\\n\\t<Data>\\n\\t\\t<Cursor>eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****</Cursor>\\n\\t</Data>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</CursorResponse>\\t","errorExample":""}]',
'title' => '获取导出数据初始游标',
'description' => '### 前提条件'."\n"
.'请确保您已开通企业云监控。具体操作,请参见[开通企业云监控](~~250773~~)。'."\n"
."\n"
.'### 背景信息'."\n"
.'先调用本接口获取初始的Cursor,再调用BatchGet接口导出监控数据。更多信息,请参见[BatchGet](~~391205~~)。'."\n"
."\n"
.'### 使用说明'."\n"
.'本文将提供一个示例,定义云产品`acs_ecs_dashboard`的监控项`cpu_idle`在时间段`1641627000000`(2022-01-08 15:30:00)至`1641645000000`(2022-01-08 20:30:00)内每60秒的数据导出范围。返回结果显示`Cursor`信息。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~382265~~)。',
],
],
'endpoints' => [
[
'regionId' => 'cn-shanghai',
'endpoint' => 'cms-export.cn-shanghai.aliyuncs.com',
],
],
];
|