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
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'moguan-sdk', 'version' => '2021-04-15'],
'directories' => ['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.', 'description' => ''],
['errorCode' => 'Device.GetKeyParameterError', 'errorMessage' => 'Failed to request public key. The parameter is invalid.', 'description' => ''],
['errorCode' => 'Device.RegisterAlreadyReged', 'errorMessage' => 'This device is already registered.', 'description' => ''],
['errorCode' => 'Device.RegisterAppkeyInvalid', 'errorMessage' => 'Failed to register device. The appKey is invalid.', 'description' => ''],
['errorCode' => 'Device.RegisterDataError', 'errorMessage' => 'Failed to register device. The data has an error.', 'description' => ''],
['errorCode' => 'Device.RegisterNoAuthority', 'errorMessage' => 'Failed to register device. You are not authorized.', 'description' => ''],
['errorCode' => 'Device.RegisterNoAvailableQuota', 'errorMessage' => 'Failed to register device. The quota is exhausted.', 'description' => ''],
['errorCode' => 'Device.RegisterParameterError', 'errorMessage' => 'Failed to register device. The parameter is invalid.', 'description' => ''],
['errorCode' => 'Device.RegisterRetry', 'errorMessage' => 'Failed to register device. Please try again.', 'description' => ''],
['errorCode' => 'System.NoAuthority', 'errorMessage' => 'You are not authorized.', 'description' => ''],
['errorCode' => 'System.NotLogin', 'errorMessage' => 'You need to login.', 'description' => ''],
['errorCode' => 'System.ParameterError', 'errorMessage' => 'The parameter is missing or has an error.', 'description' => ''],
],
500 => [
['errorCode' => 'System.InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'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' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-2', 'regionName' => '澳大利亚（悉尼）已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'eu-west-1', 'regionName' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-south-1', 'regionName' => '印度（孟买）已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'me-east-1', 'regionName' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云（邀测）', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [],
'changeSet' => [],
];
|
