'1.0',
'info' => ['style' => 'RPC', 'product' => 'LinkWAN', 'version' => '2018-12-30'],
'directories' => [
[
'id' => 65445,
'title' => null,
'type' => 'directory',
'children' => ['GetGatewayTransferPacketsDownloadUrl', 'GetNodeGroupTransferPacketsDownloadUrl'],
],
[
'id' => 65448,
'title' => null,
'type' => 'directory',
'children' => ['GetFreqBandPlanGroup', 'ListFreqBandPlanGroups'],
],
[
'id' => 65451,
'title' => null,
'type' => 'directory',
'children' => ['UpdateNotificationsHandleState', 'GetNotification', 'ListNotifications', 'CountNotifications'],
],
[
'id' => 65456,
'title' => null,
'type' => 'directory',
'children' => ['DescribeRegions', 'ListActivatedFeatures', 'GetUserLicense', 'CheckCloudProductOpenStatus', 'SendUnicastCommand'],
],
[
'id' => 65462,
'title' => null,
'type' => 'directory',
'children' => ['CreateGateway', 'DeleteGateway', 'UpdateGateway', 'UpdateGatewayEnablingState', 'GetGateway', 'GetGatewayPacketStat', 'GetGatewayStatusStat', 'GetGatewayTupleOrder', 'GetGatewayTuplesDownloadUrl', 'ListActiveGateways', 'ListGatewayOnlineRecords', 'ListGateways', 'ListGatewaysGisInfo', 'ListGatewayTransferFlowStats', 'ListGatewayTransferPackets', 'ListGatewayTupleOrders', 'CountGateways', 'CountGatewayTupleOrders', 'SubmitGatewayTupleOrder'],
],
[
'id' => 65482,
'title' => null,
'type' => 'directory',
'children' => ['CreateLocalJoinPermission', 'DeleteLocalJoinPermission', 'UpdateOwnedLocalJoinPermission', 'UpdateOwnedLocalJoinPermissionEnablingState', 'UpdateRoamingJoinPermission', 'UpdateRoamingJoinPermissionEnablingState', 'GetJoinPermissionAuthOrder', 'GetOwnedJoinPermission', 'GetRentedJoinPermission', 'ListOwnedJoinPermissions', 'ListRentedJoinPermissions', 'AcceptJoinPermissionAuthOrder', 'ApplyRoamingJoinPermission', 'CancelJoinPermissionAuthOrder', 'CountOwnedJoinPermissions', 'CountRentedJoinPermissions', 'RejectJoinPermissionAuthOrder', 'ReturnJoinPermission', 'SubmitJoinPermissionAuthOrder'],
],
[
'id' => 65502,
'title' => null,
'type' => 'directory',
'children' => [
'AddNodeToGroup', 'CreateNodeGroup', 'DeleteNodeGroup', 'UpdateDataDispatchConfig', 'UpdateDataDispatchEnablingState', 'UpdateNodeGroup', 'GetNode', 'GetNodeGroup', 'GetNodeTupleOrder', 'GetNodeTuplesDownloadUrl', 'ListNodeGroups', 'ListNodeGroupTransferFlowStats', 'ListNodeGroupTransferPackets', 'ListNodesByNodeGroupId', 'ListNodesByOwnedJoinPermissionId', 'ListNodeTransferPacketPaths', 'ListNodeTupleOrders', 'BindJoinPermissionToNodeGroup', 'CountNodeGroups', 'CountNodesByNodeGroupId',
'CountNodesByOwnedJoinPermissionId', 'CountNodeTupleOrders', 'RemoveNodeFromGroup', 'SubmitNodeTupleOrder', 'UnbindJoinPermissionFromNodeGroup',
],
],
[
'id' => 0,
'title' => '其它',
'type' => 'directory',
'children' => [
'BindLabNodeToLabGateway', 'CountLabGateways', 'CountLabNodes', 'CreateCustomLocalJoinPermission', 'CreateLabGateway', 'CreateLabNode', 'DeleteExternalNodeTuples', 'DeleteLabGateway', 'DeleteLabNode', 'GetKpmPublicKey', 'GetLabGateway', 'GetLabGatewayGwmpConfig', 'GetLabNode', 'GetLabNodeDebugConfig', 'GetLabNodeDownlinkConfig', 'GetLabNodeJoinAcceptConfig', 'ListBoundLabGateways', 'ListBoundLabNodes', 'ListLabGatewayLogs', 'ListLabGateways',
'ListLabNodeLogs', 'ListLabNodes', 'RebootLabGateway', 'RegisterKpmPublicKey', 'SendBusinessCommandToLabNode', 'SendMacCommandToLabNode', 'SubmitExternalNodeTuplesImportingTask', 'SubmitExternalNodesAddingTask', 'TriggerLabGatewayDeviceInfoReport', 'TriggerLabGatewayConfigReport', 'TriggerLabGatewayLogReport', 'UnbindLabNodeFromLabGateway', 'UnregisterKpmPublicKey', 'UpdateEmbeddedNsAutoSyncEnablingState', 'UpdateLabGateway', 'UpdateLabGatewayGwmpConfig', 'UpdateLabGatewaySshCtrl', 'UpdateLabGatewayUartCtrl', 'UpdateLabNode', 'UpdateLabNodeDebugConfig',
'UpdateLabNodeDownlinkConfig', 'UpdateLabNodeJoinAcceptConfig',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'GetGatewayTransferPacketsDownloadUrl' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '0000000000000001'],
],
[
'name' => 'Category',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'DOWNLINK_PACKET',
'enum' => ['DOWNLINK_PACKET', 'UPLINK_PACKET', 'INVALID_PACKET'],
],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'LOG_MILLIS',
'enum' => ['LOG_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '', 'type' => 'string', 'example' => 'http://xxx.xxx.xxx/xxx.csv'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"http://xxx.xxx.xxx/xxx.csv\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n http://xxx.xxx.xxx/xxx.csv\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetGatewayTransferPacketsDownloadUrl',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetNodeGroupTransferPacketsDownloadUrl' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '0000000000000001'],
],
[
'name' => 'Category',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'DOWNLINK_PACKET',
'enum' => ['DOWNLINK_PACKET', 'UPLINK_PACKET', 'INVALID_PACKET'],
],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'LOG_MILLIS',
'enum' => ['LOG_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '', 'type' => 'string', 'example' => 'http://xxx.xxx.xxx/xxx.csv'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"http://xxx.xxx.xxx/xxx.csv\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n http://xxx.xxx.xxx/xxx.csv\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetNodeGroupTransferPacketsDownloadUrl',
],
'GetFreqBandPlanGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '201'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'EndFrequency' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '925'],
'GroupId' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '201'],
'FrequencyType' => ['description' => '', 'type' => 'string', 'example' => 'SAME_FREQUENCY'],
'FrequencyRegionId' => ['description' => '', 'type' => 'string', 'example' => 'CN'],
'BeginFrequency' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '923'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"EndFrequency\\": 925,\\n \\"GroupId\\": 201,\\n \\"FrequencyType\\": \\"SAME_FREQUENCY\\",\\n \\"FrequencyRegionId\\": \\"CN\\",\\n \\"BeginFrequency\\": 923\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 923\\r\\n 925\\r\\n CN\\r\\n 201\\r\\n SAME_FREQUENCY\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetFreqBandPlanGroup',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListFreqBandPlanGroups' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndFrequency' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '510'],
'GroupId' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '101'],
'FrequencyType' => ['description' => '', 'type' => 'string', 'example' => 'SAME_FREQUENCY'],
'FrequencyRegionId' => ['description' => '', 'type' => 'string', 'example' => 'CN'],
'BeginFrequency' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '470'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": [\\n {\\n \\"EndFrequency\\": 510,\\n \\"GroupId\\": 101,\\n \\"FrequencyType\\": \\"SAME_FREQUENCY\\",\\n \\"FrequencyRegionId\\": \\"CN\\",\\n \\"BeginFrequency\\": 470\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n \\r\\n 470\\r\\n 510\\r\\n CN\\r\\n 101\\r\\n SAME_FREQUENCY\\r\\n \\r\\n \\r\\n 470\\r\\n 510\\r\\n CN\\r\\n 102\\r\\n DIFF_FREQUENCY\\r\\n \\r\\n \\r\\n 923\\r\\n 925\\r\\n CN\\r\\n 201\\r\\n SAME_FREQUENCY\\r\\n \\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListFreqBandPlanGroups',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateNotificationsHandleState' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'NotificationId',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => ['type' => 'integer', 'format' => 'int64'],
'required' => true,
'example' => '1',
'maxItems' => 100,
],
],
[
'name' => 'TargetHandleState',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'HANDLED',
'enum' => ['HANDLED', 'UNHANDLED'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateNotificationsHandleState',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetNotification' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'NotificationId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'NoticeMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'Category' => ['description' => '', 'type' => 'string', 'example' => 'GATEWAY_OFFLINE'],
'HandleState' => ['description' => '', 'type' => 'string', 'example' => 'UNHANDLED'],
'NotificationId' => ['description' => '', 'type' => 'string', 'example' => '123'],
'HandledMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000001'],
'GatewayOfflineInfo' => [
'description' => '',
'type' => 'object',
'properties' => [
'GwEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'OfflineMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
],
],
'JoinPermissionAuthInfo' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanceledMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'ApplyingMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'JoinEui' => ['description' => '', 'type' => 'string', 'example' => 'd896e0'],
'RenterAliyunId' => ['description' => '', 'type' => 'string', 'example' => 'some-user2'],
'AcceptedMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'OwnerAliyunId' => ['description' => '', 'type' => 'string', 'example' => 'some-user1'],
'RejectedMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'JoinPermissionId' => ['description' => '', 'type' => 'string', 'example' => '123'],
'JoinPermissionName' => ['description' => '', 'type' => 'string', 'example' => ''],
'OrderState' => ['description' => '', 'type' => 'string', 'example' => 'ACCEPTED'],
'OrderId' => ['description' => '', 'type' => 'string', 'example' => '123'],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"NoticeMillis\\": 1514736000000,\\n \\"Category\\": \\"GATEWAY_OFFLINE\\",\\n \\"HandleState\\": \\"UNHANDLED\\",\\n \\"NotificationId\\": \\"123\\",\\n \\"HandledMillis\\": 1514736000001,\\n \\"GatewayOfflineInfo\\": {\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"OfflineMillis\\": 1514736000000\\n },\\n \\"JoinPermissionAuthInfo\\": {\\n \\"CanceledMillis\\": 1514736000000,\\n \\"ApplyingMillis\\": 1514736000000,\\n \\"JoinEui\\": \\"d896e0\\",\\n \\"RenterAliyunId\\": \\"some-user2\\",\\n \\"AcceptedMillis\\": 1514736000000,\\n \\"OwnerAliyunId\\": \\"some-user1\\",\\n \\"RejectedMillis\\": 1514736000000,\\n \\"JoinPermissionId\\": \\"123\\",\\n \\"JoinPermissionName\\": \\"凭证1\\",\\n \\"OrderState\\": \\"ACCEPTED\\",\\n \\"OrderId\\": \\"123\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n GATEWAY_OFFLINE\\r\\n \\r\\n 0000000000000000\\r\\n 1514736000000\\r\\n \\r\\n 1514736000001\\r\\n UNHANDLED\\r\\n 123\\r\\n 1514736000000\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetNotification',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListNotifications' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Category',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => ['type' => 'string'],
'required' => false,
'example' => 'GATEWAY_OFFLINE',
'maxItems' => 100,
],
],
[
'name' => 'HandleState',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'HANDLED',
'enum' => ['HANDLED', 'UNHANDLED'],
],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'NOTICE_MILLIS',
'enum' => ['NOTICE_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'NoticeMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'Category' => ['description' => '', 'type' => 'string', 'example' => 'GATEWAY_OFFLINE'],
'HandleState' => ['description' => '', 'type' => 'string', 'example' => 'HANDLED'],
'NotificationId' => ['description' => '', 'type' => 'string', 'example' => '123'],
'HandledMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000001'],
'GatewayOfflineInfo' => [
'description' => '',
'type' => 'object',
'properties' => [
'GwEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'OfflineMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
],
],
'JoinPermissionAuthInfo' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanceledMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'ApplyingMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'JoinEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000001'],
'RenterAliyunId' => ['description' => '', 'type' => 'string', 'example' => 'some-user'],
'AcceptedMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'OwnerAliyunId' => ['description' => '', 'type' => 'string', 'example' => 'some-user1'],
'RejectedMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'JoinPermissionId' => ['description' => '', 'type' => 'string', 'example' => '126'],
'JoinPermissionName' => ['description' => '', 'type' => 'string', 'example' => ''],
'OrderState' => ['description' => '', 'type' => 'string', 'example' => 'ACCEPTED'],
'OrderId' => ['description' => '', 'type' => 'string', 'example' => '123'],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 100,\\n \\"List\\": [\\n {\\n \\"NoticeMillis\\": 1514736000000,\\n \\"Category\\": \\"GATEWAY_OFFLINE\\",\\n \\"HandleState\\": \\"HANDLED\\",\\n \\"NotificationId\\": \\"123\\",\\n \\"HandledMillis\\": 1514736000001,\\n \\"GatewayOfflineInfo\\": {\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"OfflineMillis\\": 1514736000000\\n },\\n \\"JoinPermissionAuthInfo\\": {\\n \\"CanceledMillis\\": 1514736000000,\\n \\"ApplyingMillis\\": 1514736000000,\\n \\"JoinEui\\": \\"0000000000000001\\",\\n \\"RenterAliyunId\\": \\"some-user\\",\\n \\"AcceptedMillis\\": 1514736000000,\\n \\"OwnerAliyunId\\": \\"some-user1\\",\\n \\"RejectedMillis\\": 1514736000000,\\n \\"JoinPermissionId\\": \\"126\\",\\n \\"JoinPermissionName\\": \\"凭证2\\",\\n \\"OrderState\\": \\"ACCEPTED\\",\\n \\"OrderId\\": \\"123\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 100\\r\\n \\r\\n \\r\\n GATEWAY_OFFLINE\\r\\n \\r\\n 0000000000000000\\r\\n 1514736000000\\r\\n \\r\\n 1514736000000\\r\\n HANDLED\\r\\n 1514736000001\\r\\n 123\\r\\n \\r\\n \\r\\n GATEWAY_OFFLINE\\r\\n \\r\\n 0000000000000000\\r\\n 1514736000000\\r\\n \\r\\n 1514736000001\\r\\n HANDLED\\r\\n 123\\r\\n 1514736000000\\r\\n \\r\\n
\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListNotifications',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CountNotifications' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'Category',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => ['type' => 'string'],
'required' => false,
'example' => 'GATEWAY_OFFLINE',
'maxItems' => 100,
],
],
[
'name' => 'HandleState',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'UNHANDLED'],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1514736000000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 10,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 10\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CountNotifications',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeRegions' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LocalName' => ['type' => 'string'],
'RegionId' => ['type' => 'string'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'ListActivatedFeatures' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'GetUserLicense' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
'RoamingJoinPermissionCount' => ['type' => 'integer', 'format' => 'int64'],
'GatewayTupleCount' => ['type' => 'integer', 'format' => 'int64'],
'GatewayFreeLimit' => ['type' => 'integer', 'format' => 'int64'],
'NodeTupleFreeLimit' => ['type' => 'integer', 'format' => 'int64'],
'NodeTupleCount' => ['type' => 'integer', 'format' => 'int64'],
'NodeFreeLimit' => ['type' => 'integer', 'format' => 'int64'],
'GatewayTupleFreeLimit' => ['type' => 'integer', 'format' => 'int64'],
'GatewayCount' => ['type' => 'integer', 'format' => 'int64'],
'RoamingJoinPermissionFreeLimit' => ['type' => 'integer', 'format' => 'int64'],
'NodeTupleLimit' => ['type' => 'integer', 'format' => 'int64'],
'GatewayLimit' => ['type' => 'integer', 'format' => 'int64'],
'GatewayTupleLimit' => ['type' => 'integer', 'format' => 'int64'],
'LocalJoinPermissionFreeLimit' => ['type' => 'integer', 'format' => 'int64'],
'NodeLimit' => ['type' => 'integer', 'format' => 'int64'],
'RoamingJoinPermissionLimit' => ['type' => 'integer', 'format' => 'int64'],
'NodeCount' => ['type' => 'integer', 'format' => 'int64'],
'LocalJoinPermissionLimit' => ['type' => 'integer', 'format' => 'int64'],
'Oui' => ['type' => 'string'],
'LocalJoinPermissionCount' => ['type' => 'integer', 'format' => 'int64'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'CheckCloudProductOpenStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'ServiceCode',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'SendUnicastCommand' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'MaxRetries',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '1', 'default' => '0'],
],
[
'name' => 'CleanUp',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
[
'name' => 'FPort',
'in' => 'formData',
'schema' => ['description' => 'fPort。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '223', 'minimum' => '1', 'example' => '0'],
],
[
'name' => 'Comfirmed',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
[
'name' => 'Content',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'Abandoned', 'errorMessage' => 'An error occurred while processing this request, because the API has been abandoned.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'SendUnicastCommand',
],
'CreateGateway' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'PinCode',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '000000'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vme'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'my gateway'],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'CommunicationMode',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'HALF_DUPLEX',
'enum' => ['HALF_DUPLEX', 'FULL_DUPLEX'],
],
],
[
'name' => 'City',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ''],
],
[
'name' => 'District',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ''],
],
[
'name' => 'Address',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ''],
],
[
'name' => 'GisCoordinateSystem',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'GCJ-02',
'enum' => ['WGS_84', 'GCJ_02'],
],
],
[
'name' => 'Longitude',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'number', 'format' => 'float', 'required' => true, 'docRequired' => true, 'example' => '123.45678'],
],
[
'name' => 'Latitude',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'number', 'format' => 'float', 'required' => true, 'docRequired' => true, 'example' => '23.45678'],
],
[
'name' => 'AddressCode',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'GwEuiDuplicated', 'errorMessage' => 'A gateway with the same gwEui already exists.'],
['errorCode' => 'GatewayTupleAlreadyAbandoned', 'errorMessage' => 'The specified gateway tuple has been abandoned.'],
['errorCode' => 'IotHubTripleMissing', 'errorMessage' => 'The IoT Platform trituple of this gateway does not exist.'],
['errorCode' => 'InvalidPinCode', 'errorMessage' => 'An error occurred while verifying PinCode.'],
['errorCode' => 'GatewayAlreadyBoundToOthers', 'errorMessage' => 'This gateway has already been bound to another account.'],
['errorCode' => 'ExceedGatewayLimit', 'errorMessage' => 'The maximum number of gateways is exceeded.'],
['errorCode' => 'InvalidFreqBandPlan', 'errorMessage' => 'The frequency band plan is invalid.'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CreateGateway',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteGateway' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'DeleteGateway',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateGateway' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => ''],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => ''],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
],
[
'name' => 'CommunicationMode',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'HALF_DUPLEX',
'enum' => ['HALF_DUPLEX', 'FULL_DUPLEX'],
],
],
[
'name' => 'AddressCode',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
],
[
'name' => 'City',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => ''],
],
[
'name' => 'District',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => ''],
],
[
'name' => 'Address',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => ''],
],
[
'name' => 'GisCoordinateSystem',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'GCJ_02',
'enum' => ['GCJ_02', 'WGS_84'],
],
],
[
'name' => 'Longitude',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '123.45678'],
],
[
'name' => 'Latitude',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '23.45678'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateGateway',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateGatewayEnablingState' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateGatewayEnablingState',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetGateway' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'ClassBSupported' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'FreqBandPlanGroupId' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'District' => ['description' => '', 'type' => 'string', 'example' => ''],
'GisCoordinateSystem' => ['description' => '', 'type' => 'string', 'example' => 'GCJ_02'],
'City' => ['description' => '', 'type' => 'string', 'example' => ''],
'TimeCorrectable' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'OnlineState' => ['description' => '', 'type' => 'string', 'example' => 'OFFLINE'],
'OnlineStateChangedMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'CommunicationMode' => ['description' => '', 'type' => 'string', 'example' => 'HALF_DUPLEX'],
'Description' => ['description' => '', 'type' => 'string', 'example' => ''],
'Enabled' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'ClassBWorking' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'Address' => ['description' => '', 'type' => 'string', 'example' => ''],
'Longitude' => ['description' => '', 'type' => 'number', 'format' => 'float', 'example' => '123.45678'],
'Latitude' => ['description' => '', 'type' => 'number', 'format' => 'float', 'example' => '23.45678'],
'Name' => ['description' => '', 'type' => 'string', 'example' => ''],
'GwEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'AddressCode' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"ClassBSupported\\": true,\\n \\"FreqBandPlanGroupId\\": 123,\\n \\"District\\": \\"某某区\\",\\n \\"GisCoordinateSystem\\": \\"GCJ_02\\",\\n \\"City\\": \\"某某市\\",\\n \\"TimeCorrectable\\": true,\\n \\"OnlineState\\": \\"OFFLINE\\",\\n \\"OnlineStateChangedMillis\\": 1514736000000,\\n \\"CommunicationMode\\": \\"HALF_DUPLEX\\",\\n \\"Description\\": \\"网关描述\\",\\n \\"Enabled\\": true,\\n \\"ClassBWorking\\": true,\\n \\"Address\\": \\"详细地址\\",\\n \\"Longitude\\": 123.45678,\\n \\"Latitude\\": 23.45678,\\n \\"Name\\": \\"网关名称\\",\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"AddressCode\\": 123\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 某某市\\r\\n 网关名称\\r\\n 某某区\\r\\n ONLINE\\r\\n true\\r\\n true\\r\\n 123.45678\\r\\n 23.45678\\r\\n 1514736000000\\r\\n true\\r\\n 详细地址\\r\\n 0000000000000000\\r\\n HALF_DUPLEX\\r\\n true\\r\\n 123\\r\\n 123\\r\\n GCJ-02\\r\\n 网关描述\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetGateway',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetGatewayPacketStat' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514766000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514766000000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'UplinkInvalid' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'UplinkValid' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'DownlinkValid' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'DownlinkInvalid' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"UplinkInvalid\\": 0,\\n \\"UplinkValid\\": 0,\\n \\"DownlinkValid\\": 0,\\n \\"DownlinkInvalid\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetGatewayPacketStat',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetGatewayStatusStat' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'MemoryRadio' => ['description' => '', 'type' => 'number', 'format' => 'float', 'example' => '42.0'],
'OnlineHour' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '42'],
'Enabled' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'TxCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'RxCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'GwEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'OnlineState' => ['description' => '', 'type' => 'string', 'example' => 'ONLINE'],
'CpuRadio' => ['description' => '', 'type' => 'number', 'format' => 'float', 'example' => '42.0'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"MemoryRadio\\": 42,\\n \\"OnlineHour\\": 42,\\n \\"Enabled\\": true,\\n \\"TxCount\\": 10,\\n \\"RxCount\\": 10,\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"OnlineState\\": \\"ONLINE\\",\\n \\"CpuRadio\\": 42\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n ONLINE\\r\\n 42.0\\r\\n 42.0\\r\\n 10\\r\\n 42\\r\\n 10\\r\\n 0000000000000000\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetGatewayStatusStat',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetGatewayTupleOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
'AcceptedMillis' => ['type' => 'integer', 'format' => 'int64'],
'RequiredCount' => ['type' => 'integer', 'format' => 'int64'],
'CreatedMillis' => ['type' => 'integer', 'format' => 'int64'],
'OrderState' => ['type' => 'string'],
'OrderId' => ['type' => 'string'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => null,
],
'GetGatewayTuplesDownloadUrl' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'GatewayTupleOrderNotAccepted', 'errorMessage' => 'The order on gateway tuple downloading is not approved. You cannot download the gateway tuple.'],
],
],
'responseDemo' => null,
],
'ListActiveGateways' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'District' => ['description' => '', 'type' => 'string', 'example' => ''],
'FreqBandPlanGroupId' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'GisCoordinateSystem' => ['description' => '', 'type' => 'string', 'example' => 'GCJ-02'],
'City' => ['description' => '', 'type' => 'string', 'example' => ''],
'OnlineState' => ['description' => '', 'type' => 'string', 'example' => 'ONLINE'],
'CommunicationMode' => ['description' => '', 'type' => 'string', 'example' => 'HALF_DUPLEX'],
'Description' => ['description' => '', 'type' => 'string', 'example' => ''],
'Address' => ['description' => '', 'type' => 'string', 'example' => ''],
'Longitude' => ['description' => '', 'type' => 'number', 'format' => 'float', 'example' => '123.45678'],
'Latitude' => ['description' => '', 'type' => 'number', 'format' => 'float', 'example' => '23.45678'],
'GwEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000123456'],
'Name' => ['description' => '', 'type' => 'string', 'example' => ''],
'AddressCode' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": [\\n {\\n \\"District\\": \\"某某区\\",\\n \\"FreqBandPlanGroupId\\": 123,\\n \\"GisCoordinateSystem\\": \\"GCJ-02\\",\\n \\"City\\": \\"某某市\\",\\n \\"OnlineState\\": \\"ONLINE\\",\\n \\"CommunicationMode\\": \\"HALF_DUPLEX\\",\\n \\"Description\\": \\"网关描述\\",\\n \\"Address\\": \\"详细地址\\",\\n \\"Longitude\\": 123.45678,\\n \\"Latitude\\": 23.45678,\\n \\"GwEui\\": \\"0000000000123456\\",\\n \\"Name\\": \\"网关名称\\",\\n \\"AddressCode\\": 123\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n \\r\\n 某某市\\r\\n 网关名称\\r\\n 某某区\\r\\n ONLINE\\r\\n 123.45678\\r\\n 23.45678\\r\\n 详细地址\\r\\n 0000000000123456\\r\\n HALF_DUPLEX\\r\\n 123\\r\\n 123\\r\\n GCJ-02\\r\\n 网关描述\\r\\n \\r\\n \\r\\n 某某市\\r\\n 网关名称\\r\\n 某某区\\r\\n ONLINE\\r\\n 123.45678\\r\\n 23.45678\\r\\n 详细地址\\r\\n 0000000001123456\\r\\n HALF_DUPLEX\\r\\n 123\\r\\n 123\\r\\n GCJ-02\\r\\n 网关描述\\r\\n \\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListActiveGateways',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListGatewayOnlineRecords' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'OffSet',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '5'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'STATE_CHANGED_MILLIS',
'enum' => ['STATE_CHANGED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '25'],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StateChangedMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514737000000'],
'OnlineState' => ['description' => '', 'type' => 'string', 'example' => 'ONLINE'],
'GwEui' => ['description' => '', 'type' => 'string', 'example' => '000000000000'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 25,\\n \\"List\\": [\\n {\\n \\"StateChangedMillis\\": 1514737000000,\\n \\"OnlineState\\": \\"ONLINE\\",\\n \\"GwEui\\": \\"000000000000\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 25\\r\\n \\r\\n \\r\\n 1514737000000\\r\\n ONLINE\\r\\n \\r\\n \\r\\n 1514737000000\\r\\n ONLINE\\r\\n \\r\\n
\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListGatewayOnlineRecords',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListGateways' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'OnlineState',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ONLINE',
'enum' => ['ONLINE', 'OFFLINE'],
],
],
[
'name' => 'FuzzyGwEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '123456'],
],
[
'name' => 'FuzzyCity',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'CityName'],
],
[
'name' => 'FuzzyName',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'GatewayName'],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
],
[
'name' => 'IsEnabled',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ONLINE_STATE_CHANGED_MILLIS',
'enum' => ['ONLINE_STATE_CHANGED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ClassBSupported' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'FreqBandPlanGroupId' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'District' => ['description' => '', 'type' => 'string', 'example' => ''],
'GisCoordinateSystem' => ['description' => '', 'type' => 'string', 'example' => 'GCJ_02'],
'City' => ['description' => '', 'type' => 'string', 'example' => ''],
'TimeCorrectable' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'OnlineState' => ['description' => '', 'type' => 'string', 'example' => 'ONLINE'],
'OnlineStateChangedMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'CommunicationMode' => ['description' => '', 'type' => 'string', 'example' => 'HALF_DUPLEX'],
'Description' => ['description' => '', 'type' => 'string', 'example' => ''],
'Enabled' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'ClassBWorking' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'Address' => ['description' => '', 'type' => 'string', 'example' => ''],
'Longitude' => ['description' => '', 'type' => 'number', 'format' => 'float', 'example' => '123.45678'],
'Latitude' => ['description' => '', 'type' => 'number', 'format' => 'float', 'example' => '23.45678'],
'Name' => ['description' => '', 'type' => 'string', 'example' => ''],
'GwEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'AddressCode' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 2,\\n \\"List\\": [\\n {\\n \\"ClassBSupported\\": true,\\n \\"FreqBandPlanGroupId\\": 123,\\n \\"District\\": \\"某某区\\",\\n \\"GisCoordinateSystem\\": \\"GCJ_02\\",\\n \\"City\\": \\"某某市\\",\\n \\"TimeCorrectable\\": true,\\n \\"OnlineState\\": \\"ONLINE\\",\\n \\"OnlineStateChangedMillis\\": 1514736000000,\\n \\"CommunicationMode\\": \\"HALF_DUPLEX\\",\\n \\"Description\\": \\"网关描述\\",\\n \\"Enabled\\": true,\\n \\"ClassBWorking\\": true,\\n \\"Address\\": \\"详细地址\\",\\n \\"Longitude\\": 123.45678,\\n \\"Latitude\\": 23.45678,\\n \\"Name\\": \\"网关名称\\",\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"AddressCode\\": 123\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 23\\r\\n \\r\\n \\r\\n 某某市\\r\\n 网关名称\\r\\n 某某区\\r\\n ONLINE\\r\\n true\\r\\n true\\r\\n 123.45678\\r\\n 23.45678\\r\\n 1514736000000\\r\\n true\\r\\n 详细地址\\r\\n 0000000000000000\\r\\n HALF_DUPLEX\\r\\n true\\r\\n 123\\r\\n 123\\r\\n GCJ-02\\r\\n 网关描述\\r\\n \\r\\n \\r\\n 某某市\\r\\n 网关名称\\r\\n 某某区\\r\\n ONLINE\\r\\n true\\r\\n true\\r\\n 123.45678\\r\\n 23.45678\\r\\n 1514736000000\\r\\n true\\r\\n 详细地址\\r\\n 0000000000000000\\r\\n HALF_DUPLEX\\r\\n true\\r\\n 123\\r\\n 123\\r\\n GCJ-02\\r\\n 网关描述\\r\\n \\r\\n
\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListGateways',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListGatewaysGisInfo' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GisSourceType' => ['type' => 'string'],
'FreqBandPlanGroupId' => ['type' => 'integer', 'format' => 'int64'],
'Enabled' => ['type' => 'boolean'],
'GisCoordinateSystem' => ['type' => 'string'],
'Longitude' => ['type' => 'number', 'format' => 'float'],
'Latitude' => ['type' => 'number', 'format' => 'float'],
'OnlineState' => ['type' => 'string'],
'Name' => ['type' => 'string'],
'GwEui' => ['type' => 'string'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'ListGatewayTransferFlowStats' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514737000000'],
],
[
'name' => 'TimeIntervalUnit',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'INTERVAL_IN_HOURS',
'enum' => ['INTERVAL_IN_HOURS', 'INTERVAL_IN_DAYS'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DownlinkCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'StatMillis' => ['description' => '', 'type' => 'string', 'example' => '1514736000000'],
'UplinkCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": [\\n {\\n \\"DownlinkCount\\": 10,\\n \\"StatMillis\\": \\"1514736000000\\",\\n \\"UplinkCount\\": 10\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n \\r\\n 10\\r\\n 10\\r\\n 1514736000000\\r\\n \\r\\n \\r\\n 10\\r\\n 10\\r\\n 1514736000000\\r\\n \\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListGatewayTransferFlowStats',
],
'ListGatewayTransferPackets' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '0000000000000001'],
],
[
'name' => 'Category',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'DOWNLINK_PACKET',
'enum' => ['DOWNLINK_PACKET', 'UPLINK_PACKET', 'INVALID_PACKET'],
],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '2'],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'LOG_MILLIS',
'enum' => ['LOG_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LogMillis' => ['description' => '', 'type' => 'string', 'example' => '1514736000000'],
'ProcessEvent' => ['description' => '', 'type' => 'string', 'example' => 'SUCCESS'],
'Base64EncodedMacPayload' => ['description' => '', 'type' => 'string', 'example' => 'xxx'],
'FPort' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '99'],
'Lsnr' => ['description' => '', 'type' => 'number', 'format' => 'float', 'example' => '-10.5'],
'HasData' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'ClassMode' => ['description' => '', 'type' => 'string', 'example' => 'C'],
'MacPayloadSize' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
'MessageType' => ['description' => '', 'type' => 'string', 'example' => 'JOIN_REQUEST'],
'Datr' => ['description' => '', 'type' => 'string', 'example' => 'SF12BW125'],
'DevAddr' => ['description' => '', 'type' => 'string', 'example' => '00000000'],
'DevEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000001'],
'NodeOwnerAliyunId' => ['description' => '', 'type' => 'string', 'example' => '23546'],
'MacCommandCIDs' => [
'type' => 'string',
'items' => ['description' => '', 'type' => 'string', 'example' => '["0x01","0x02"]', 'index' => 200],
],
'GwEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'Rssi' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '-110'],
'HasMacCommand' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'Freq' => ['description' => '', 'type' => 'string', 'example' => '470.3'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"LogMillis\\": \\"1514736000000\\",\\n \\"ProcessEvent\\": \\"SUCCESS\\",\\n \\"Base64EncodedMacPayload\\": \\"xxx\\",\\n \\"FPort\\": 99,\\n \\"Lsnr\\": -10.5,\\n \\"HasData\\": true,\\n \\"ClassMode\\": \\"C\\",\\n \\"MacPayloadSize\\": 15,\\n \\"MessageType\\": \\"JOIN_REQUEST\\",\\n \\"Datr\\": \\"SF12BW125\\",\\n \\"DevAddr\\": \\"00000000\\",\\n \\"DevEui\\": \\"0000000000000001\\",\\n \\"NodeOwnerAliyunId\\": \\"23546\\",\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"Rssi\\": -110,\\n \\"HasMacCommand\\": true,\\n \\"Freq\\": \\"470.3\\",\\n \\"MacCommandCIDs\\": [\\n \\"[\\\\\\"0x01\\\\\\",\\\\\\"0x02\\\\\\"]\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 10\\r\\n \\r\\n \\r\\n C\\r\\n false\\r\\n 00000000\\r\\n 12\\r\\n 99\\r\\n true\\r\\n 1514736000000\\r\\n SF12BW125\\r\\n xxx\\r\\n DEVADDR_ILLEGAL\\r\\n 0000000000000001\\r\\n -10.5\\r\\n 0000000000000000\\r\\n -110\\r\\n 470.3\\r\\n xxxx\\r\\n \\r\\n \\r\\n C\\r\\n false\\r\\n 00000000\\r\\n 12\\r\\n 99\\r\\n true\\r\\n 1514736000000\\r\\n SF12BW125\\r\\n xxx\\r\\n DEVADDR_ILLEGAL\\r\\n 0000000000000001\\r\\n -10.5\\r\\n 0000000000000000\\r\\n -110\\r\\n 470.3\\r\\n xxxx\\r\\n \\r\\n
\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListGatewayTransferPackets',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListGatewayTupleOrders' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'State',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
'enum' => ['CREATED_MILLIS', 'ACCEPTED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
'TotalCount' => ['type' => 'integer', 'format' => 'int64'],
'List' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AcceptedMillis' => ['type' => 'integer', 'format' => 'int64'],
'RequiredCount' => ['type' => 'integer', 'format' => 'int64'],
'CreatedMillis' => ['type' => 'integer', 'format' => 'int64'],
'OrderState' => ['type' => 'string'],
'OrderId' => ['type' => 'string'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => null,
],
'CountGateways' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'OnlineState',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ONLINE',
'enum' => ['ONLINE', 'OFFLINE'],
],
],
[
'name' => 'FuzzyGwEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '123456'],
],
[
'name' => 'FuzzyCity',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => ''],
],
[
'name' => 'FuzzyName',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'name'],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
],
[
'name' => 'IsEnabled',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CountGateways',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CountGatewayTupleOrders' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'States',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string'],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['type' => 'integer', 'format' => 'int64'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'SubmitGatewayTupleOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'RequiredCount',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'ExceedGatewayTupleLimit', 'errorMessage' => 'The maximum number of gateway tuples is exceeded.'],
],
],
'responseDemo' => null,
],
'CreateLocalJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'FreqBandPlanGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '101'],
],
[
'name' => 'ClassMode',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'A',
'enum' => ['A', 'B', 'C'],
],
],
[
'name' => 'UseDefaultJoinEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
[
'name' => 'JoinPermissionName',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '', 'type' => 'string', 'example' => '123'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'ExceedLocalJoinPermissionLimit', 'errorMessage' => 'The maximum number of local join permissions that you can create is exceeded.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'JoinPermissionNameDuplicated', 'errorMessage' => 'The specified join permission name already exists.'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.'],
['errorCode' => 'InvalidFreqBandPlan', 'errorMessage' => 'The frequency band plan is invalid.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"123\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 123\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CreateLocalJoinPermission',
],
'DeleteLocalJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'JoinPermissionAlreadyAuthorized', 'errorMessage' => 'The specified join permission has already been granted to another renter.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'DeleteLocalJoinPermission',
],
'UpdateOwnedLocalJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '201'],
],
[
'name' => 'ClassMode',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'A',
'enum' => ['A', 'B', 'C'],
],
],
[
'name' => 'JoinPermissionName',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'JoinPermissionAlreadyAuthorized', 'errorMessage' => 'The specified join permission has already been granted to another renter.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'JoinPermissionNameDuplicated', 'errorMessage' => 'The specified join permission name already exists.'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.'],
['errorCode' => 'InvalidFreqBandPlan', 'errorMessage' => 'The frequency band plan is invalid.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateOwnedLocalJoinPermission',
],
'UpdateOwnedLocalJoinPermissionEnablingState' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateOwnedLocalJoinPermissionEnablingState',
],
'UpdateRoamingJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'JoinPermissionName',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'JoinPermissionAlreadyBoundNodeGroup', 'errorMessage' => 'The specified join permission has already been bound to another node group.'],
['errorCode' => 'JoinPermissionNameDuplicated', 'errorMessage' => 'The specified join permission name already exists.'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.'],
],
],
'responseDemo' => null,
],
'UpdateRoamingJoinPermissionEnablingState' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => null,
],
'GetJoinPermissionAuthOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanceledMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'ApplyingMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'RenterAliyunId' => ['description' => '', 'type' => 'string', 'example' => 'some_user'],
'AcceptedMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'OwnerAliyunId' => ['description' => '', 'type' => 'string', 'example' => 'some_user'],
'RejectedMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'JoinPermissionId' => ['description' => '', 'type' => 'string', 'example' => '123456'],
'OrderState' => ['description' => '', 'type' => 'string', 'example' => 'ACCEPTED'],
'OrderId' => ['description' => '', 'type' => 'string', 'example' => '123'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"CanceledMillis\\": 1514736000000,\\n \\"ApplyingMillis\\": 1514736000000,\\n \\"RenterAliyunId\\": \\"some_user\\",\\n \\"AcceptedMillis\\": 1514736000000,\\n \\"OwnerAliyunId\\": \\"some_user\\",\\n \\"RejectedMillis\\": 1514736000000,\\n \\"JoinPermissionId\\": \\"123456\\",\\n \\"OrderState\\": \\"ACCEPTED\\",\\n \\"OrderId\\": \\"123\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 123\\r\\n 1514736000000\\r\\n 1514736000000\\r\\n 1514736000000\\r\\n some_user\\r\\n ACCEPTED\\r\\n some_user\\r\\n 123456\\r\\n 1514736000000\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetJoinPermissionAuthOrder',
],
'GetOwnedJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'RxMonthSum' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TxMonthSum' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'FreqBandPlanGroupId' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '102'],
'TxDailySum' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'JoinPermissionId' => ['description' => '', 'type' => 'string', 'example' => '123'],
'ClassMode' => ['description' => '', 'type' => 'string', 'example' => 'A'],
'DataDispatchDestination' => ['description' => '', 'type' => 'string', 'example' => 'IOT'],
'RxDailySum' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'JoinEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'CreateMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'Enabled' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RenterAliyunId' => ['description' => '', 'type' => 'string', 'example' => 'some-user'],
'NodesCnt' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'JoinPermissionName' => ['description' => '', 'type' => 'string', 'example' => ''],
'AuthState' => ['description' => '', 'type' => 'string', 'example' => 'NEW'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"RxMonthSum\\": 0,\\n \\"TxMonthSum\\": 0,\\n \\"FreqBandPlanGroupId\\": 102,\\n \\"TxDailySum\\": 0,\\n \\"JoinPermissionId\\": \\"123\\",\\n \\"ClassMode\\": \\"A\\",\\n \\"DataDispatchDestination\\": \\"IOT\\",\\n \\"RxDailySum\\": 0,\\n \\"JoinEui\\": \\"0000000000000000\\",\\n \\"CreateMillis\\": 1514736000000,\\n \\"Enabled\\": true,\\n \\"RenterAliyunId\\": \\"some-user\\",\\n \\"NodesCnt\\": 10,\\n \\"JoinPermissionName\\": \\"凭证1\\",\\n \\"AuthState\\": \\"NEW\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 0000000000000000\\r\\n A\\r\\n 0\\r\\n true\\r\\n 1514736000000\\r\\n 0\\r\\n some-user\\r\\n 0\\r\\n 10\\r\\n 0\\r\\n 123\\r\\n IOT\\r\\n 凭证1\\r\\n 102\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetOwnedJoinPermission',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetRentedJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'Type' => ['description' => '', 'type' => 'string', 'example' => 'LOCAL'],
'RxMonthSum' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TxMonthSum' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'FreqBandPlanGroupId' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '102'],
'TxDailySum' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'JoinPermissionId' => ['description' => '', 'type' => 'string', 'example' => '123'],
'ClassMode' => ['description' => '', 'type' => 'string', 'example' => 'A'],
'RxDailySum' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'JoinEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'Enabled' => ['description' => '', 'type' => 'boolean', 'example' => 'false'],
'CreateMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'NodesCnt' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'JoinPermissionName' => ['description' => '', 'type' => 'string', 'example' => ''],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"Type\\": \\"LOCAL\\",\\n \\"RxMonthSum\\": 0,\\n \\"TxMonthSum\\": 0,\\n \\"FreqBandPlanGroupId\\": 102,\\n \\"TxDailySum\\": 0,\\n \\"JoinPermissionId\\": \\"123\\",\\n \\"ClassMode\\": \\"A\\",\\n \\"RxDailySum\\": 0,\\n \\"JoinEui\\": \\"0000000000000000\\",\\n \\"Enabled\\": false,\\n \\"CreateMillis\\": 1514736000000,\\n \\"NodesCnt\\": 10,\\n \\"JoinPermissionName\\": \\"凭证1\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 0000000000000000\\r\\n A\\r\\n 0\\r\\n true\\r\\n 1514736000000\\r\\n 0\\r\\n 0\\r\\n 10\\r\\n 0\\r\\n 123\\r\\n LOCAL\\r\\n 凭证1\\r\\n 102\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetRentedJoinPermission',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListOwnedJoinPermissions' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'FuzzyRenterAliyunId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'some-user'],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'FuzzyJoinPermissionName',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => ''],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'JoinEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'FreqBandPlanGroupId' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '102'],
'Enabled' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RenterAliyunId' => ['description' => '', 'type' => 'string', 'example' => 'some-user1'],
'JoinPermissionId' => ['description' => '', 'type' => 'string', 'example' => '102'],
'JoinPermissionName' => ['description' => '', 'type' => 'string', 'example' => ''],
'ClassMode' => ['description' => '', 'type' => 'string', 'example' => 'A'],
'AuthState' => ['description' => '', 'type' => 'string', 'example' => 'ACCEPTED'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"JoinEui\\": \\"0000000000000000\\",\\n \\"FreqBandPlanGroupId\\": 102,\\n \\"Enabled\\": true,\\n \\"RenterAliyunId\\": \\"some-user1\\",\\n \\"JoinPermissionId\\": \\"102\\",\\n \\"JoinPermissionName\\": \\"凭证1\\",\\n \\"ClassMode\\": \\"A\\",\\n \\"AuthState\\": \\"ACCEPTED\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 10\\r\\n \\r\\n \\r\\n 0000000000000000\\r\\n A\\r\\n true\\r\\n some-user1\\r\\n 123\\r\\n ACCEPTED\\r\\n 凭证1\\r\\n 102\\r\\n \\r\\n \\r\\n 0000000000000001\\r\\n A\\r\\n true\\r\\n some-user2\\r\\n 126\\r\\n ACCEPTED\\r\\n 凭证2\\r\\n 102\\r\\n \\r\\n
\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListOwnedJoinPermissions',
],
'ListRentedJoinPermissions' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'FuzzyOwnerAliyunId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'some-user'],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'BoundNodeGroup',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'LOCAL',
'enum' => ['LOCAL', 'ROAMING'],
],
],
[
'name' => 'FuzzyJoinPermissionName',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => ''],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => '', 'type' => 'string', 'example' => 'LOCAL'],
'JoinEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'FreqBandPlanGroupId' => ['description' => '', 'type' => 'string', 'example' => '102'],
'BoundNodeGroup' => ['description' => '', 'type' => 'boolean', 'example' => 'false'],
'Enabled' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'OwnerAliyunId' => ['description' => '', 'type' => 'string', 'example' => 'some-user1'],
'JoinPermissionId' => ['description' => '', 'type' => 'string', 'example' => '123'],
'JoinPermissionName' => ['description' => '', 'type' => 'string', 'example' => ''],
'ClassMode' => ['description' => '', 'type' => 'string', 'example' => 'A'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"Type\\": \\"LOCAL\\",\\n \\"JoinEui\\": \\"0000000000000000\\",\\n \\"FreqBandPlanGroupId\\": \\"102\\",\\n \\"BoundNodeGroup\\": false,\\n \\"Enabled\\": true,\\n \\"OwnerAliyunId\\": \\"some-user1\\",\\n \\"JoinPermissionId\\": \\"123\\",\\n \\"JoinPermissionName\\": \\"凭证1\\",\\n \\"ClassMode\\": \\"A\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 10\\r\\n \\r\\n \\r\\n 0000000000000000\\r\\n A\\r\\n true\\r\\n false\\r\\n 123\\r\\n some-user1\\r\\n LOCAL\\r\\n 凭证1\\r\\n 102\\r\\n \\r\\n \\r\\n 0000000000000001\\r\\n A\\r\\n true\\r\\n false\\r\\n 126\\r\\n some-user2\\r\\n ROAMING\\r\\n 凭证2\\r\\n 102\\r\\n \\r\\n
\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListRentedJoinPermissions',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AcceptJoinPermissionAuthOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'IllegalOrderStateTransition', 'errorMessage' => 'The order status conversion is invalid.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'AcceptJoinPermissionAuthOrder',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ApplyRoamingJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'FreqBandPlanGroupId',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
],
[
'name' => 'ClassMode',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => true,
'enum' => ['A', 'B', 'C'],
],
],
[
'name' => 'JoinPermissionName',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'ExceedRoamingJoinPermissionLimit', 'errorMessage' => 'The maximum number of roaming join permissions is exceeded.'],
['errorCode' => 'JoinPermissionNameDuplicated', 'errorMessage' => 'The specified join permission name already exists.'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.'],
['errorCode' => 'InvalidFreqBandPlan', 'errorMessage' => 'The frequency band plan is invalid.'],
],
],
'responseDemo' => null,
],
'CancelJoinPermissionAuthOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'IllegalOrderStateTransition', 'errorMessage' => 'The order status conversion is invalid.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CancelJoinPermissionAuthOrder',
],
'CountOwnedJoinPermissions' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'FuzzyRenterAliyunId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'some-user'],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'FuzzyJoinPermissionName',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CountOwnedJoinPermissions',
],
'CountRentedJoinPermissions' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'FuzzyOwnerAliyunId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'some-user'],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'BoundNodeGroup',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'LOCAL'],
],
[
'name' => 'FuzzyJoinPermissionName',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CountRentedJoinPermissions',
],
'RejectJoinPermissionAuthOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'IllegalOrderStateTransition', 'errorMessage' => 'The order status conversion is invalid.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'RejectJoinPermissionAuthOrder',
],
'ReturnJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'JoinPermissionType',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LOCAL'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'JoinPermissionAlreadyBoundNodeGroup', 'errorMessage' => 'The specified join permission has already been bound to another node group.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ReturnJoinPermission',
],
'SubmitJoinPermissionAuthOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'RenterAliyunId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'some_user'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'TooManyRenterNonExistentFailures', 'errorMessage' => 'You have entered invalid renter usernames for several times. Try again later.'],
['errorCode' => 'JoinPermissionAlreadyAuthorized', 'errorMessage' => 'The specified join permission has already been granted to another renter.'],
['errorCode' => 'RenterDoesNotExist', 'errorMessage' => 'The specified renter does not exist.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 1234,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 1234\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'SubmitJoinPermissionAuthOrder',
],
'AddNodeToGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'PinCode',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'],
],
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'ExceedNodeLimit', 'errorMessage' => 'The maximum number of nodes is exceeded.'],
['errorCode' => 'NodeGroupDoesNotExist', 'errorMessage' => 'The specified node group does not exist.'],
['errorCode' => 'DevEuiDuplicated', 'errorMessage' => 'A node with the same devEui already exists.'],
['errorCode' => 'NodeAlreadyAdded', 'errorMessage' => 'The specified node has already been added to another node group.'],
['errorCode' => 'InvalidPinCode', 'errorMessage' => 'An error occurred while verifying PinCode.'],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.'],
['errorCode' => 'NodeDoesNotExist', 'errorMessage' => 'The specified node does not exist.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'AddNodeToGroup',
],
'CreateNodeGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'NodeGroupName',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'group1'],
],
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '', 'type' => 'string', 'example' => '123456'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NodeGroupNameDuplicated', 'errorMessage' => 'The specified node group name already exists.'],
['errorCode' => 'NodeGroupAlreadyBoundJoinPermission', 'errorMessage' => 'This node group is already bound to a join permission.'],
['errorCode' => 'JoinPermissionDoesNotExist', 'errorMessage' => 'The specified join permission does not exist.'],
['errorCode' => 'JoinPermissionAlreadyBoundNodeGroup', 'errorMessage' => 'The specified join permission has already been bound to another node group.'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"123456\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 123456\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CreateNodeGroup',
],
'DeleteNodeGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.'],
['errorCode' => 'NodeGroupAlreadyBoundJoinPermission', 'errorMessage' => 'This node group is already bound to a join permission.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'DeleteNodeGroup',
],
'UpdateDataDispatchConfig' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'DataDispatchDestination',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'IOT',
'enum' => ['IOT', 'MQ'],
],
],
[
'name' => 'ProductType',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'IOT_SUITE',
'enum' => ['IOT_SUITE', 'IOT_SUITE_SENIOR'],
],
],
[
'name' => 'ProductName',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => ''],
],
[
'name' => 'ProductKey',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxx'],
],
[
'name' => 'UplinkRegionName',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
],
[
'name' => 'UplinkTopic',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateDataDispatchConfig',
],
'UpdateDataDispatchEnablingState' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'DataDispatchEnabled',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateDataDispatchEnablingState',
],
'UpdateNodeGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'],
],
[
'name' => 'NodeGroupName',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'group1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'NodeGroupNameDuplicated', 'errorMessage' => 'The specified node group name already exists.'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.'],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateNodeGroup',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetNode' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'LastJoinMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'DevAddr' => ['description' => '', 'type' => 'string', 'example' => '12345678'],
'DevEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'BoundMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'ClassMode' => ['description' => '', 'type' => 'string', 'example' => 'A'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"LastJoinMillis\\": 1514736000000,\\n \\"DevAddr\\": \\"12345678\\",\\n \\"DevEui\\": \\"0000000000000000\\",\\n \\"BoundMillis\\": 1514736000000,\\n \\"ClassMode\\": \\"A\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n A\\r\\n 1514736000000\\r\\n 1514736000000\\r\\n 0000000000000000\\r\\n 12345678\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetNode',
],
'GetNodeGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'RxMonthSum' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'NodeGroupName' => ['description' => '', 'type' => 'string', 'example' => ''],
'JoinPermissionOwnerAliyunId' => ['description' => '', 'type' => 'string', 'example' => 'some-user'],
'TxMonthSum' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'FreqBandPlanGroupId' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '102'],
'TxDailySum' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'JoinPermissionEnabled' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'JoinPermissionId' => ['description' => '', 'type' => 'string', 'example' => '1234569'],
'ClassMode' => ['description' => '', 'type' => 'string', 'example' => 'A'],
'NodeGroupId' => ['description' => '', 'type' => 'string', 'example' => '123456'],
'DataDispatchEnabled' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RxDailySum' => ['description' => '', 'type' => 'string', 'example' => '0'],
'JoinEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'CreateMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'JoinPermissionType' => ['description' => '', 'type' => 'string', 'example' => 'LOCAL'],
'NodesCnt' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'JoinPermissionName' => ['description' => '', 'type' => 'string', 'example' => ''],
'Locks' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LockId' => ['description' => '', 'type' => 'string', 'example' => '123'],
'LockType' => ['description' => '', 'type' => 'string', 'example' => 'WRITE'],
'CreateMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'Enabled' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
],
],
],
'DataDispatchConfig' => [
'description' => '',
'type' => 'object',
'properties' => [
'Destination' => ['description' => '', 'type' => 'string', 'example' => 'IOT'],
'IotProduct' => [
'description' => '',
'type' => 'object',
'properties' => [
'ProductKey' => ['description' => '', 'type' => 'string', 'example' => 'xxxxxxxx'],
'ProductName' => ['description' => '', 'type' => 'string', 'example' => ''],
'ProductType' => ['description' => '', 'type' => 'string', 'example' => 'IOT_SUITE'],
],
],
'OnsTopics' => [
'description' => '',
'type' => 'object',
'properties' => [
'UplinkTopic' => ['description' => '', 'type' => 'string', 'example' => 'topic2'],
'UplinkRegionName' => ['description' => '', 'type' => 'string', 'example' => 'cn-hangzhou'],
'DownlinkRegionName' => ['description' => '', 'type' => 'string', 'example' => 'cn-beijing'],
'DownlinkTopic' => ['description' => '', 'type' => 'string', 'example' => 'topic1'],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"RxMonthSum\\": 0,\\n \\"NodeGroupName\\": \\"节点分组名称\\",\\n \\"JoinPermissionOwnerAliyunId\\": \\"some-user\\",\\n \\"TxMonthSum\\": 0,\\n \\"FreqBandPlanGroupId\\": 102,\\n \\"TxDailySum\\": 0,\\n \\"JoinPermissionEnabled\\": true,\\n \\"JoinPermissionId\\": \\"1234569\\",\\n \\"ClassMode\\": \\"A\\",\\n \\"NodeGroupId\\": \\"123456\\",\\n \\"DataDispatchEnabled\\": true,\\n \\"RxDailySum\\": \\"0\\",\\n \\"JoinEui\\": \\"0000000000000000\\",\\n \\"CreateMillis\\": 1514736000000,\\n \\"JoinPermissionType\\": \\"LOCAL\\",\\n \\"NodesCnt\\": 10,\\n \\"JoinPermissionName\\": \\"凭证1\\",\\n \\"Locks\\": [\\n {\\n \\"LockId\\": \\"123\\",\\n \\"LockType\\": \\"WRITE\\",\\n \\"CreateMillis\\": 1514736000000,\\n \\"Enabled\\": true\\n }\\n ],\\n \\"DataDispatchConfig\\": {\\n \\"Destination\\": \\"IOT\\",\\n \\"IotProduct\\": {\\n \\"ProductKey\\": \\"xxxxxxxx\\",\\n \\"ProductName\\": \\"产品名\\",\\n \\"ProductType\\": \\"IOT_SUITE\\"\\n },\\n \\"OnsTopics\\": {\\n \\"UplinkTopic\\": \\"topic2\\",\\n \\"UplinkRegionName\\": \\"cn-hangzhou\\",\\n \\"DownlinkRegionName\\": \\"cn-beijing\\",\\n \\"DownlinkTopic\\": \\"topic1\\"\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 10\\r\\n 0000000000000000\\r\\n some-user\\r\\n 0\\r\\n LOCAL\\r\\n A\\r\\n 123456\\r\\n true\\r\\n \\r\\n \\r\\n 123\\r\\n 1514736000000\\r\\n true\\r\\n WRITE\\r\\n \\r\\n \\r\\n 126\\r\\n 1514736000000\\r\\n true\\r\\n WRITE\\r\\n \\r\\n \\r\\n true\\r\\n 0\\r\\n 0\\r\\n \\r\\n IOT\\r\\n \\r\\n xxxxxxxx\\r\\n IOT_SUITE\\r\\n 产品名\\r\\n \\r\\n \\r\\n 1514736000000\\r\\n 节点分组名称\\r\\n 0\\r\\n 1234569\\r\\n 102\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetNodeGroup',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetNodeTupleOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
'RequiredCount' => ['type' => 'integer', 'format' => 'int64'],
'CreatedMillis' => ['type' => 'integer', 'format' => 'int64'],
'IsKpm' => ['type' => 'boolean'],
'AcceptedMillis' => ['type' => 'integer', 'format' => 'int64'],
'OrderId' => ['type' => 'string'],
'OrderState' => ['type' => 'string'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => null,
],
'GetNodeTuplesDownloadUrl' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => null,
],
'ListNodeGroups' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'FuzzyName',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RxMonthSum' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'NodeGroupName' => ['description' => '', 'type' => 'string', 'example' => ''],
'JoinPermissionOwnerAliyunId' => ['description' => '', 'type' => 'string', 'example' => 'some-user2'],
'TxMonthSum' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'FreqBandPlanGroupId' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '102'],
'TxDailySum' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'JoinPermissionEnabled' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'JoinPermissionId' => ['description' => '', 'type' => 'string', 'example' => '123456'],
'ClassMode' => ['description' => '', 'type' => 'string', 'example' => 'A'],
'NodeGroupId' => ['description' => '', 'type' => 'string', 'example' => '123456'],
'DataDispatchEnabled' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RxDailySum' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'JoinEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'CreateMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'JoinPermissionType' => ['description' => '', 'type' => 'string', 'example' => 'LOCAL'],
'NodesCnt' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Locks' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LockId' => ['description' => '', 'type' => 'string', 'example' => '123'],
'LockType' => ['description' => '', 'type' => 'string', 'example' => 'WRITE'],
'CreateMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'Enabled' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
],
],
],
'DataDispatchConfig' => [
'description' => '',
'type' => 'object',
'properties' => [
'Destination' => ['description' => '', 'type' => 'string', 'example' => 'IOT'],
'IotProduct' => [
'description' => '',
'type' => 'object',
'properties' => [
'ProductKey' => ['description' => '', 'type' => 'string', 'example' => 'xxxxxxxx'],
'ProductName' => ['description' => '', 'type' => 'string', 'example' => ''],
'ProductType' => ['description' => '', 'type' => 'string', 'example' => 'IOT_SUITE'],
],
],
'OnsTopics' => [
'description' => '',
'type' => 'object',
'properties' => [
'UplinkTopic' => ['description' => '', 'type' => 'string', 'example' => 'topic2'],
'UplinkRegionName' => ['description' => '', 'type' => 'string', 'example' => 'cn-shanghai'],
'DownlinkRegionName' => ['description' => '', 'type' => 'string', 'example' => 'cn-beijing'],
'DownlinkTopic' => ['description' => '', 'type' => 'string', 'example' => 'topic1'],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"RxMonthSum\\": 0,\\n \\"NodeGroupName\\": \\"节点分组名称2\\",\\n \\"JoinPermissionOwnerAliyunId\\": \\"some-user2\\",\\n \\"TxMonthSum\\": 0,\\n \\"FreqBandPlanGroupId\\": 102,\\n \\"TxDailySum\\": 0,\\n \\"JoinPermissionEnabled\\": true,\\n \\"JoinPermissionId\\": \\"123456\\",\\n \\"ClassMode\\": \\"A\\",\\n \\"NodeGroupId\\": \\"123456\\",\\n \\"DataDispatchEnabled\\": true,\\n \\"RxDailySum\\": 0,\\n \\"JoinEui\\": \\"0000000000000000\\",\\n \\"CreateMillis\\": 1514736000000,\\n \\"JoinPermissionType\\": \\"LOCAL\\",\\n \\"NodesCnt\\": 10,\\n \\"Locks\\": [\\n {\\n \\"LockId\\": \\"123\\",\\n \\"LockType\\": \\"WRITE\\",\\n \\"CreateMillis\\": 1514736000000,\\n \\"Enabled\\": true\\n }\\n ],\\n \\"DataDispatchConfig\\": {\\n \\"Destination\\": \\"IOT\\",\\n \\"IotProduct\\": {\\n \\"ProductKey\\": \\"xxxxxxxx\\",\\n \\"ProductName\\": \\"产品名\\",\\n \\"ProductType\\": \\"IOT_SUITE\\"\\n },\\n \\"OnsTopics\\": {\\n \\"UplinkTopic\\": \\"topic2\\",\\n \\"UplinkRegionName\\": \\"cn-shanghai\\",\\n \\"DownlinkRegionName\\": \\"cn-beijing\\",\\n \\"DownlinkTopic\\": \\"topic1\\"\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 10\\r\\n \\r\\n \\r\\n 10\\r\\n 0000000000000000\\r\\n some-user2\\r\\n 0\\r\\n LOCAL\\r\\n A\\r\\n 123456\\r\\n true\\r\\n \\r\\n \\r\\n 123\\r\\n 1514736000000\\r\\n true\\r\\n WRITE\\r\\n \\r\\n \\r\\n 126\\r\\n 1514736000000\\r\\n true\\r\\n WRITE\\r\\n \\r\\n \\r\\n true\\r\\n 0\\r\\n 0\\r\\n \\r\\n IOT\\r\\n \\r\\n xxxxxxxx\\r\\n IOT_SUITE\\r\\n 产品名\\r\\n \\r\\n \\r\\n 1514736000000\\r\\n 节点分组名称2\\r\\n 0\\r\\n 123456\\r\\n 102\\r\\n \\r\\n \\r\\n 10\\r\\n 0000000000000001\\r\\n some-user2\\r\\n 0\\r\\n LOCAL\\r\\n A\\r\\n 1234569\\r\\n true\\r\\n \\r\\n \\r\\n 123\\r\\n LP\\r\\n true\\r\\n nmsUser1\\r\\n 1514736000000\\r\\n WRITE\\r\\n \\r\\n \\r\\n 126\\r\\n LP\\r\\n true\\r\\n nmsUser1\\r\\n 1514736000000\\r\\n WRITE\\r\\n \\r\\n \\r\\n true\\r\\n 0\\r\\n 0\\r\\n \\r\\n IOT\\r\\n \\r\\n xxxxxxxx\\r\\n IOT_SUITE\\r\\n 产品名\\r\\n \\r\\n \\r\\n 1514736000000\\r\\n 节点分组名称2\\r\\n 0\\r\\n 1234569\\r\\n 102\\r\\n \\r\\n
\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListNodeGroups',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListNodeGroupTransferFlowStats' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514737000000'],
],
[
'name' => 'TimeIntervalUnit',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'INTERVAL_IN_HOURS',
'enum' => ['INTERVAL_IN_HOURS', 'INTERVAL_IN_DAYS'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DownlinkCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'StatMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'UplinkCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": [\\n {\\n \\"DownlinkCount\\": 10,\\n \\"StatMillis\\": 1514736000000,\\n \\"UplinkCount\\": 10\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n \\r\\n 10\\r\\n 10\\r\\n 1514736000000\\r\\n \\r\\n \\r\\n 10\\r\\n 10\\r\\n 1514736000000\\r\\n \\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListNodeGroupTransferFlowStats',
],
'ListNodeGroupTransferPackets' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '0000000000000001'],
],
[
'name' => 'Category',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'UPLINK_PACKET',
'enum' => ['DOWNLINK_PACKET', 'UPLINK_PACKET', 'INVALID_PACKET'],
],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '300', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'LOG_MILLIS',
'enum' => ['LOG_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LogMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'GwOwnerAliyunId' => ['description' => '', 'type' => 'string', 'example' => 'xxx'],
'ProcessEvent' => ['description' => '', 'type' => 'string', 'example' => 'SUCCESS'],
'Base64EncodedMacPayload' => ['description' => '', 'type' => 'string', 'example' => 'xxx'],
'FPort' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '99'],
'Lsnr' => ['description' => '', 'type' => 'number', 'format' => 'float', 'example' => '-10.5'],
'FreqBandPlanGroupId' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '101'],
'HasData' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'ClassMode' => ['description' => '', 'type' => 'string', 'example' => 'C'],
'MacPayloadSize' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
'MessageType' => ['description' => '', 'type' => 'string', 'example' => 'JOIN_REQUEST'],
'Datr' => ['description' => '', 'type' => 'string', 'example' => 'SF12BW125'],
'DevAddr' => ['description' => '', 'type' => 'string', 'example' => '00000000'],
'DevEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000001'],
'MacCommandCIDs' => [
'type' => 'string',
'items' => ['description' => '', 'type' => 'string', 'example' => '["0x01","0x02"]', 'index' => 200],
],
'GwEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'Rssi' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '-110'],
'HasMacCommand' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'Freq' => ['description' => '', 'type' => 'number', 'format' => 'float', 'example' => '470.3'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"LogMillis\\": 1514736000000,\\n \\"GwOwnerAliyunId\\": \\"xxx\\",\\n \\"ProcessEvent\\": \\"SUCCESS\\",\\n \\"Base64EncodedMacPayload\\": \\"xxx\\",\\n \\"FPort\\": 99,\\n \\"Lsnr\\": -10.5,\\n \\"FreqBandPlanGroupId\\": 101,\\n \\"HasData\\": true,\\n \\"ClassMode\\": \\"C\\",\\n \\"MacPayloadSize\\": 15,\\n \\"MessageType\\": \\"JOIN_REQUEST\\",\\n \\"Datr\\": \\"SF12BW125\\",\\n \\"DevAddr\\": \\"00000000\\",\\n \\"DevEui\\": \\"0000000000000001\\",\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"Rssi\\": -110,\\n \\"HasMacCommand\\": true,\\n \\"Freq\\": 470.3,\\n \\"MacCommandCIDs\\": [\\n \\"[\\\\\\"0x01\\\\\\",\\\\\\"0x02\\\\\\"]\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 10\\r\\n \\r\\n \\r\\n C\\r\\n xxx\\r\\n true\\r\\n 00000000\\r\\n 15\\r\\n 99\\r\\n true\\r\\n 1514736000000\\r\\n CONFIRMED_DATA_UP\\r\\n SF12BW125\\r\\n DEVADDR_ILLEGAL\\r\\n 0000000000000001\\r\\n -10.5\\r\\n 0000000000000000\\r\\n -110\\r\\n 470.3\\r\\n xxx\\r\\n \\r\\n 0x01\\r\\n 0x02\\r\\n \\r\\n 101\\r\\n \\r\\n \\r\\n C\\r\\n xxx\\r\\n true\\r\\n 00000000\\r\\n 15\\r\\n 99\\r\\n true\\r\\n 1514736000000\\r\\n CONFIRMED_DATA_UP\\r\\n SF12BW125\\r\\n DEVADDR_ILLEGAL\\r\\n 0000000000000001\\r\\n -10.5\\r\\n 0000000000000000\\r\\n -110\\r\\n 470.3\\r\\n xxx\\r\\n \\r\\n 0x01\\r\\n 0x02\\r\\n \\r\\n 101\\r\\n \\r\\n
\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListNodeGroupTransferPackets',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListNodesByNodeGroupId' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS', 'LAST_JOIN_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LastJoinMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'DevAddr' => ['description' => '', 'type' => 'string', 'example' => '12345678'],
'DevEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'BoundMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'ClassMode' => ['description' => '', 'type' => 'string', 'example' => 'A'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"LastJoinMillis\\": 1514736000000,\\n \\"DevAddr\\": \\"12345678\\",\\n \\"DevEui\\": \\"0000000000000000\\",\\n \\"BoundMillis\\": 1514736000000,\\n \\"ClassMode\\": \\"A\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 10\\r\\n \\r\\n \\r\\n A\\r\\n 1514736000000\\r\\n 1514736000000\\r\\n 0000000000000000\\r\\n 12345678\\r\\n \\r\\n \\r\\n A\\r\\n 1514736000001\\r\\n 1514736000000\\r\\n 0000000000000001\\r\\n 12345678\\r\\n \\r\\n
\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListNodesByNodeGroupId',
],
'ListNodesByOwnedJoinPermissionId' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS', 'LAST_JOIN_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LastJoinMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'DevAddr' => ['description' => '', 'type' => 'string', 'example' => '12345678'],
'DevEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'BoundMillis' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'ClassMode' => ['description' => '', 'type' => 'string', 'example' => 'A'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"LastJoinMillis\\": 1514736000000,\\n \\"DevAddr\\": \\"12345678\\",\\n \\"DevEui\\": \\"0000000000000000\\",\\n \\"BoundMillis\\": 1514736000000,\\n \\"ClassMode\\": \\"A\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 10\\r\\n \\r\\n \\r\\n A\\r\\n 1514736000000\\r\\n 1514736000000\\r\\n 0000000000000000\\r\\n 12345678\\r\\n \\r\\n \\r\\n A\\r\\n 1514736000001\\r\\n 1514736000000\\r\\n 0000000000000001\\r\\n 12345678\\r\\n \\r\\n
\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListNodesByOwnedJoinPermissionId',
],
'ListNodeTransferPacketPaths' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000001'],
],
[
'name' => 'Base64EncodedMacPayload',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxx'],
],
[
'name' => 'LogMillis',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '14643600000'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '300', 'minimum' => '1', 'example' => '2'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BestPath' => ['description' => '', 'type' => 'boolean', 'example' => 'false'],
'DevEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000001'],
'GwEui' => ['description' => '', 'type' => 'string', 'example' => '0000000000000000'],
'Lsnr' => ['description' => '', 'type' => 'number', 'format' => 'float', 'example' => '-10.5'],
'Rssi' => ['description' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '-110'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['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.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"BestPath\\": false,\\n \\"DevEui\\": \\"0000000000000001\\",\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"Lsnr\\": -10.5,\\n \\"Rssi\\": -110\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 10\\r\\n \\r\\n \\r\\n 0000000000000000\\r\\n -110\\r\\n false\\r\\n 0000000000000001\\r\\n -10.5\\r\\n \\r\\n \\r\\n 0000000000000000\\r\\n -110\\r\\n false\\r\\n 0000000000000001\\r\\n -10.5\\r\\n \\r\\n
\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListNodeTransferPacketPaths',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListNodeTupleOrders' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'State',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string'],
'required' => false,
'maxItems' => 10,
],
],
[
'name' => 'IsKpm',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => false],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
'enum' => ['CREATED_MILLIS', 'ACCEPTED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
'TotalCount' => ['type' => 'integer', 'format' => 'int64'],
'List' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FailedCount' => ['type' => 'integer', 'format' => 'int64'],
'RequiredCount' => ['type' => 'integer', 'format' => 'int64'],
'CreatedMillis' => ['type' => 'integer', 'format' => 'int64'],
'IsKpm' => ['type' => 'boolean'],
'AcceptedMillis' => ['type' => 'integer', 'format' => 'int64'],
'SuccessCount' => ['type' => 'integer', 'format' => 'int64'],
'LoraVersion' => ['type' => 'string'],
'OrderState' => ['type' => 'string'],
'OrderId' => ['type' => 'string'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => null,
],
'BindJoinPermissionToNodeGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '123'],
],
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'JoinPermissionDoesNotExist', 'errorMessage' => 'The specified join permission does not exist.'],
['errorCode' => 'JoinPermissionAlreadyBoundNodeGroup', 'errorMessage' => 'The specified join permission has already been bound to another node group.'],
['errorCode' => 'NodeGroupDoesNotExist', 'errorMessage' => 'The specified node group does not exist.'],
['errorCode' => 'NodeGroupAlreadyBoundJoinPermission', 'errorMessage' => 'This node group is already bound to a join permission.'],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'BindJoinPermissionToNodeGroup',
],
'CountNodeGroups' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'FuzzyName',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'group1'],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CountNodeGroups',
],
'CountNodesByNodeGroupId' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '123'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '0000000000000000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CountNodesByNodeGroupId',
],
'CountNodesByOwnedJoinPermissionId' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '123'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '0000000000000000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CountNodesByOwnedJoinPermissionId',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CountNodeTupleOrders' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'States',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string'],
'required' => false,
'maxItems' => 10,
],
],
[
'name' => 'IsKpm',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['type' => 'integer', 'format' => 'int64'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'RemoveNodeFromGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.'],
['errorCode' => 'NodeGroupDoesNotExist', 'errorMessage' => 'The specified node group does not exist.'],
['errorCode' => 'NodeDoesNotExist', 'errorMessage' => 'The specified node does not exist.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'RemoveNodeFromGroup',
],
'SubmitNodeTupleOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'LoraVersion',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => true,
'enum' => ['1.0.2', '1.1'],
],
],
[
'name' => 'RequiredCount',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '10000', 'minimum' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => null,
],
'UnbindJoinPermissionFromNodeGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '123'],
],
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UnbindJoinPermissionFromNodeGroup',
],
'BindLabNodeToLabGateway' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'LabGatewayDoesNotExist', 'errorMessage' => 'The specified lab gateway does not exist.'],
],
],
'responseDemo' => null,
],
'CountLabGateways' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'FuzzyGwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
],
[
'name' => 'FuzzyName',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'OnlineState',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
'enum' => ['ONLINE', 'OFFLINE'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['type' => 'integer', 'format' => 'int64'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'CountLabNodes' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'FuzzyDevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'FuzzyName',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
],
[
'name' => 'ActivationState',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
'enum' => ['INACTIVATED', 'ACTIVATED'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['type' => 'integer', 'format' => 'int64'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'CreateCustomLocalJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'FreqBandPlanGroupId',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
],
[
'name' => 'ClassMode',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => true,
'enum' => ['A', 'B', 'C'],
],
],
[
'name' => 'JoinEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'JoinPermissionName',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'ExceedLocalJoinPermissionLimit', 'errorMessage' => 'The maximum number of local join permissions that you can create is exceeded.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'JoinPermissionNameDuplicated', 'errorMessage' => 'The specified join permission name already exists.'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.'],
['errorCode' => 'InvalidFreqBandPlan', 'errorMessage' => 'The frequency band plan is invalid.'],
['errorCode' => 'ExceedCustomLocalJoinPermissionLimit', 'errorMessage' => 'The maximum number of custom local join permissions that you can create is exceeded.'],
['errorCode' => 'InvalidCustomJoinEui', 'errorMessage' => 'The specified custom joinEui is invalid.'],
],
],
'responseDemo' => null,
],
'CreateLabGateway' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
'IotHubDeviceSecret' => ['type' => 'string'],
'BoundNodesCount' => ['type' => 'integer', 'format' => 'int64'],
'IotHubProductKey' => ['type' => 'string'],
'FreqBandPlanGroupId' => ['type' => 'integer', 'format' => 'int64'],
'CreateMillis' => ['type' => 'integer', 'format' => 'int64'],
'IotHubDeviceName' => ['type' => 'string'],
'OnlineState' => ['type' => 'string'],
'Name' => ['type' => 'string'],
'GwEui' => ['type' => 'string'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'ExceedLabGatewayLimit', 'errorMessage' => 'The maximum number of lab gateways is exceeded.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.'],
],
],
'responseDemo' => null,
],
'CreateLabNode' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
],
[
'name' => 'LoraVersion',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => true,
'enum' => ['1.0.2', '1.1'],
],
],
[
'name' => 'ClassMode',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => true,
'enum' => ['A', 'B', 'C'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
'DevEui' => ['type' => 'string'],
'AppKey' => ['type' => 'string'],
'JoinEui' => ['type' => 'string'],
'FreqBandPlanGroupId' => ['type' => 'integer', 'format' => 'int64'],
'CreateMillis' => ['type' => 'integer', 'format' => 'int64'],
'NodeActivationState' => ['type' => 'string'],
'Name' => ['type' => 'string'],
'ClassMode' => ['type' => 'string'],
'LoraVersion' => ['type' => 'string'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'ExceedLabNodeLimit', 'errorMessage' => 'The maximum number of lab nodes is exceeded.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.'],
],
],
'responseDemo' => null,
],
'DeleteExternalNodeTuples' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEuiList',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string'],
'required' => true,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
'FailedCount' => ['type' => 'integer', 'format' => 'int64'],
'TotalCount' => ['type' => 'integer', 'format' => 'int64'],
'SuccessCount' => ['type' => 'integer', 'format' => 'int64'],
'FailedDetails' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OperationResult' => ['type' => 'string'],
'DevEui' => ['type' => 'string'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'Abandoned', 'errorMessage' => 'An error occurred while processing this request, because the API has been abandoned.'],
['errorCode' => 'ExceedMaxOperationCount', 'errorMessage' => 'The maximum number of operations is exceeded.'],
],
],
'responseDemo' => null,
],
'DeleteLabGateway' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'BoundLabNodesIsNotEmpty', 'errorMessage' => 'You cannot delete this gateway, because it is bound to lab nodes.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => null,
],
'DeleteLabNode' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => null,
],
'GetKpmPublicKey' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
'CreateMillis' => ['type' => 'integer', 'format' => 'int64'],
'PublicKey' => ['type' => 'string'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'GetLabGateway' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
'IotHubDeviceSecret' => ['type' => 'string'],
'BoundNodesCount' => ['type' => 'integer', 'format' => 'int64'],
'IotHubProductKey' => ['type' => 'string'],
'FreqBandPlanGroupId' => ['type' => 'integer', 'format' => 'int64'],
'CreateMillis' => ['type' => 'integer', 'format' => 'int64'],
'IotHubDeviceName' => ['type' => 'string'],
'ExpirationMillis' => ['type' => 'integer', 'format' => 'int64'],
'OnlineState' => ['type' => 'string'],
'Name' => ['type' => 'string'],
'GwEui' => ['type' => 'string'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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.'],
],
],
'responseDemo' => null,
],
'GetLabGatewayGwmpConfig' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'GetLabNode' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
'DevEui' => ['type' => 'string'],
'BoundGatewaysCount' => ['type' => 'integer', 'format' => 'int64'],
'AppKey' => ['type' => 'string'],
'JoinEui' => ['type' => 'string'],
'FreqBandPlanGroupId' => ['type' => 'integer', 'format' => 'int64'],
'CreateMillis' => ['type' => 'integer', 'format' => 'int64'],
'ActivationState' => ['type' => 'string'],
'Name' => ['type' => 'string'],
'ClassMode' => ['type' => 'string'],
'LoraVersion' => ['type' => 'string'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => null,
],
'GetLabNodeDebugConfig' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
'TimeOffset' => ['type' => 'integer', 'format' => 'int32'],
'RxWindow' => ['type' => 'string'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => null,
],
'GetLabNodeDownlinkConfig' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
'Rfu' => ['type' => 'string'],
'DevAddr' => ['type' => 'string'],
'FPort' => ['type' => 'number', 'format' => 'float'],
'Major' => ['type' => 'string'],
'MType' => ['type' => 'string'],
'Mic' => ['type' => 'string'],
'FCnt' => ['type' => 'number', 'format' => 'float'],
'FCtrl' => [
'type' => 'object',
'properties' => [
'FOptsLen' => ['type' => 'number', 'format' => 'float'],
'Ack' => ['type' => 'boolean'],
'RfuAdrAckReq' => ['type' => 'boolean'],
'FPendingRfu' => ['type' => 'boolean'],
'Adr' => ['type' => 'boolean'],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => null,
],
'GetLabNodeJoinAcceptConfig' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
'CfList' => ['type' => 'string'],
'Rfu' => ['type' => 'string'],
'DevAddr' => ['type' => 'string'],
'Major' => ['type' => 'string'],
'RxDelay' => ['type' => 'integer', 'format' => 'int32'],
'AppNonce' => ['type' => 'string'],
'MType' => ['type' => 'string'],
'Mic' => ['type' => 'string'],
'NetId' => ['type' => 'string'],
'DownlinkSetting' => [
'type' => 'object',
'properties' => [
'Rfu' => ['type' => 'string'],
'Rx1DrOffset' => ['type' => 'number', 'format' => 'float'],
'Rx2DataRate' => ['type' => 'number', 'format' => 'float'],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => null,
],
'ListBoundLabGateways' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'IotHubDeviceSecret' => ['type' => 'string'],
'BoundNodesCount' => ['type' => 'integer', 'format' => 'int64'],
'IotHubProductKey' => ['type' => 'string'],
'FreqBandPlanGroupId' => ['type' => 'integer', 'format' => 'int64'],
'CreateMillis' => ['type' => 'integer', 'format' => 'int64'],
'IotHubDeviceName' => ['type' => 'string'],
'OnlineState' => ['type' => 'string'],
'Name' => ['type' => 'string'],
'GwEui' => ['type' => 'string'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'ListBoundLabNodes' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DevEui' => ['type' => 'string'],
'BoundGatewaysCount' => ['type' => 'integer', 'format' => 'int64'],
'AppKey' => ['type' => 'string'],
'JoinEui' => ['type' => 'string'],
'FreqBandPlanGroupId' => ['type' => 'integer', 'format' => 'int64'],
'CreateMillis' => ['type' => 'integer', 'format' => 'int64'],
'ActivationState' => ['type' => 'string'],
'Name' => ['type' => 'string'],
'ClassMode' => ['type' => 'string'],
'LoraVersion' => ['type' => 'string'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => null,
],
'ListLabGatewayLogs' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LogMillis' => ['type' => 'integer', 'format' => 'int64'],
'LogType' => ['type' => 'string'],
'Content' => ['type' => 'string'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => null,
],
'ListLabGateways' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'FuzzyGwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
],
[
'name' => 'FuzzyName',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'OnlineState',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
'enum' => ['ONLINE', 'OFFLINE'],
],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
'enum' => ['CREATE_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
'TotalCount' => ['type' => 'integer', 'format' => 'int64'],
'List' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'IotHubDeviceSecret' => ['type' => 'string'],
'BoundNodesCount' => ['type' => 'string'],
'IotHubProductKey' => ['type' => 'string'],
'FreqBandPlanGroupId' => ['type' => 'integer', 'format' => 'int64'],
'CreateMillis' => ['type' => 'integer', 'format' => 'int64'],
'IotHubDeviceName' => ['type' => 'string'],
'ExpirationMillis' => ['type' => 'integer', 'format' => 'int64'],
'OnlineState' => ['type' => 'string'],
'Name' => ['type' => 'string'],
'GwEui' => ['type' => 'string'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'ListLabNodeLogs' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LogMillis' => ['type' => 'integer', 'format' => 'int64'],
'LogType' => ['type' => 'string'],
'Content' => ['type' => 'string'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => null,
],
'ListLabNodes' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'FuzzyDevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'FuzzyName',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
'enum' => ['CREATE_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
'Data' => [
'type' => 'object',
'properties' => [
'TotalCount' => ['type' => 'integer', 'format' => 'int64'],
'List' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DevEui' => ['type' => 'string'],
'BoundGatewaysCount' => ['type' => 'integer', 'format' => 'int64'],
'AppKey' => ['type' => 'string'],
'JoinEui' => ['type' => 'string'],
'FreqBandPlanGroupId' => ['type' => 'integer', 'format' => 'int64'],
'CreateMillis' => ['type' => 'integer', 'format' => 'int64'],
'ActivationState' => ['type' => 'string'],
'Name' => ['type' => 'string'],
'ClassMode' => ['type' => 'string'],
'LoraVersion' => ['type' => 'string'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => null,
],
'RebootLabGateway' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => null,
],
'RegisterKpmPublicKey' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'PublicKey',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => null,
],
'SendBusinessCommandToLabNode' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'DebugConfig',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'BusinessCommand',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'SendMacCommandToLabNode' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'DebugConfig',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'MacCommand',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'SubmitExternalNodeTuplesImportingTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeTuples',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DevEui' => ['type' => 'string', 'required' => false],
'AppSKey' => ['type' => 'string', 'required' => false],
'LoraVer' => ['type' => 'string', 'required' => false],
'NwkSKey' => ['type' => 'string', 'required' => false],
],
],
'required' => true,
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'Abandoned', 'errorMessage' => 'An error occurred while processing this request, because the API has been abandoned.'],
['errorCode' => 'ExceedMaxOperationCount', 'errorMessage' => 'The maximum number of operations is exceeded.'],
['errorCode' => 'ExceedExternalNodeTupleLimit', 'errorMessage' => 'The maximum number of external node tuples is exceeded.'],
],
],
'responseDemo' => null,
],
'SubmitExternalNodesAddingTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Nodes',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DevEui' => ['type' => 'string', 'required' => false],
],
],
'required' => true,
'maxItems' => 1000,
],
],
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['type' => 'string'],
'RequestId' => ['type' => 'string'],
'Success' => ['type' => 'boolean'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.'],
['errorCode' => 'Abandoned', 'errorMessage' => 'An error occurred while processing this request, because the API has been abandoned.'],
['errorCode' => 'ExceedMaxOperationCount', 'errorMessage' => 'The maximum number of operations is exceeded.'],
],
],
'responseDemo' => null,
],
'TriggerLabGatewayDeviceInfoReport' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => null,
],
'TriggerLabGatewayConfigReport' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'TriggerLabGatewayLogReport' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => null,
],
'UnbindLabNodeFromLabGateway' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.'],
['errorCode' => 'LabGatewayDoesNotExist', 'errorMessage' => 'The specified lab gateway does not exist.'],
],
],
'responseDemo' => null,
],
'UnregisterKpmPublicKey' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => null,
],
'UpdateEmbeddedNsAutoSyncEnablingState' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['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.'],
],
],
'responseDemo' => null,
],
'UpdateLabGateway' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.'],
],
],
'responseDemo' => null,
],
'UpdateLabGatewayGwmpConfig' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'GwmpConfig',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => null,
],
'UpdateLabGatewaySshCtrl' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => null,
],
'UpdateLabGatewayUartCtrl' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => null,
],
'UpdateLabNode' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'LoraVersion',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'ClassMode',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
'enum' => ['A', 'B', 'C'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.'],
],
],
'responseDemo' => null,
],
'UpdateLabNodeDebugConfig' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'DebugConfigJson',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
],
],
'responseDemo' => null,
],
'UpdateLabNodeDownlinkConfig' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'DebugConfig',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'DownlinkConfig',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
],
],
'responseDemo' => null,
],
'UpdateLabNodeJoinAcceptConfig' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'DebugConfig',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'JoinAcceptConfig',
'in' => 'formData',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean'],
'RequestId' => ['type' => 'string'],
],
],
],
],
'errorCodes' => [
400 => [
['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' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.'],
],
],
'responseDemo' => null,
],
],
'endpoints' => [
['regionId' => 'cn-hangzhou', 'endpoint' => 'linkwan.cn-hangzhou.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'endpoint' => 'linkwan.cn-shanghai.aliyuncs.com'],
],
];