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
|
<?php return [
'version' => '1.0',
'info' => [
'style' => 'RPC',
'product' => 'moguan-sdk',
'version' => '2021-04-15',
],
'directories' => [
[
'id' => 0,
'title' => '其它',
'type' => 'directory',
'children' => [
'RegisterDevice',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'RegisterDevice' => [
'summary' => '设备端SDK注册授权服务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'formData',
'schema' => [
'description' => '端侧SDK授权时必填的appKey信息：用户使用阿里云账号登陆SDK授权中心客户平台后，对已发放授权进行分配和新建批次后，会得到此appKey。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'NWTtS623eqo6s070',
],
],
[
'name' => 'SdkCode',
'in' => 'formData',
'schema' => [
'description' => '端侧SDK授权时必填的SDKCode信息：每个发放的SDK授权都会有唯一的SDKCode信息，登录SDK授权中心客户平台后，可在授权列表获得此信息。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'SDKCodeTest01',
],
],
[
'name' => 'DeviceId',
'in' => 'formData',
'schema' => [
'description' => '端侧SDK授权时必填的DeviceId信息：设备的唯一标识，设备端开发接入时生成，需保证唯一且不变。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '99daf4a623f2b623ae08e79d6d4bf686',
],
],
[
'name' => 'UserDeviceId',
'in' => 'formData',
'schema' => [
'description' => '用户填写的id信息，方便用户管理和记录的授权设备唯一标识，后续可用于排查用户侧授权出现的问题。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'D001',
],
],
[
'name' => 'Extend',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '其他扩展信息，JSON结构，方便后续扩展参数。',
'type' => 'object',
'required' => true,
'docRequired' => true,
'example' => '{}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => [
'description' => '授权接口调用是否成功',
'type' => 'string',
'example' => 'success',
],
'ErrorMessage' => [
'description' => '授权接口调用结果',
'type' => 'string',
'example' => '操作成功',
],
'RequestId' => [
'description' => '授权请求的RequestId',
'type' => 'string',
'example' => 'A68E0F1E-9CEE-4BB9-8880-943730FFD9A9',
],
'ErrorCode' => [
'description' => '授权接口调用成功或失败的错误码',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Data' => [
'description' => '端侧授权返回数据',
'type' => 'object',
'properties' => [
'License' => [
'description' => '云端下发的加密后的授权信息',
'type' => 'string',
'example' => 'rSDUqJEawcrhaHVDXgQQ2vV3eOQDzuos5TAJgx9uolqVaAKkgcBHfWd/jYknsiVeYxsLWyscP0U6ia0XL/u6t7ira9XnI3Jv9qHzosrAW09YrT68VigxqwrutxtexXGgrXFzYmcMMe05rYhEmyyoeNu0CB40HxggXIIw10vH0pvhMLd0ssz6FbaOGhZ/7WDzFAqeXlz7+whZFNlXwaCfIwHTDIj9nBHHsBzWWocOHO==',
],
'Signature' => [
'description' => '云端下发的授权信息加签后的结果',
'type' => 'string',
'example' => 'VnxhWhjL2D3kkGcv8Q/wHzyD6dTEYIDfnIgzDWLS7iQRiCWLu1K+EA+Q6iiH1lpaDNGeQ65zVpbB1wtGMmJymQMJeJ5RHzEo74wwXP48Yfn6tdAoZwtLkxXqZo5N99W/JyEyHyeisC44ZIpLcs1YPv3Wr+uRirUgjHhZXorxJ1E=',
],
'PublicKey' => [
'description' => '客户账户对应的公钥信息',
'type' => 'string',
'example' => 'SSTfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCwdTbYqDHxAlmdSFowPthsG3wKyXdembceyc5j31FZIYGESE4x6ND0al5ejdx26d2ZMRDzlkjnLqUN3snezRA1x0qs92taGXMrIvYDi0dEsz3X/a/VXHPxNu0+/PBT9RYzakLDV9F/6QdYn4PQUvHSTfz2ghaS5SCj++VVDe4CBBIDAAPB',
],
'Rid' => [
'description' => '用户端侧SDK每一次授权记录标识',
'type' => 'string',
'example' => '1082f5e57a004a0799198d4a370c3efa',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Device.GetKeyNoAuthority',
'errorMessage' => 'Failed to request public key. You are not authorized.',
],
[
'errorCode' => 'Device.GetKeyParameterError',
'errorMessage' => 'Failed to request public key. The parameter is invalid.',
],
[
'errorCode' => 'Device.RegisterAlreadyReged',
'errorMessage' => 'This device is already registered.',
],
[
'errorCode' => 'Device.RegisterAppkeyInvalid',
'errorMessage' => 'Failed to register device. The appKey is invalid.',
],
[
'errorCode' => 'Device.RegisterDataError',
'errorMessage' => 'Failed to register device. The data has an error.',
],
[
'errorCode' => 'Device.RegisterNoAuthority',
'errorMessage' => 'Failed to register device. You are not authorized.',
],
[
'errorCode' => 'Device.RegisterNoAvailableQuota',
'errorMessage' => 'Failed to register device. The quota is exhausted.',
],
[
'errorCode' => 'Device.RegisterParameterError',
'errorMessage' => 'Failed to register device. The parameter is invalid.',
],
[
'errorCode' => 'Device.RegisterRetry',
'errorMessage' => 'Failed to register device. Please try again.',
],
[
'errorCode' => 'System.NoAuthority',
'errorMessage' => 'You are not authorized.',
],
[
'errorCode' => 'System.NotLogin',
'errorMessage' => 'You need to login.',
],
[
'errorCode' => 'System.ParameterError',
'errorMessage' => 'The parameter is missing or has an error.',
],
],
500 => [
[
'errorCode' => 'System.InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"ErrorMessage\\": \\"操作成功\\",\\n \\"RequestId\\": \\"A68E0F1E-9CEE-4BB9-8880-943730FFD9A9\\",\\n \\"ErrorCode\\": 0,\\n \\"Data\\": {\\n \\"License\\": \\"rSDUqJEawcrhaHVDXgQQ2vV3eOQDzuos5TAJgx9uolqVaAKkgcBHfWd/jYknsiVeYxsLWyscP0U6ia0XL/u6t7ira9XnI3Jv9qHzosrAW09YrT68VigxqwrutxtexXGgrXFzYmcMMe05rYhEmyyoeNu0CB40HxggXIIw10vH0pvhMLd0ssz6FbaOGhZ/7WDzFAqeXlz7+whZFNlXwaCfIwHTDIj9nBHHsBzWWocOHO==\\",\\n \\"Signature\\": \\"VnxhWhjL2D3kkGcv8Q/wHzyD6dTEYIDfnIgzDWLS7iQRiCWLu1K+EA+Q6iiH1lpaDNGeQ65zVpbB1wtGMmJymQMJeJ5RHzEo74wwXP48Yfn6tdAoZwtLkxXqZo5N99W/JyEyHyeisC44ZIpLcs1YPv3Wr+uRirUgjHhZXorxJ1E=\\",\\n \\"PublicKey\\": \\"SSTfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCwdTbYqDHxAlmdSFowPthsG3wKyXdembceyc5j31FZIYGESE4x6ND0al5ejdx26d2ZMRDzlkjnLqUN3snezRA1x0qs92taGXMrIvYDi0dEsz3X/a/VXHPxNu0+/PBT9RYzakLDV9F/6QdYn4PQUvHSTfz2ghaS5SCj++VVDe4CBBIDAAPB\\",\\n \\"Rid\\": \\"1082f5e57a004a0799198d4a370c3efa\\"\\n }\\n}","type":"json"}]',
'title' => '设备SDK注册授权',
],
],
'endpoints' => [
[
'regionId' => 'ap-northeast-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'ap-northeast-2-pop',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'ap-south-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-2',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-3',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-5',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-beijing',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-finance-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-finance-pop',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-gov-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-nu16-b01',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-chengdu',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-edge-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-fujian',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-haidian-cm12-c01',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-bj-b01',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-finance',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-prod-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-2',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-3',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-test-306',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong-finance-pop',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-huhehaote',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-huhehaote-nebula-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-north-2-gov-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-qingdao',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-qingdao-nebula',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-et15-b01',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-et2-b01',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-finance-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-inner',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-internal-test-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-finance-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-inner',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-st4-d01',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-su18-b01',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-wuhan',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-wulanchabu',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-yushanfang',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-zhangbei',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-zhangbei-na61-b01',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou-na62-a01',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'cn-zhengzhou-nebula-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'eu-central-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'eu-west-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'eu-west-1-oxs',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'me-east-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'rus-west-1-pop',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'us-east-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
[
'regionId' => 'us-west-1',
'endpoint' => 'moguan-sdk.aliyuncs.com',
],
],
];
|
