summaryrefslogtreecommitdiff
path: root/data/en_us/linkwan/2018-10-30/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
committerZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
commit7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch)
tree0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/linkwan/2018-10-30/api-docs.php
downloadacs-metadata-full-main.tar.gz
acs-metadata-full-main.zip
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.php291
1 files changed, 291 insertions, 0 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
new file mode 100644
index 0000000..937fcfc
--- /dev/null
+++ b/data/en_us/linkwan/2018-10-30/api-docs.php
@@ -0,0 +1,291 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'LinkWAN',
+ 'version' => '2018-10-30',
+ ],
+ 'directories' => [
+ [
+ 'id' => 0,
+ 'title' => '其它',
+ 'type' => 'directory',
+ 'children' => [
+ 'GetKpmEncryptedNodeTuplesByOrderId',
+ 'SubmitKpmEncryptedNodeTupleOrder',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'GetKpmEncryptedNodeTuplesByOrderId' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'OrderId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ 'EncryptedNodeTuples' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'EncryptedNodeTuple' => [
+ 'type' => 'array',
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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.',
+ ],
+ ],
+ ],
+ 'responseDemo' => null,
+ ],
+ 'SubmitKpmEncryptedNodeTupleOrder' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'LoraVersion',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'RequiredCount',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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.',
+ ],
+ ],
+ ],
+ 'responseDemo' => null,
+ ],
+ ],
+ 'endpoints' => [
+ [
+ 'regionId' => 'cn-hangzhou',
+ 'endpoint' => 'linkwan.cn-hangzhou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai',
+ 'endpoint' => 'linkwan.cn-shanghai.aliyuncs.com',
+ ],
+ ],
+];