data/zh_cn/iot/2017-06-20/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

<?php return [
    'version' => '1.0',
    'info' => ['style' => 'ROA', 'product' => 'Iot', 'version' => '2017-06-20'],
    'directories' => [
        [
            'id' => 0,
            'title' => '其它',
            'type' => 'directory',
            'children' => ['BatchGetDeviceState', 'GetDeviceShadow', 'GetCats', 'Pub', 'PubBroadcast', 'QueryApplyStatus', 'QueryDevice', 'QueryDeviceByName', 'RegistDevice', 'UpdateDeviceShadow'],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'BatchGetDeviceState' => [
            'path' => '/batchGetDeviceState/{ProductKey}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'ProductKey',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'DeviceName',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'items' => ['type' => 'string'],
                        'required' => true,
                        'maxItems' => 51,
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['type' => 'string'],
                            'ErrorMessage' => ['type' => 'string'],
                            'Success' => ['type' => 'boolean'],
                            'DeviceStatusList' => [
                                'type' => 'object',
                                'itemNode' => true,
                                'properties' => [
                                    'DeviceStatus' => [
                                        'type' => 'array',
                                        'items' => [
                                            'type' => 'object',
                                            'properties' => [
                                                'Status' => ['type' => 'string'],
                                                'LastOnlineTime' => ['type' => 'string'],
                                                'DeviceName' => ['type' => 'string'],
                                                'AsAddress' => ['type' => 'string'],
                                                'DeviceId' => ['type' => 'string'],
                                            ],
                                        ],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [],
            'responseDemo' => '',
        ],
        'GetDeviceShadow' => [
            'path' => '/getDeviceShadow/{ProductKey}/{DeviceName}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'ProductKey',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'DeviceName',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'ShadowMessage',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['type' => 'string'],
                            'ErrorMessage' => ['type' => 'string'],
                            'ShadowMessage' => ['type' => 'string'],
                            'Success' => ['type' => 'boolean'],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [],
            'responseDemo' => '',
        ],
        'GetCats' => [
            'path' => '/getCats/{RootId}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'RootId',
                    'in' => 'path',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['type' => 'string'],
                            'ErrorMessage' => ['type' => 'string'],
                            'Success' => ['type' => 'boolean'],
                            'CatInfo' => [
                                'type' => 'object',
                                'properties' => [
                                    'HasChild' => ['type' => 'boolean'],
                                    'Name' => ['type' => 'string'],
                                    'Id' => ['type' => 'integer', 'format' => 'int64'],
                                    'Childs' => [
                                        'type' => 'object',
                                        'itemNode' => true,
                                        'properties' => [
                                            'ChildCat' => [
                                                'type' => 'array',
                                                'items' => [
                                                    'type' => 'object',
                                                    'properties' => [
                                                        'HasChild' => ['type' => 'boolean'],
                                                        'Name' => ['type' => 'string'],
                                                        'Id' => ['type' => 'integer', 'format' => 'int64'],
                                                    ],
                                                ],
                                            ],
                                        ],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [],
            'responseDemo' => '',
        ],
        'Pub' => [
            'path' => '/pub/{ProductKey}',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'ProductKey',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'Qos',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'integer',
                        'format' => 'int32',
                        'required' => false,
                        'default' => '0',
                        'enum' => ['0', '1'],
                    ],
                ],
                [
                    'name' => 'TopicFullName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'MessageContent',
                    'in' => 'formData',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'MessageId' => ['type' => 'string'],
                            'RequestId' => ['type' => 'string'],
                            'ErrorMessage' => ['type' => 'string'],
                            'Success' => ['type' => 'boolean'],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [],
            'responseDemo' => '',
        ],
        'PubBroadcast' => [
            'path' => '/pubBroadcast/{ProductKey}',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'ProductKey',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'TopicFullName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'MessageContent',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'MessageId' => ['type' => 'integer', 'format' => 'int64'],
                            'RequestId' => ['type' => 'string'],
                            'ErrorMessage' => ['type' => 'string'],
                            'Success' => ['type' => 'boolean'],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [],
            'responseDemo' => '',
        ],
        'QueryApplyStatus' => [
            'path' => '/queryApplyStatus/{ApplyId}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'ApplyId',
                    'in' => 'path',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'Finish' => ['type' => 'boolean'],
                            'RequestId' => ['type' => 'string'],
                            'ErrorMessage' => ['type' => 'string'],
                            'Success' => ['type' => 'boolean'],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [],
            'responseDemo' => '',
        ],
        'QueryDevice' => [
            'path' => '/queryDevice/{ProductKey}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'PageSize',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'ProductKey',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'CurrentPage',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['type' => 'string'],
                            'ErrorMessage' => ['type' => 'string'],
                            'Success' => ['type' => 'boolean'],
                            'PageSize' => ['type' => 'integer', 'format' => 'int32'],
                            'Total' => ['type' => 'integer', 'format' => 'int32'],
                            'PageCount' => ['type' => 'integer', 'format' => 'int32'],
                            'Page' => ['type' => 'integer', 'format' => 'int32'],
                            'Data' => [
                                'type' => 'object',
                                'itemNode' => true,
                                'properties' => [
                                    'DeviceInfo' => [
                                        'type' => 'array',
                                        'items' => [
                                            'type' => 'object',
                                            'properties' => [
                                                'ProductKey' => ['type' => 'string'],
                                                'DeviceName' => ['type' => 'string'],
                                                'DeviceId' => ['type' => 'string'],
                                                'DeviceType' => ['type' => 'string'],
                                                'DeviceSecret' => ['type' => 'string'],
                                                'GmtCreate' => ['type' => 'string'],
                                                'DeviceStatus' => ['type' => 'string'],
                                                'GmtModified' => ['type' => 'string'],
                                            ],
                                        ],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [],
            'responseDemo' => '',
        ],
        'QueryDeviceByName' => [
            'path' => '/queryDeviceByName/{DeviceName}/{ProductKey}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'ProductKey',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'DeviceName',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['type' => 'string'],
                            'ErrorMessage' => ['type' => 'string'],
                            'Success' => ['type' => 'boolean'],
                            'DeviceInfo' => [
                                'type' => 'object',
                                'properties' => [
                                    'ProductKey' => ['type' => 'string'],
                                    'DeviceName' => ['type' => 'string'],
                                    'DeviceId' => ['type' => 'string'],
                                    'DeviceType' => ['type' => 'string'],
                                    'DeviceSecret' => ['type' => 'string'],
                                    'GmtCreate' => ['type' => 'string'],
                                    'DeviceStatus' => ['type' => 'string'],
                                    'GmtModified' => ['type' => 'string'],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [],
            'responseDemo' => '',
        ],
        'RegistDevice' => [
            'path' => '/registDevice/{ProductKey}',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'ProductKey',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'DeviceName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['type' => 'string'],
                            'ErrorMessage' => ['type' => 'string'],
                            'DeviceName' => ['type' => 'string'],
                            'Success' => ['type' => 'boolean'],
                            'DeviceId' => ['type' => 'string'],
                            'DeviceSecret' => ['type' => 'string'],
                            'DeviceStatus' => ['type' => 'string'],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [],
            'responseDemo' => '',
        ],
        'UpdateDeviceShadow' => [
            'path' => '/updateDeviceShadow/{ProductKey}/{DeviceName}',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'ProductKey',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'DeviceName',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'ShadowMessage',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['type' => 'string'],
                            'ErrorMessage' => ['type' => 'string'],
                            'Success' => ['type' => 'boolean'],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [],
            'responseDemo' => '',
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-beijing', 'endpoint' => 'iot.cn-beijing.aliyuncs.com'],
        ['regionId' => 'cn-shanghai', 'endpoint' => 'iot.cn-shanghai.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen', 'endpoint' => 'iot.cn-shenzhen.aliyuncs.com'],
        ['regionId' => 'ap-northeast-1', 'endpoint' => 'iot.ap-northeast-1.aliyuncs.com'],
        ['regionId' => 'ap-southeast-1', 'endpoint' => 'iot.ap-southeast-1.aliyuncs.com'],
        ['regionId' => 'us-east-1', 'endpoint' => 'iot.us-east-1.aliyuncs.com'],
        ['regionId' => 'us-west-1', 'endpoint' => 'iot.us-west-1.aliyuncs.com'],
        ['regionId' => 'eu-central-1', 'endpoint' => 'iot.eu-central-1.aliyuncs.com'],
    ],
];