summaryrefslogtreecommitdiff
path: root/data/iot/2017-06-20/api-docs.php
blob: 715deb89e57acbc1eb3ce492f6fd2ab6cd979e9d (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
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'ROA', 'product' => 'Iot', 'version' => '2017-06-20'],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'BatchGetDeviceState' => [
            'path' => '/batchGetDeviceState/{ProductKey}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'ProductKey',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'DeviceName',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'required' => true,
                        'items' => ['type' => 'string'],
                        'maxItems' => 51,
                    ],
                ],
            ],
        ],
        'GetDeviceShadow' => [
            'path' => '/getDeviceShadow/{ProductKey}/{DeviceName}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            '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],
                ],
            ],
        ],
        'GetCats' => [
            'path' => '/getCats/{RootId}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'RootId',
                    'in' => 'path',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
            ],
        ],
        'Pub' => [
            'path' => '/pub/{ProductKey}',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'ProductKey',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'Qos',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'integer',
                        'format' => 'int32',
                        'required' => false,
                        'enum' => ['0', '1'],
                    ],
                ],
                [
                    'name' => 'TopicFullName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'MessageContent',
                    'in' => 'formData',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'PubBroadcast' => [
            'path' => '/pubBroadcast/{ProductKey}',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            '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],
                ],
            ],
        ],
        'QueryApplyStatus' => [
            'path' => '/queryApplyStatus/{ApplyId}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'ApplyId',
                    'in' => 'path',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
            ],
        ],
        'QueryDevice' => [
            'path' => '/queryDevice/{ProductKey}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            '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],
                ],
            ],
        ],
        'QueryDeviceByName' => [
            'path' => '/queryDeviceByName/{DeviceName}/{ProductKey}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'ProductKey',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'DeviceName',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'RegistDevice' => [
            'path' => '/registDevice/{ProductKey}',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'ProductKey',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'DeviceName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
        ],
        'UpdateDeviceShadow' => [
            'path' => '/updateDeviceShadow/{ProductKey}/{DeviceName}',
            'methods' => ['post'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            '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],
                ],
            ],
        ],
    ],
    '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'],
    ],
];