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
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'moguan-sdk', 'version' => '2021-04-15'],
'directories' => ['RegisterDevice'],
'components' => [
'schemas' => [],
],
'apis' => [
'RegisterDevice' => [
'summary' => 'Registers and authorizes a device-side 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' => 'The appKey required for device-side SDK authorization. After you log on to the SDK Authorization Center customer platform with your Alibaba Cloud account and allocate or create a new batch for issued authorizations, you obtain this appKey.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NWTtS623eqo6s070', 'title' => ''],
],
[
'name' => 'SdkCode',
'in' => 'formData',
'schema' => ['description' => 'The SDKCode required for device-side SDK authorization. Each issued SDK authorization has a unique SDKCode. After you log on to the SDK Authorization Center customer platform, you can obtain this information from the authorization list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SDKCodeTest01', 'title' => ''],
],
[
'name' => 'DeviceId',
'in' => 'formData',
'schema' => ['description' => 'The DeviceId required for device-side SDK authorization. This is the unique identifier of the device, generated during device-side development integration. It must be unique and immutable.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '99daf4a623f2b623ae08e79d6d4bf686', 'title' => ''],
],
[
'name' => 'UserDeviceId',
'in' => 'formData',
'schema' => ['description' => 'The user-specified ID that serves as a unique identifier for the authorized device. This helps you manage and track authorized devices and can be used to troubleshoot authorization issues on the user side.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'D001', 'title' => ''],
],
[
'name' => 'Extend',
'in' => 'formData',
'style' => 'json',
'schema' => ['description' => 'The additional extension information in JSON format for future parameter expansion.', 'type' => 'object', 'required' => true, 'docRequired' => true, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => 'Indicates whether the authorization API call is successful.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'ErrorMessage' => ['description' => 'The result of the authorization API call.', 'type' => 'string', 'example' => '操作成功', 'title' => ''],
'RequestId' => ['description' => 'The request ID of the authorization request.', 'type' => 'string', 'example' => 'A68E0F1E-9CEE-4BB9-8880-943730FFD9A9', 'title' => ''],
'ErrorCode' => ['description' => 'The error code returned when the authorization API call succeeds or fails.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Data' => [
'description' => 'The data returned by the device-side authorization.',
'type' => 'object',
'properties' => [
'License' => ['description' => 'The encrypted authorization information issued by the cloud.', 'type' => 'string', 'example' => 'rSDUqJEawcrhaHVDXgQQ2vV3eOQDzuos5TAJgx9uolqVaAKkgcBHfWd/jYknsiVeYxsLWyscP0U6ia0XL/u6t7ira9XnI3Jv9qHzosrAW09YrT68VigxqwrutxtexXGgrXFzYmcMMe05rYhEmyyoeNu0CB40HxggXIIw10vH0pvhMLd0ssz6FbaOGhZ/7WDzFAqeXlz7+whZFNlXwaCfIwHTDIj9nBHHsBzWWocOHO==', 'title' => ''],
'Signature' => ['description' => 'The signature generated from the authorization information issued by the cloud.', 'type' => 'string', 'example' => 'VnxhWhjL2D3kkGcv8Q/wHzyD6dTEYIDfnIgzDWLS7iQRiCWLu1K+EA+Q6iiH1lpaDNGeQ65zVpbB1wtGMmJymQMJeJ5RHzEo74wwXP48Yfn6tdAoZwtLkxXqZo5N99W/JyEyHyeisC44ZIpLcs1YPv3Wr+uRirUgjHhZXorxJ1E=', 'title' => ''],
'PublicKey' => ['description' => 'The public key associated with the customer account.', 'type' => 'string', 'example' => 'SSTfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCwdTbYqDHxAlmdSFowPthsG3wKyXdembceyc5j31FZIYGESE4x6ND0al5ejdx26d2ZMRDzlkjnLqUN3snezRA1x0qs92taGXMrIvYDi0dEsz3X/a/VXHPxNu0+/PBT9RYzakLDV9F/6QdYn4PQUvHSTfz2ghaS5SCj++VVDe4CBBIDAAPB', 'title' => ''],
'Rid' => ['description' => 'The identifier for each authorization record of the user device-side SDK.', 'type' => 'string', 'example' => '1082f5e57a004a0799198d4a370c3efa', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'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' => 'Register and authorize a device SDK',
'changeSet' => [],
],
],
'endpoints' => [
['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'moguan-sdk.aliyuncs.com', 'endpoint' => 'moguan-sdk.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [],
'changeSet' => [],
];
|
