summaryrefslogtreecommitdiff
path: root/data/en_us/linkwan/2018-10-30/api-docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'data/en_us/linkwan/2018-10-30/api-docs.php')
-rw-r--r--data/en_us/linkwan/2018-10-30/api-docs.php250
1 files changed, 54 insertions, 196 deletions
diff --git a/data/en_us/linkwan/2018-10-30/api-docs.php b/data/en_us/linkwan/2018-10-30/api-docs.php
index 937fcfc..8ba6a97 100644
--- a/data/en_us/linkwan/2018-10-30/api-docs.php
+++ b/data/en_us/linkwan/2018-10-30/api-docs.php
@@ -1,19 +1,12 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'LinkWAN',
- 'version' => '2018-10-30',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'LinkWAN', 'version' => '2018-10-30'],
'directories' => [
[
'id' => 0,
'title' => '其它',
'type' => 'directory',
- 'children' => [
- 'GetKpmEncryptedNodeTuplesByOrderId',
- 'SubmitKpmEncryptedNodeTupleOrder',
- ],
+ 'children' => ['GetKpmEncryptedNodeTuplesByOrderId', 'SubmitKpmEncryptedNodeTupleOrder'],
],
],
'components' => [
@@ -21,14 +14,8 @@
],
'apis' => [
'GetKpmEncryptedNodeTuplesByOrderId' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -41,11 +28,7 @@
[
'name' => 'OrderId',
'in' => 'formData',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
],
],
'responses' => [
@@ -53,27 +36,13 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'EncryptedSessionZmk' => [
- 'type' => 'string',
- ],
- 'DynamicMessage' => [
- 'type' => 'string',
- ],
- 'DynamicCode' => [
- 'type' => 'string',
- ],
+ 'RequestId' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
+ 'Code' => ['type' => 'string'],
+ 'Message' => ['type' => 'string'],
+ 'EncryptedSessionZmk' => ['type' => 'string'],
+ 'DynamicMessage' => ['type' => 'string'],
+ 'DynamicCode' => ['type' => 'string'],
'EncryptedNodeTuples' => [
'type' => 'object',
'itemNode' => true,
@@ -83,33 +52,15 @@
'items' => [
'type' => 'object',
'properties' => [
- 'AppKeyKcv' => [
- 'type' => 'string',
- ],
- 'DevEui' => [
- 'type' => 'string',
- ],
- 'EncryptedNwkKey' => [
- 'type' => 'string',
- ],
- 'NwkKeyKcv' => [
- 'type' => 'string',
- ],
- 'EncryptedGenAppKey' => [
- 'type' => 'string',
- ],
- 'PinCode' => [
- 'type' => 'string',
- ],
- 'GenAppKeyKcv' => [
- 'type' => 'string',
- ],
- 'LoraVersion' => [
- 'type' => 'string',
- ],
- 'EncryptedAppKey' => [
- 'type' => 'string',
- ],
+ 'AppKeyKcv' => ['type' => 'string'],
+ 'DevEui' => ['type' => 'string'],
+ 'EncryptedNwkKey' => ['type' => 'string'],
+ 'NwkKeyKcv' => ['type' => 'string'],
+ 'EncryptedGenAppKey' => ['type' => 'string'],
+ 'PinCode' => ['type' => 'string'],
+ 'GenAppKeyKcv' => ['type' => 'string'],
+ 'LoraVersion' => ['type' => 'string'],
+ 'EncryptedAppKey' => ['type' => 'string'],
],
],
],
@@ -121,58 +72,23 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'NoLicense',
- 'errorMessage' => 'The user does not have the role license required to call this method.',
- ],
- [
- 'errorCode' => 'ForbiddenByRam',
- 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
- ],
- [
- 'errorCode' => 'ForbiddenByRiskControl',
- 'errorMessage' => 'This operation cannot be performed because of security risks.',
- ],
- [
- 'errorCode' => 'NonExistent',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
- [
- 'errorCode' => 'NodeTuple.ExceedTupleLicenseLimit',
- 'errorMessage' => 'The key cannot be generated. The number of requests has exceeded the maximum number of tuple licenses as set out in the user agreement.',
- ],
- [
- 'errorCode' => 'NodeTuple.KpmKeysGenerationFailed',
- 'errorMessage' => 'An error occurred while KPM is generating keys.',
- ],
- [
- 'errorCode' => 'NodeTuple.KpmPublicKeyUnregistered',
- 'errorMessage' => 'The publicKey for KPM is not registered.',
- ],
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'You must specify the parameter.',
- ],
+ ['errorCode' => 'NoLicense', 'errorMessage' => 'The user does not have the role license required to call this method.'],
+ ['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.'],
+ ['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.'],
+ ['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.'],
+ ['errorCode' => 'NodeTuple.ExceedTupleLicenseLimit', 'errorMessage' => 'The key cannot be generated. The number of requests has exceeded the maximum number of tuple licenses as set out in the user agreement.'],
+ ['errorCode' => 'NodeTuple.KpmKeysGenerationFailed', 'errorMessage' => 'An error occurred while KPM is generating keys.'],
+ ['errorCode' => 'NodeTuple.KpmPublicKeyUnregistered', 'errorMessage' => 'The publicKey for KPM is not registered.'],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify the parameter.'],
],
],
'responseDemo' => null,
],
'SubmitKpmEncryptedNodeTupleOrder' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -185,19 +101,12 @@
[
'name' => 'LoraVersion',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'RequiredCount',
'in' => 'formData',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
],
],
'responses' => [
@@ -205,87 +114,36 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'DynamicMessage' => [
- 'type' => 'string',
- ],
- 'OrderId' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'DynamicCode' => [
- 'type' => 'string',
- ],
+ 'RequestId' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
+ 'Code' => ['type' => 'string'],
+ 'Message' => ['type' => 'string'],
+ 'DynamicMessage' => ['type' => 'string'],
+ 'OrderId' => ['type' => 'integer', 'format' => 'int64'],
+ 'DynamicCode' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'NoLicense',
- 'errorMessage' => 'The user does not have the role license required to call this method.',
- ],
- [
- 'errorCode' => 'ForbiddenByRam',
- 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
- ],
- [
- 'errorCode' => 'ForbiddenByRiskControl',
- 'errorMessage' => 'This operation cannot be performed because of security risks.',
- ],
- [
- 'errorCode' => 'NodeTuple.ExceedTupleLicenseLimit',
- 'errorMessage' => 'The key cannot be generated. The number of requests has exceeded the maximum number of tuple licenses as set out in the user agreement.',
- ],
- [
- 'errorCode' => 'NodeTuple.KpmKeysGenerationFailed',
- 'errorMessage' => 'An error occurred while KPM is generating keys.',
- ],
- [
- 'errorCode' => 'NodeTuple.KpmPublicKeyUnregistered',
- 'errorMessage' => 'The publicKey for KPM is not registered.',
- ],
- [
- 'errorCode' => 'NonExistent',
- 'errorMessage' => 'The specified resource does not exist.',
- ],
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'You must specify the parameter.',
- ],
+ ['errorCode' => 'NoLicense', 'errorMessage' => 'The user does not have the role license required to call this method.'],
+ ['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.'],
+ ['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.'],
+ ['errorCode' => 'NodeTuple.ExceedTupleLicenseLimit', 'errorMessage' => 'The key cannot be generated. The number of requests has exceeded the maximum number of tuple licenses as set out in the user agreement.'],
+ ['errorCode' => 'NodeTuple.KpmKeysGenerationFailed', 'errorMessage' => 'An error occurred while KPM is generating keys.'],
+ ['errorCode' => 'NodeTuple.KpmPublicKeyUnregistered', 'errorMessage' => 'The publicKey for KPM is not registered.'],
+ ['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.'],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'You must specify the parameter.'],
],
],
'responseDemo' => null,
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'linkwan.cn-hangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'linkwan.cn-shanghai.aliyuncs.com',
- ],
+ ['regionId' => 'cn-hangzhou', 'endpoint' => 'linkwan.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'endpoint' => 'linkwan.cn-shanghai.aliyuncs.com'],
],
];