summaryrefslogtreecommitdiff
path: root/data/iot/2016-01-04/api-docs.php
blob: d21cbef4c5778fb2915f54c8be09756005c2007d (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
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'RPC', 'product' => 'Iot', 'version' => '2016-01-04'],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'DeviceGrant' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'AppKey',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'TopicFullName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'DeviceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'GrantType',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                        'enum' => ['PUB', 'SUB', 'ALL'],
                    ],
                ],
            ],
        ],
        'DevicePermitModify' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'AppKey',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'RuleId',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'DeviceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'TopicFullName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'GrantType',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                        'enum' => ['ALL', 'PUB', 'SUB'],
                    ],
                ],
            ],
        ],
        'DeviceRevokeById' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'AppKey',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'RuleId',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'DeviceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'DeviceRevokeByTopic' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'AppKey',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'TopicFullName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'DeviceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'GrantType',
                    'in' => 'query',
                    'schema' => [
                        'type' => 'string',
                        'required' => true,
                        'enum' => ['PUB', 'SUB', 'ALL'],
                    ],
                ],
            ],
        ],
        'ListDevicePermits' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'AppKey',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'DeviceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'Pub' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'AppKey',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'TopicFullName',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'MessageContent',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'PushByteMessage' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'AppKey',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'DeviceIds',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'PushContent',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'RevertRpc' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'AppKey',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'DeviceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'RpcContent',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'TimeOut',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true],
                ],
            ],
        ],
        'Sub' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'AppKey',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'SubCallback',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'TopicList',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Topic',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => ['type' => 'string'],
                        'maxItems' => 10,
                    ],
                ],
            ],
        ],
        'UnSub' => [
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'parameters' => [
                [
                    'name' => 'AppKey',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'TopicList',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'Topic',
                    'in' => 'query',
                    'style' => 'repeatList',
                    'schema' => [
                        'type' => 'array',
                        'required' => false,
                        'items' => ['type' => 'string'],
                        'maxItems' => 10,
                    ],
                ],
            ],
        ],
    ],
    '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'],
    ],
];