'1.0',
'info' => ['style' => 'RPC', 'product' => 'LinkWAN', 'version' => '2018-12-30'],
'directories' => [
[
'id' => 65445,
'title' => '下载',
'type' => 'directory',
'children' => ['GetGatewayTransferPacketsDownloadUrl', 'GetNodeGroupTransferPacketsDownloadUrl'],
],
[
'id' => 65448,
'title' => '频段',
'type' => 'directory',
'children' => ['GetFreqBandPlanGroup', 'ListFreqBandPlanGroups'],
],
[
'id' => 65451,
'title' => '通知',
'type' => 'directory',
'children' => ['UpdateNotificationsHandleState', 'GetNotification', 'ListNotifications', 'CountNotifications'],
],
[
'id' => 65456,
'title' => '服务',
'type' => 'directory',
'children' => ['DescribeRegions', 'ListActivatedFeatures', 'GetUserLicense', 'CheckCloudProductOpenStatus', 'SendUnicastCommand'],
],
[
'id' => 65462,
'title' => '网关',
'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' => '凭证',
'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' => '节点',
'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' => '要查询的网关的GwEUI。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['description' => '根据DevEUI过滤数据包。', 'type' => 'string', 'required' => false, 'example' => '0000000000000001'],
],
[
'name' => 'Category',
'in' => 'formData',
'schema' => [
'description' => '数据包分类。取值：'."\n"
."\n"
.'- **DOWNLINK_PACKET**：下行包'."\n"
.'- **UPLINK_PACKET**：上行包'."\n"
.'- **INVALID_PACKET**：无效包',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'DOWNLINK_PACKET',
'enum' => ['DOWNLINK_PACKET', 'UPLINK_PACKET', 'INVALID_PACKET'],
],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '查询开始时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '查询结束时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '排序字段。取值：**LOG_MILLIS**，表示按照时间排序。',
'type' => 'string',
'required' => false,
'example' => 'LOG_MILLIS',
'enum' => ['LOG_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '配合**SortingField**参数一起使用，**true**表示升序，**false**表示降序。', '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' => '请求ID。', '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' => '获取下载链接',
'summary' => '该链接指向一个CSV文件，其中包括了网关上下行数据包的统计数据。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetNodeGroupTransferPacketsDownloadUrl' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['description' => '根据DevEUI过滤数据包。', 'type' => 'string', 'required' => false, 'example' => '0000000000000001'],
],
[
'name' => 'Category',
'in' => 'formData',
'schema' => [
'description' => '数据包分类。取值：'."\n"
."\n"
.'- **DOWNLINK_PACKET**：下行包'."\n"
.'- **UPLINK_PACKET**：上行包',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'DOWNLINK_PACKET',
'enum' => ['DOWNLINK_PACKET', 'UPLINK_PACKET', 'INVALID_PACKET'],
],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '查询开始时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '查询结束时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '排序字段。取值：**LOG_MILLIS**，表示按照时间排序。',
'type' => 'string',
'required' => false,
'example' => 'LOG_MILLIS',
'enum' => ['LOG_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '配合**SortingField**参数一起使用，**true**表示升序，**false**表示降序。', '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' => '请求ID。', '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' => '获取下载链接',
'summary' => '该链接指向一个CSV文件，其中包括了节点分组上下行数据包的统计数据。',
],
'GetFreqBandPlanGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'formData',
'schema' => ['description' => '频段ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '201'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '频段信息。',
'type' => 'object',
'properties' => [
'EndFrequency' => ['description' => '结束频点，单位为MHz。', 'type' => 'integer', 'format' => 'int64', 'example' => '925'],
'GroupId' => ['description' => '频段ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '201'],
'FrequencyType' => ['description' => '频段类型。取值范围：'."\n"
."\n"
.'- **SAME_FREQUENCY**：同频'."\n"
.'- **DIFF_FREQUENCY**：异频', 'type' => 'string', 'example' => 'SAME_FREQUENCY'],
'FrequencyRegionId' => ['description' => 'Region标识。', 'type' => 'string', 'example' => 'CN'],
'BeginFrequency' => ['description' => '起始频点，单位为MHz。', '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' => '获取频段信息',
'summary' => '调用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' => '请求ID。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '频段列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndFrequency' => ['description' => '结束频点，单位为MHz。', 'type' => 'integer', 'format' => 'int64', 'example' => '510'],
'GroupId' => ['description' => '频段ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '101'],
'FrequencyType' => ['description' => '频段类型。取值范围：'."\n"
."\n"
.'- **SAME_FREQUENCY**：同频'."\n"
.'- **DIFF_FREQUENCY**：异频', 'type' => 'string', 'example' => 'SAME_FREQUENCY'],
'FrequencyRegionId' => ['description' => 'Region标识。', 'type' => 'string', 'example' => 'CN'],
'BeginFrequency' => ['description' => '起始频点，单位为MHz。', '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' => '获取频段列表',
'summary' => '调用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' => '通知ID列表。',
'type' => 'array',
'items' => ['type' => 'integer', 'format' => 'int64'],
'required' => true,
'example' => '1',
'maxItems' => 100,
],
],
[
'name' => 'TargetHandleState',
'in' => 'formData',
'schema' => [
'description' => '要设置的处理状态，可取值为**HANDLED**（已处理）, **UNHANDLED**（未处理）。',
'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' => '请求ID。', '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' => '更新通知的处理状态',
'summary' => '调用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' => '通知ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '通知信息列表。',
'type' => 'object',
'properties' => [
'NoticeMillis' => ['description' => '通知发出的时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'Category' => ['description' => '通知分类。取值：'."\n"
."\n"
.'- **GATEWAY_OFFLINE**：网关离线信息。'."\n"
.'- **JOIN_PERMISSION_AUTH_APPLYING**：凭证授权信息。'."\n"
.'- **JOIN_PERMISSION_AUTH_ACCEPTED**：凭证授权信息。'."\n"
.'- **JOIN_PERMISSION_AUTH_CANCELED**：凭证授权信息。'."\n"
.'- **JOIN_PERMISSION_AUTH_REJECTED**：凭证授权信息。', 'type' => 'string', 'example' => 'GATEWAY_OFFLINE'],
'HandleState' => ['description' => '此通知的处理状态。可取值为**HANDLED**(已处理)，**UNHANDLED**(未处理)。', 'type' => 'string', 'example' => 'UNHANDLED'],
'NotificationId' => ['description' => '通知ID。', 'type' => 'string', 'example' => '123'],
'HandledMillis' => ['description' => '通知被处理的时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000001'],
'GatewayOfflineInfo' => [
'description' => '网关离线信息。'."\n"
."\n"
.'当**Category**为**GATEWAY_OFFLINE**时该字段有值。',
'type' => 'object',
'properties' => [
'GwEui' => ['description' => '网关唯一标识。', 'type' => 'string', 'example' => '0000000000000000'],
'OfflineMillis' => ['description' => '离线时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
],
],
'JoinPermissionAuthInfo' => [
'description' => '凭证授权信息。'."\n"
."\n"
.'当**Category**为**JOINPERMISSION_AUTH**时该字段有值。',
'type' => 'object',
'properties' => [
'CanceledMillis' => ['description' => '工单被取消的UNIX时间戳，毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'ApplyingMillis' => ['description' => '发起工单的UNIX时间戳，毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'JoinEui' => ['description' => '入网凭证所使用的JoinEUI。', 'type' => 'string', 'example' => 'd896e0'],
'RenterAliyunId' => ['description' => '入网凭证租户的阿里云账号ID。', 'type' => 'string', 'example' => 'some-user2'],
'AcceptedMillis' => ['description' => '工单审批通过的UNIX时间戳 ，毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'OwnerAliyunId' => ['description' => '发起授权的入网凭证拥有者的阿里云账号ID。', 'type' => 'string', 'example' => 'some-user1'],
'RejectedMillis' => ['description' => '工单被拒绝的UNIX时间戳，毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'JoinPermissionId' => ['description' => '唯一标识入网凭证的ID。', 'type' => 'string', 'example' => '123'],
'JoinPermissionName' => ['description' => '入网凭证的名称。', 'type' => 'string', 'example' => '凭证1'],
'OrderState' => ['description' => '工单状态。取值：'."\n"
."\n"
.'- **APPLYING**：工单发起，等待批准。'."\n"
.'- **ACCEPTED**：工单被批准。'."\n"
.'- **REJECTED**：工单被拒绝。'."\n"
.'- **CANCELED**：工单被取消。', 'type' => 'string', 'example' => 'ACCEPTED'],
'OrderId' => ['description' => '工单ID。', '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' => '获取通知信息',
'summary' => '调用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' => '通知类型列表，传 null 则不过滤类型。',
'type' => 'array',
'items' => ['type' => 'string'],
'required' => false,
'example' => 'GATEWAY_OFFLINE',
'maxItems' => 100,
],
],
[
'name' => 'HandleState',
'in' => 'formData',
'schema' => [
'description' => '根据通知处理状态过滤，传 null 则不过滤处理状态。',
'type' => 'string',
'required' => false,
'example' => 'HANDLED',
'enum' => ['HANDLED', 'UNHANDLED'],
],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['description' => '查询的起始位置，从 0 开始的偏移。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['description' => '查询的通知数量上限，大于等于 1。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '时间查询，毫秒为单位的 UNIX 时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '时间查询，毫秒为单位的 UNIX 时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '排序字段，可取值为**NOTICE_MILLIS**(按照通知发生时间排序)。',
'type' => 'string',
'required' => false,
'example' => 'NOTICE_MILLIS',
'enum' => ['NOTICE_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '配合SortingField参数一起使用，**true**表示升序，**false**表示降序。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '通知发生时间，UNIX 时间戳，毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'Category' => ['description' => '通知分类。', 'type' => 'string', 'example' => 'GATEWAY_OFFLINE'],
'HandleState' => ['description' => '通知处理状态。', 'type' => 'string', 'example' => 'HANDLED'],
'NotificationId' => ['description' => '通知ID。', 'type' => 'string', 'example' => '123'],
'HandledMillis' => ['description' => '通知处理时间，UNIX 时间戳，毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000001'],
'GatewayOfflineInfo' => [
'description' => '当**Category**为**GATEWAY_OFFLINE**时，该字段有值。'."\n"
."\n"
.'记录网关离线信息。',
'type' => 'object',
'properties' => [
'GwEui' => ['description' => '网关的GwEUI。', 'type' => 'string', 'example' => '0000000000000000'],
'OfflineMillis' => ['description' => '离线时间，毫秒为单位的 UNIX 时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
],
],
'JoinPermissionAuthInfo' => [
'description' => '当**Category**为**JOINPERMISSION_AUTH**时，该字段有值。'."\n"
."\n"
.'记录凭证授权信息。',
'type' => 'object',
'properties' => [
'CanceledMillis' => ['description' => '工单被取消的 UNIX 时间戳，毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'ApplyingMillis' => ['description' => '发起工单的 UNIX 时间戳，毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'JoinEui' => ['description' => '入网凭证所使用的JoinEUI。', 'type' => 'string', 'example' => '0000000000000001'],
'RenterAliyunId' => ['description' => '入网凭证租户的阿里云账号ID。', 'type' => 'string', 'example' => 'some-user'],
'AcceptedMillis' => ['description' => '工单审批通过的 UNIX 时间戳 ，毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'OwnerAliyunId' => ['description' => '发起授权的入网凭证拥有者的阿里云账号ID。', 'type' => 'string', 'example' => 'some-user1'],
'RejectedMillis' => ['description' => '工单被拒绝的 UNIX 时间戳，毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'JoinPermissionId' => ['description' => '唯一标识入网凭证的ID。', 'type' => 'string', 'example' => '126'],
'JoinPermissionName' => ['description' => '入网凭证的名称。', 'type' => 'string', 'example' => '凭证2'],
'OrderState' => ['description' => '工单状态。', 'type' => 'string', 'example' => 'ACCEPTED'],
'OrderId' => ['description' => '工单ID。', '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' => '获取通知列表',
'summary' => '调用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' => '通知类型列表，传null值则不过滤类型。',
'type' => 'array',
'items' => ['type' => 'string'],
'required' => false,
'example' => 'GATEWAY_OFFLINE',
'maxItems' => 100,
],
],
[
'name' => 'HandleState',
'in' => 'formData',
'schema' => ['description' => '根据通知处理状态过滤，传null值则不过滤处理状态。', 'type' => 'string', 'required' => false, 'example' => 'UNHANDLED'],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '查询开始时间，毫秒为单位的 UNIX 时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '查询结束时间，毫秒为单位的 UNIX 时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1514736000000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '通知数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'RequestId' => ['description' => '请求ID。', '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' => '统计符合过滤条件的通知数量',
'summary' => '调用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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '最大重发次数，默认为**0**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '1', 'default' => '0'],
],
[
'name' => 'CleanUp',
'in' => 'formData',
'schema' => ['description' => '是否清空该节点的堆积指令，并下发该指令。默认为**false**。', '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' => '是否是confirmed指令，默认为**false**。', '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' => '请求ID。', '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' => '发送单播信息',
'summary' => '调用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' => '网关PinCode, 用于确保录入者拥有该网关。', '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' => '网关频段ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'CommunicationMode',
'in' => 'formData',
'schema' => [
'description' => '网关通信模式。取值：**FULL_DUPLEX**(全双工）| **HALF_DUPLEX**(半双工)。',
'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' => '网关经纬度所采用的坐标系统，可取值为**WGS_84**, **GCJ_02**。',
'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' => '网关所在地区ID, 由http://lbs.amap.com/api/javascript-api/download定义。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '录入网关',
'summary' => '调用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' => '请求ID。', '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' => '删除已录入的网关',
'summary' => '调用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' => '网关频段ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
],
[
'name' => 'CommunicationMode',
'in' => 'formData',
'schema' => [
'description' => '网关通信模式。可取值为**FULL_DUPLEX**(全双工）、**HALF_DUPLEX**(半双工)。',
'type' => 'string',
'required' => false,
'example' => 'HALF_DUPLEX',
'enum' => ['HALF_DUPLEX', 'FULL_DUPLEX'],
],
],
[
'name' => 'AddressCode',
'in' => 'formData',
'schema' => ['description' => '网关所在地区ID，由http://lbs.amap.com/api/javascript-api/download定义。', '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' => '网关经纬度所采用的坐标系统，可取值为**WGS_84**, **GCJ_02**。',
'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' => '请求ID。', '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' => '更新网关信息',
'summary' => '调用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' => '是否开启网关。'."\n"
.'- **true**：表示启用该网关。'."\n"
.'- **false**：表示关闭该网关。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '启动、关闭网关',
'summary' => '调用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' => '请求ID。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '网关信息。',
'type' => 'object',
'properties' => [
'ClassBSupported' => ['description' => '该网关是否支持Class B模式。', 'type' => 'boolean', 'example' => 'true'],
'FreqBandPlanGroupId' => ['description' => '网关频段ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'District' => ['description' => '网关所在城区名称。', 'type' => 'string', 'example' => '某某区'],
'GisCoordinateSystem' => ['description' => '网关经纬度所采用的坐标系统，可取值：**WGS_84**, **GCJ_02**。', 'type' => 'string', 'example' => 'GCJ_02'],
'City' => ['description' => '网关所在城市名称。', 'type' => 'string', 'example' => '某某市'],
'TimeCorrectable' => ['description' => '该网关是否可以作为时间校准网关。', 'type' => 'boolean', 'example' => 'true'],
'OnlineState' => ['description' => '网关在离线状态。可取值为**ONLINE**, **OFFLINE**。', 'type' => 'string', 'example' => 'OFFLINE'],
'OnlineStateChangedMillis' => ['description' => '最近一次在离线状态变更的时间。'."\n"
."\n"
.'格式为UNIX时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'CommunicationMode' => ['description' => '网关通信模式。可取值为：**FULL_DUPLEX**(全双工）、**HALF_DUPLEX**(半双工)。', 'type' => 'string', 'example' => 'HALF_DUPLEX'],
'Description' => ['description' => '自定义网关描述。', 'type' => 'string', 'example' => '网关描述'],
'Enabled' => ['description' => '该网关是否处于启用状态。', 'type' => 'boolean', 'example' => 'true'],
'ClassBWorking' => ['description' => '该网关是否正工作在Class B模式下。', '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' => '网关所在地区ID，由http://lbs.amap.com/api/javascript-api/download定义。', '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' => '获取网关信息',
'summary' => '调用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' => '要查询的网关的GwEUI。', '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' => '请求ID。', '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' => '获取网关有效包无效包统计',
'summary' => '调用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' => '网关的GwEUI。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '网关状态统计列表。',
'type' => 'object',
'properties' => [
'MemoryRadio' => ['description' => '网关内存占用百分比，如42.0表示内存占用42%。', 'type' => 'number', 'format' => 'float', 'example' => '42.0'],
'OnlineHour' => ['description' => '累计在线小时数。', 'type' => 'integer', 'format' => 'int64', 'example' => '42'],
'Enabled' => ['description' => '网关的启停用状态。', 'type' => 'boolean', 'example' => 'true'],
'TxCount' => ['description' => '累计TX。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'RxCount' => ['description' => '累计RX。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'GwEui' => ['description' => '网关的GwEUI。', 'type' => 'string', 'example' => '0000000000000000'],
'OnlineState' => ['description' => '网关在线状态。', 'type' => 'string', 'example' => 'ONLINE'],
'CpuRadio' => ['description' => '网关CPU占用百分比，如10.5表示CPU占用10.5%。', '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' => '获取网关状态统计',
'summary' => '获取网关状态统计，如 CPU、内存占用等。',
'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' => '',
],
'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' => '',
],
'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' => '请求ID。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '活跃网关列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'District' => ['description' => '网关所在城区。', 'type' => 'string', 'example' => '某某区'],
'FreqBandPlanGroupId' => ['description' => '频段ID。', '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' => '网关的GwEUI。', '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' => '查询今日活跃网关',
'summary' => '调用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' => '网关的GwEUI。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'OffSet',
'in' => 'formData',
'schema' => ['description' => '查询的起始位置，从0开始的偏移值。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['description' => '查询的记录数量上限，大于等于1。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '5'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '排序字段，可选值为：STATE_CHANGED_MILLIS，表示按照状态改变时间排序。',
'type' => 'string',
'required' => false,
'example' => 'STATE_CHANGED_MILLIS',
'enum' => ['STATE_CHANGED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '配合**SortingField**参数一起使用，**true**表示升序，**false**表示降序。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '切换到此状态的时间点，以毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514737000000'],
'OnlineState' => ['description' => '在线状态，可取值：**ONLINE**：在线，**OFFLINE**：离线。', 'type' => 'string', 'example' => 'ONLINE'],
'GwEui' => ['description' => '网关的GwEUI。', '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' => '查询网关在线离线记录',
'summary' => '调用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' => '网关在离线状态过滤。'."\n"
."\n"
.'如未传入此参数，则不限制在线状态。可取值为：**ONLINE**, **OFFLINE**。',
'type' => 'string',
'required' => false,
'example' => 'ONLINE',
'enum' => ['ONLINE', 'OFFLINE'],
],
],
[
'name' => 'FuzzyGwEui',
'in' => 'formData',
'schema' => ['description' => 'GwEUI模糊过滤。', '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' => '网关频段ID过滤。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
],
[
'name' => 'IsEnabled',
'in' => 'formData',
'schema' => ['description' => '网关启停用状态过滤。'."\n"
."\n"
.'如未传入此参数，则不限制启停状态。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['description' => '本次查询的起始位置，从0开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['description' => '本次查询的网关数量上限，大于等于1。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '指定排序字段，可取值为**ONLINE_STATE_CHANGED_MILLIS**。',
'type' => 'string',
'required' => false,
'example' => 'ONLINE_STATE_CHANGED_MILLIS',
'enum' => ['ONLINE_STATE_CHANGED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '配合**SortingField**参数一起使用，**true**表示升序，**false**表示降序。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '该网关是否支持 Class B 模式。', 'type' => 'boolean', 'example' => 'true'],
'FreqBandPlanGroupId' => ['description' => '网关频段ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'District' => ['description' => '网关所在城区名称。', 'type' => 'string', 'example' => '某某区'],
'GisCoordinateSystem' => ['description' => '网关经纬度所采用的坐标系统，可取值为**WGS_84**，**GCJ_02**。', 'type' => 'string', 'example' => 'GCJ_02'],
'City' => ['description' => '网关所在城市名称。', 'type' => 'string', 'example' => '某某市'],
'TimeCorrectable' => ['description' => '该网关是否可以作为时间校准网关。', 'type' => 'boolean', 'example' => 'true'],
'OnlineState' => ['description' => '网关在离线状态，可取值为：**ONLINE**，**OFFLINE**。', 'type' => 'string', 'example' => 'ONLINE'],
'OnlineStateChangedMillis' => ['description' => '最近一次在离线状态变更的时间。'."\n"
."\n"
.'格式为UNIX时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'CommunicationMode' => ['description' => '网关通信模式。可取值为**FULL_DUPLEX**(全双工）、**HALF_DUPLEX**(半双工)。', 'type' => 'string', 'example' => 'HALF_DUPLEX'],
'Description' => ['description' => '自定义网关描述。', 'type' => 'string', 'example' => '网关描述'],
'Enabled' => ['description' => '该网关是否处于启用状态。', 'type' => 'boolean', 'example' => 'true'],
'ClassBWorking' => ['description' => '该网关是否正工作在 Class B 模式下。', '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' => '网关所在地区ID，由http://lbs.amap.com/api/javascript-api/download定义。', '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' => '查询网关信息列表',
'summary' => '根据过滤条件查询当前用户账号名下的网关信息列表。',
'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' => '',
],
'ListGatewayTransferFlowStats' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['description' => '网关的GwEUI。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '查询开始时间，以毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '查询结束时间，以毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514737000000'],
],
[
'name' => 'TimeIntervalUnit',
'in' => 'formData',
'schema' => [
'description' => '时间间隔的单位，可取值为：'."\n"
."\n"
.'- **INTERVAL_IN_HOURS**：按照小时统计'."\n"
.'- **INTERVAL_IN_DAYS**：按照天统计',
'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' => '请求ID。', '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' => '统计UNIX时间戳, 以毫秒为单位。', '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' => '查询网关流量统计列表',
'summary' => '调用ListGatewayTransferFlowStats查询网关流量统计列表。',
],
'ListGatewayTransferPackets' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'formData',
'schema' => ['description' => '要查询的网关的GwEUI。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['description' => '根据DevEUI过滤数据包。', 'type' => 'string', 'required' => false, 'example' => '0000000000000001'],
],
[
'name' => 'Category',
'in' => 'formData',
'schema' => [
'description' => '数据包分类。取值：'."\n"
."\n"
.'- **DOWNLINK_PACKET**：下行包'."\n"
.'- **UPLINK_PACKET**：上行包'."\n"
.'- **INVALID_PACKET**：无效包',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'DOWNLINK_PACKET',
'enum' => ['DOWNLINK_PACKET', 'UPLINK_PACKET', 'INVALID_PACKET'],
],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '分页页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '分页大小，大于等于1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '2'],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '查询开始时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '查询结束时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '排序字段，取值：**LOG_MILLIS**，表示按照时间排序。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'LOG_MILLIS',
'enum' => ['LOG_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '配合**SortingField**参数一起使用，**true**表示升序，**false**表示降序。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '数据包传输的UNIX时间戳，以毫秒为单位。', 'type' => 'string', 'example' => '1514736000000'],
'ProcessEvent' => ['description' => '该报文的处理结果，取值：'."\n"
."\n"
.'- SUCCESS：成功。'."\n"
.'- DEVADDR_ILLEGAL：DevAddr不合法。'."\n"
.'- MIC_FAIL：MIC校验失败。'."\n"
.'- DEVEUI_ILLEGAL：DevEui不合法。'."\n"
.'- JOINEUI_ILLEGAL：JoinEui不合法。'."\n"
.'- STATUS_INVALID：节点状态不合法。'."\n"
.'- REDUPLICATE：重复包。'."\n"
.'- ISOLATED：网间隔离。'."\n"
.'- APPKEY_ILLEGAL：AppKey不合法。'."\n"
.'- UPDATE_RUNTIME_CFG_FAIL：更新运行时配置失败。'."\n"
.'- DELAY_PROCESS：延迟处理。'."\n"
.'- GWEUI_ILLEGAL：GwEui不合法。'."\n"
.'- GW_STATUS_INVALID：网关状态不合法。'."\n"
.'- GW_FREQ_NOT_MATCH：网关频点不匹配。'."\n"
.'- 其它：未知错误。', 'type' => 'string', 'example' => 'SUCCESS'],
'Base64EncodedMacPayload' => ['description' => 'Base64编码后的MACPayload报文。', 'type' => 'string', 'example' => 'xxx'],
'FPort' => ['description' => '收发此数据包时所使用的FPort。', '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' => '此数据包的MACPayload报文长度。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
'MessageType' => ['description' => '消息类型，取值：'."\n"
."\n"
.'- **JOIN_REQUEST**：Join-request消息'."\n"
.'- **JOIN_ACCEPT**：Join-accept消息'."\n"
.'- **UNCONFIRMED_UP**：Unconfirmed上行消息'."\n"
.'- **UNCONFIRMED_DOWN**：Unconfirmed下行消息'."\n"
.'- **CONFIRMED_UP**：Confirmed上行消息'."\n"
.'- **CONFIRMED_DOWN**：Confirmed下行消息'."\n"
.'- **REJOIN_REQUEST**：Rejoin-request消息'."\n"
.'- **PROPRIETARY**：Proprietary消息（私有消息）', 'type' => 'string', 'example' => 'JOIN_REQUEST'],
'Datr' => ['description' => '收发此数据包的数据速率。', 'type' => 'string', 'example' => 'SF12BW125'],
'DevAddr' => ['description' => '收发此数据包的节点的网络地址。', 'type' => 'string', 'example' => '00000000'],
'DevEui' => ['description' => '收发此数据包的节点的DevEUI。', 'type' => 'string', 'example' => '0000000000000001'],
'NodeOwnerAliyunId' => ['description' => '节点拥有者的阿里云账号ID。', 'type' => 'string', 'example' => '23546'],
'MacCommandCIDs' => [
'type' => 'string',
'items' => ['description' => '这个数据包所携带的MAC指令列表。', 'type' => 'string', 'example' => '["0x01","0x02"]', 'index' => 200],
],
'GwEui' => ['description' => '收发此数据包所经过的网关的GwEUI。', 'type' => 'string', 'example' => '0000000000000000'],
'Rssi' => ['description' => '收发此数据包的RSSI。', 'type' => 'integer', 'format' => 'int32', 'example' => '-110'],
'HasMacCommand' => ['description' => '此数据包中是否包含MAC指令。', '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' => '获取网关上下行数据包的统计信息',
'summary' => '调用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' => '',
],
'CountGateways' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'OnlineState',
'in' => 'formData',
'schema' => [
'description' => '网关在离线状态过滤。'."\n"
."\n"
.'若未传入此参数，则不限制在线状态。可取值为**ONLINE**和**OFFLINE**。',
'type' => 'string',
'required' => false,
'example' => 'ONLINE',
'enum' => ['ONLINE', 'OFFLINE'],
],
],
[
'name' => 'FuzzyGwEui',
'in' => 'formData',
'schema' => ['description' => 'GwEUI模糊过滤。', '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' => '网关频段ID过滤。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
],
[
'name' => 'IsEnabled',
'in' => 'formData',
'schema' => ['description' => '网关启停用状态过滤。'."\n"
."\n"
.'若未传入此参数，则不限制启停状态。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '满足过滤条件的网关总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'RequestId' => ['description' => '请求ID。', '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' => '统计网关数量',
'summary' => '统计当前用户账号名下符合过滤条件的网关数量。',
'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' => '',
],
'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' => '',
],
'CreateLocalJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'FreqBandPlanGroupId',
'in' => 'formData',
'schema' => ['description' => '专用入网凭证所采用的频段的频段ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '101'],
],
[
'name' => 'ClassMode',
'in' => 'formData',
'schema' => [
'description' => '专用入网凭证采用的LoRaWAN Class模式。可取值：**A**、**B**、**C**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'A',
'enum' => ['A', 'B', 'C'],
],
],
[
'name' => 'UseDefaultJoinEui',
'in' => 'formData',
'schema' => ['description' => '专用入网凭证是否使用阿里云统一JoinEUI。', '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' => '所创建的专用入网凭证的ID。', 'type' => 'string', 'example' => '123'],
'RequestId' => ['description' => '请求ID。', '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' => '创建专用入网凭证',
'summary' => '当前用户账号将成为该凭证的拥有者，拥有该凭证。',
],
'DeleteLocalJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => ['description' => '要删除的专用入网凭证的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '删除当前用户账号所拥有的专用入网凭证',
'summary' => '调用DeleteLocalJoinPermission删除当前用户账号所拥有的专用入网凭证。',
],
'UpdateOwnedLocalJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '专用入网凭证ID，用来指定要更新的入网凭证。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'formData',
'schema' => ['description' => '专用入网凭证所采用的频段的频段ID，用于更新旧频段。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '201'],
],
[
'name' => 'ClassMode',
'in' => 'formData',
'schema' => [
'description' => '专用入网凭证采用的LoRaWAN Class模式，用于更新旧的 Class 模式。可取值：**A**、**B**、**C**。',
'type' => 'string',
'required' => false,
'example' => 'A',
'enum' => ['A', 'B', 'C'],
],
],
[
'name' => 'JoinPermissionName',
'in' => 'formData',
'schema' => ['description' => '自定义入网凭证名称，用于更新旧名称。', 'type' => 'string', 'required' => false, 'example' => '凭证1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '更新当前用户账号所拥有的专用入网凭证',
'summary' => '调用UpdateOwnedLocalJoinPermission更新当前用户账号所拥有的专用入网凭证。',
],
'UpdateOwnedLocalJoinPermissionEnablingState' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '要操作的专用入网凭证ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['description' => '**true**为启用，**false**为停用。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '启用或停用专用入网凭证',
'summary' => '启用、停用当前用户账号所拥有的专用入网凭证。',
],
'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' => '',
],
'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' => '',
],
'GetJoinPermissionAuthOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'formData',
'schema' => ['description' => '授权工单ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '授权工单的详细信息。',
'type' => 'object',
'properties' => [
'CanceledMillis' => ['description' => '工单被取消的 UNIX 时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'ApplyingMillis' => ['description' => '发起工单的 UNIX 时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'RenterAliyunId' => ['description' => '专用入网凭证的目标租户的阿里云账号ID。', 'type' => 'string', 'example' => 'some_user'],
'AcceptedMillis' => ['description' => '工单被接受的 UNIX 时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'OwnerAliyunId' => ['description' => '发起授权的专用入网凭证拥有者的阿里云账号ID。', 'type' => 'string', 'example' => 'some_user'],
'RejectedMillis' => ['description' => '工单被回绝的 UNIX 时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'JoinPermissionId' => ['description' => '要授权的专用入网凭证ID。', 'type' => 'string', 'example' => '123456'],
'OrderState' => ['description' => '工单状态。取值：'."\n"
."\n"
.'- **APPLYING**：工单发起，等待目标租户处理。'."\n"
.'- **ACCEPTED**：工单被接受。'."\n"
.'- **REJECTED**：工单被回绝。'."\n"
.'- **CANCELED**：工单被取消。', 'type' => 'string', 'example' => 'ACCEPTED'],
'OrderId' => ['description' => '授权工单ID。', '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' => '获取专用凭证授权工单的详细信息',
'summary' => '调用GetJoinPermissionAuthOrder获取专用凭证授权工单的详细信息。',
],
'GetOwnedJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '要获取的入网凭证的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '入网凭证所采用的频段的频段ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '102'],
'TxDailySum' => ['description' => '入网凭证的当天下行数据包量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'JoinPermissionId' => ['description' => '入网凭证ID。', 'type' => 'string', 'example' => '123'],
'ClassMode' => ['description' => '入网凭证采用的LoRaWAN Class模式。取值：**A**、**B**、**C**。', 'type' => 'string', 'example' => 'A'],
'DataDispatchDestination' => ['description' => '数据流转目的地。取值：'."\n"
."\n"
.'- **IOT**：数据流转到IoT的产品。'."\n"
.'- **ONS**：数据流转到MQ的Topic。', 'type' => 'string', 'example' => 'IOT'],
'RxDailySum' => ['description' => '入网凭证的当天上行数据包量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'JoinEui' => ['description' => '入网凭证所使用的JoinEUI。', 'type' => 'string', 'example' => '0000000000000000'],
'CreateMillis' => ['description' => '入网凭证的创建时间。格式为 UNIX 时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'Enabled' => ['description' => '入网凭证的启停用状态。', 'type' => 'boolean', 'example' => 'true'],
'RenterAliyunId' => ['description' => '入网凭证租户的阿里云账号ID。', 'type' => 'string', 'example' => 'some-user'],
'NodesCnt' => ['description' => '使用该入网凭证的节点的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'JoinPermissionName' => ['description' => '入网凭证的名称。', 'type' => 'string', 'example' => '凭证1'],
'AuthState' => ['description' => '入网凭证的授权状态。取值：'."\n"
."\n"
.'- **NEW**：未授权'."\n"
.'- **APPLYING**：授权中'."\n"
.'- **ACCEPTED**：已授权', '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' => '获取入网凭证',
'summary' => '根据入网凭证ID获取当前用户账号所拥有的入网凭证。',
'description' => '> 通过该接口获取的一定是当前用户账号所拥有的某个专用入网凭证。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetRentedJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '入网凭证ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '租用的入网凭证信息列表。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '入网凭证的类型。取值：'."\n"
."\n"
.'- **LOCAL**：专用凭证。'."\n"
.'- **ROAMING**：泛在凭证。', 'type' => 'string', 'example' => 'LOCAL'],
'RxMonthSum' => ['description' => '入网凭证的当月上行数据包量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TxMonthSum' => ['description' => '入网凭证的当月下行数据包量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'FreqBandPlanGroupId' => ['description' => '入网凭证采用的频段的频段ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '102'],
'TxDailySum' => ['description' => '入网凭证的当天下行数据包量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'JoinPermissionId' => ['description' => '入网凭证ID。', 'type' => 'string', 'example' => '123'],
'ClassMode' => ['description' => '入网凭证采用的LoRaWAN Class模式，可取值：**A**、**B**、**C**。', 'type' => 'string', 'example' => 'A'],
'RxDailySum' => ['description' => '入网凭证的当天上行数据包量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'JoinEui' => ['description' => '入网凭证使用的JoinEUI。', 'type' => 'string', 'example' => '0000000000000000'],
'Enabled' => ['description' => '入网凭证的启停用状态。**true**表示启用，**false**表示停用。', 'type' => 'boolean', 'example' => 'false'],
'CreateMillis' => ['description' => '入网凭证的创建时间，格式为 UNIX 时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'NodesCnt' => ['description' => '使用该入网凭证的节点数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'JoinPermissionName' => ['description' => '入网凭证的名称。', 'type' => 'string', 'example' => '凭证1'],
],
],
],
],
],
],
'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' => '获取租用入网凭证',
'summary' => '根据入网凭证ID，获取当前用户账号租用的入网凭证（可能是专用入网凭证或泛在入网凭证）。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListOwnedJoinPermissions' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'FuzzyRenterAliyunId',
'in' => 'formData',
'schema' => ['description' => '模糊匹配入网凭证租户的阿里云账号ID。', 'type' => 'string', 'required' => false, 'example' => 'some-user'],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'formData',
'schema' => ['description' => '模糊匹配入网凭证所使用的JoinEUI。', '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' => '凭证1'],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['description' => '本次查询的起始位置，从 0 开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['description' => '本次查询的入网凭证的数量上限，大于等于 1。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '指定排序字段，可取值为**CREATED_MILLIS**, 表示根据创建时间排序。',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '配合**SortingField**参数一起使用，**true**表示升序，**false**表示降序。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '入网凭证使用的JoinEUI。', 'type' => 'string', 'example' => '0000000000000000'],
'FreqBandPlanGroupId' => ['description' => '入网凭证采用的频段的频段ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '102'],
'Enabled' => ['description' => '入网凭证的启停用状态。', 'type' => 'boolean', 'example' => 'true'],
'RenterAliyunId' => ['description' => '入网凭证租户的阿里云账号ID。', 'type' => 'string', 'example' => 'some-user1'],
'JoinPermissionId' => ['description' => '入网凭证的ID。', 'type' => 'string', 'example' => '102'],
'JoinPermissionName' => ['description' => '入网凭证的名称。', 'type' => 'string', 'example' => '凭证1'],
'ClassMode' => ['description' => '入网凭证采用的LoRaWAN Class模式，可取值：**A**、**B**、**C**。', 'type' => 'string', 'example' => 'A'],
'AuthState' => ['description' => '入网凭证的授权状态。取值：'."\n"
."\n"
.'- **NEW**：未授权'."\n"
.'- **APPLYING**：授权中'."\n"
.'- **ACCEPTED**：已授权', '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' => '查询入网凭证列表',
'summary' => '根据过滤条件查询当前用户账号所拥有的入网凭证列表。',
'description' => '> 通过该接口获取到的当前用户账号名下的是专用入网凭证。',
],
'ListRentedJoinPermissions' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'FuzzyOwnerAliyunId',
'in' => 'formData',
'schema' => ['description' => '模糊匹配入网凭证拥有者的阿里云账号ID。', 'type' => 'string', 'required' => false, 'example' => 'some-user'],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'formData',
'schema' => ['description' => '模糊匹配入网凭证使用的JoinEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['description' => '按照凭证的启停用状态进行过滤。**true**表示启用，**false**表示停用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'BoundNodeGroup',
'in' => 'formData',
'schema' => ['description' => '根据入网凭证是否关联到节点分组进行过滤。**true**表示已关联，**false**表示未关联。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'description' => '按照入网凭证的类型进行过滤，取值：'."\n"
."\n"
.'- **LOCAL**：专用凭证'."\n"
.'- **ROAMING**：泛在凭证',
'type' => 'string',
'required' => false,
'example' => 'LOCAL',
'enum' => ['LOCAL', 'ROAMING'],
],
],
[
'name' => 'FuzzyJoinPermissionName',
'in' => 'formData',
'schema' => ['description' => '模糊匹配入网凭证的名称。', 'type' => 'string', 'required' => false, 'example' => '凭证1'],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['description' => '本次查询的起始位置，从 0 开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['description' => '本次查询的入网凭证数量的上限，大于等于 1。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '指定排序字段，可取值为**CREATED_MILLIS**, 表示根据创建时间排序。',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '配合**SortingField**参数一起使用，**true**表示升序，**false**表示降序。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '入网凭证使用的的JoinEUI。', 'type' => 'string', 'example' => '0000000000000000'],
'FreqBandPlanGroupId' => ['description' => '入网凭证采用的频段的频段ID。', 'type' => 'string', 'example' => '102'],
'BoundNodeGroup' => ['description' => '入网凭证是否已关联到节点分组。', 'type' => 'boolean', 'example' => 'false'],
'Enabled' => ['description' => '入网凭证的启停用状态。', 'type' => 'boolean', 'example' => 'true'],
'OwnerAliyunId' => ['description' => '- 如果该入网凭证是**专用入网凭证**，该字段表示拥有者的阿里云账号ID。'."\n"
.'- 如果该入网凭证是**泛在入网凭证**，该字段恒为**AliCloud IoT**。', 'type' => 'string', 'example' => 'some-user1'],
'JoinPermissionId' => ['description' => '入网凭证ID。', 'type' => 'string', 'example' => '123'],
'JoinPermissionName' => ['description' => '入网凭证的名称。', 'type' => 'string', 'example' => '凭证1'],
'ClassMode' => ['description' => '入网凭证采用的LoRaWAN Class模式，可取值：**A**、**B**、**C**。', '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' => '查询入网凭证列表',
'summary' => '查询当前用户账号所租用的入网凭证列表（可能是专用入网凭证或泛在入网凭证）。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AcceptJoinPermissionAuthOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'formData',
'schema' => ['description' => '要接受的授权工单ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '接受专用入网凭证授权工单',
'summary' => '调用AcceptJoinPermissionAuthOrder接受专用入网凭证授权工单。',
'description' => '开发者（解决方案供应商）通过该接口接受一个由网络运营者授权的专用入网凭证。',
'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' => '',
],
'CancelJoinPermissionAuthOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'formData',
'schema' => ['description' => '要撤销的授权工单ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '取消专用入网凭证授权工单',
'summary' => '调用CancelJoinPermissionAuthOrder取消专用入网凭证授权工单。',
'description' => '网络运营者可以通过该接口取消一个尚未被接受的授权工单。',
],
'CountOwnedJoinPermissions' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'FuzzyRenterAliyunId',
'in' => 'formData',
'schema' => ['description' => '模糊匹配入网凭证租户的阿里云账号ID。', 'type' => 'string', 'required' => false, 'example' => 'some-user'],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'formData',
'schema' => ['description' => '模糊匹配入网凭证使用的JoinEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['description' => '按照凭证的启停用状态进行过滤。'."\n"
."\n"
.'**true**表示启用，**false**表示停用。', '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' => '请求ID。', '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' => '统计入网凭证的数量',
'summary' => '统计符合过滤条件的当前用户账号所拥有的入网凭证的数量。',
'description' => '> 能够被用户账号“拥有”的入网凭证一定是专用入网凭证。',
],
'CountRentedJoinPermissions' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'FuzzyOwnerAliyunId',
'in' => 'formData',
'schema' => ['description' => '模糊匹配入网凭证拥有者的阿里云账号ID。', 'type' => 'string', 'required' => false, 'example' => 'some-user'],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'formData',
'schema' => ['description' => '模糊匹配入网凭证的JoinEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['description' => '按照凭证的启停用状态进行过滤。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'BoundNodeGroup',
'in' => 'formData',
'schema' => ['description' => '根据入网凭证是否关联到节点分组进行过滤。'."\n"
."\n"
.'**true**表示已关联，**false**表示未关联。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => ['description' => '按照凭证的类型进行过滤。取值：'."\n"
."\n"
.'- **LOCAL**：专用凭证'."\n"
.'- **ROAMING**：泛在凭证', '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' => '请求ID。', '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' => '统计入网凭证数量',
'summary' => '统计当前用户账号所租用的且符合过滤条件的入网凭证数量。',
],
'RejectJoinPermissionAuthOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'formData',
'schema' => ['description' => '要回绝的授权工单ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '回绝专用入网凭证授权工单',
'summary' => '调用RejectJoinPermissionAuthOrder回绝专用入网凭证授权工单。',
'description' => '> 开发者（解决方案供应商）通过该接口回绝一个由网络运营者授权的专用入网凭证。',
],
'ReturnJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '要归还的入网凭证ID。', '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' => '请求ID。', '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' => '归还租用的入网凭证',
'summary' => '归还租用的入网凭证（可以是专用入网凭证或泛在入网凭证）。',
],
'SubmitJoinPermissionAuthOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '要授权的专用入网凭证ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'RenterAliyunId',
'in' => 'formData',
'schema' => ['description' => '要授权的开发者的阿里云账号ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'some_user'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '授权工单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'RequestId' => ['description' => '请求ID。', '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' => '发起专用入网凭证授权工单',
'summary' => '调用SubmitJoinPermissionAuthOrder发起专用入网凭证授权工单。',
'description' => '网络运营者可以通过该接口向开发者（解决方案供应商）授权一个专用入网凭证。不过只是发起了一个授权工单，需待开发者接受该授权后，授权才能完成。',
],
'AddNodeToGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['description' => '节点的DevEUI。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'PinCode',
'in' => 'formData',
'schema' => ['description' => '节点的PIN Code。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'],
],
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '在节点分组中增加新的节点',
'summary' => '调用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' => '与节点分组关联的入网凭证ID。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '节点分组ID。', 'type' => 'string', 'example' => '123456'],
'RequestId' => ['description' => '请求ID。', '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' => '创建节点分组',
'summary' => '调用CreateNodeGroup创建节点分组。',
],
'DeleteNodeGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '要删除的节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '删除节点分组',
'summary' => '调用DeleteNodeGroup删除节点分组。',
],
'UpdateDataDispatchConfig' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '要更新的节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'DataDispatchDestination',
'in' => 'formData',
'schema' => [
'description' => '数据流转目的地。取值：'."\n"
."\n"
.'- **IOT**：数据流转到IoT的产品。'."\n"
.'- **ONS**：数据流转到MQ的Topic。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'IOT',
'enum' => ['IOT', 'MQ'],
],
],
[
'name' => 'ProductType',
'in' => 'formData',
'schema' => [
'description' => '数据流转目的地为IoT的产品类型。取值：'."\n"
."\n"
.'- **IOT_SUITE**：数据流转到 IoT 套件基础版。'."\n"
.'- **IOT_SUITE_SENIOR**：数据流转到 IoT 套件高级版。',
'type' => 'string',
'required' => false,
'example' => 'IOT_SUITE',
'enum' => ['IOT_SUITE', 'IOT_SUITE_SENIOR'],
],
],
[
'name' => 'ProductName',
'in' => 'formData',
'schema' => ['description' => '数据流转目的地为IoT的产品名称。', 'type' => 'string', 'required' => false, 'example' => '产品1'],
],
[
'name' => 'ProductKey',
'in' => 'formData',
'schema' => ['description' => '数据流转目的地为IoT的Product Key。', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxx'],
],
[
'name' => 'UplinkRegionName',
'in' => 'formData',
'schema' => ['description' => '数据流转目的地为MQ的上行Region Id。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
],
[
'name' => 'UplinkTopic',
'in' => 'formData',
'schema' => ['description' => '数据流转目的地为MQ的上行Topic。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '更新节点分组的数据流转配置',
'summary' => '调用UpdateDataDispatchConfig更新节点分组的数据流转配置。',
],
'UpdateDataDispatchEnablingState' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'DataDispatchEnabled',
'in' => 'formData',
'schema' => ['description' => '- **true**：表示启用数据流转'."\n"
.'- **false**：表示停用数据流转', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '启停节点分组的数据流转',
'summary' => '调用UpdateDataDispatchEnablingState启停节点分组的数据流转。',
],
'UpdateNodeGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '节点分组ID。', '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' => '请求ID。', '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' => '更新节点分组',
'summary' => '调用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' => '节点的DevEUI。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '节点信息列表。',
'type' => 'object',
'properties' => [
'LastJoinMillis' => ['description' => '最近一次入网的时间，UNIX时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'DevAddr' => ['description' => '节点的网络地址。', 'type' => 'string', 'example' => '12345678'],
'DevEui' => ['description' => '节点的DevEUI。', 'type' => 'string', 'example' => '0000000000000000'],
'BoundMillis' => ['description' => '节点加入当前节点分组的时间，UNIX时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'ClassMode' => ['description' => '节点所采用的LoRaWAN Class模式，可取值：A、B、C。', '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' => '获取节点信息',
'summary' => '调用GetNode获取节点信息。',
],
'GetNodeGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '- 如果关联的是专用入网凭证，该字段表示入网凭证的拥有者的阿里云账号ID。'."\n"
.'- 如果关联的是泛在入网凭证，该字段的值恒为**AliCloud IoT**。', 'type' => 'string', 'example' => 'some-user'],
'TxMonthSum' => ['description' => '与节点分组关联的入网凭证的当月下行数据包量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'FreqBandPlanGroupId' => ['description' => '节点分组中的节点所采用的频段的频段ID，与分组所关联的入网凭证中指定的一致。', 'type' => 'integer', 'format' => 'int64', 'example' => '102'],
'TxDailySum' => ['description' => '与节点分组关联的入网凭证的当天下行数据包量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'JoinPermissionEnabled' => ['description' => '与节点分组关联的入网凭证的启停状态，**true**表示启用，**false**表示停用。', 'type' => 'boolean', 'example' => 'true'],
'JoinPermissionId' => ['description' => '与节点分组关联的入网凭证的ID。', 'type' => 'string', 'example' => '1234569'],
'ClassMode' => ['description' => '节点分组中的节点所采用的LoRaWAN Class模式，与分组所关联的入网凭证中指定的一致。', 'type' => 'string', 'example' => 'A'],
'NodeGroupId' => ['description' => '节点分组ID。', 'type' => 'string', 'example' => '123456'],
'DataDispatchEnabled' => ['description' => '节点分组的数据流转启停状态，**true**表示启用，**false**表示停用。', 'type' => 'boolean', 'example' => 'true'],
'RxDailySum' => ['description' => '与节点分组关联的入网凭证的当天上行数据包量。', 'type' => 'string', 'example' => '0'],
'JoinEui' => ['description' => '节点分组中的节点所使用的JoinEUI，与分组所关联的入网凭证中指定的JoinEUI一致。', 'type' => 'string', 'example' => '0000000000000000'],
'CreateMillis' => ['description' => '节点分组的创建时间，格式为 UNIX 时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'JoinPermissionType' => ['description' => '与节点分组关联的入网凭证类型。取值：'."\n"
."\n"
.'- **LOCAL**：专用凭证'."\n"
.'- **ROAMING**：泛在凭证', 'type' => 'string', 'example' => 'LOCAL'],
'NodesCnt' => ['description' => '节点分组中的节点数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'JoinPermissionName' => ['description' => '与节点分组关联的入网凭证的名称。', 'type' => 'string', 'example' => '凭证1'],
'Locks' => [
'description' => '节点分组所关联的操作锁列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LockId' => ['description' => '锁ID。', 'type' => 'string', 'example' => '123'],
'LockType' => ['description' => '锁的类型。取值：**WRITE**，所有写操作都加锁，包括编辑、删除等。', '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' => '数据流转目的地。取值：'."\n"
."\n"
.'- **IOT**：数据流转到 IoT 的产品。'."\n"
.'- **ONS**：数据流转到 MQ 的 Topic。', 'type' => 'string', 'example' => 'IOT'],
'IotProduct' => [
'description' => '如果流转目的地是IoT产品，该字段存储产品信息。',
'type' => 'object',
'properties' => [
'ProductKey' => ['description' => '产品Product Key。', 'type' => 'string', 'example' => 'xxxxxxxx'],
'ProductName' => ['description' => '产品名。', 'type' => 'string', 'example' => '产品名'],
'ProductType' => ['description' => '产品类型。取值：'."\n"
."\n"
.'- **IOT_SUITE**：数据流转到IoT套件基础版。'."\n"
.'- **IOT_SUITE_SENIOR**：数据流转到IoT套件高级版。', 'type' => 'string', 'example' => 'IOT_SUITE'],
],
],
'OnsTopics' => [
'description' => '如果流转目的地是MQ, 该字段存储MQ Topic信息。',
'type' => 'object',
'properties' => [
'UplinkTopic' => ['description' => 'MQ上行Topic。', 'type' => 'string', 'example' => 'topic2'],
'UplinkRegionName' => ['description' => 'MQ上行Region ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'DownlinkRegionName' => ['description' => 'MQ下行Region ID。', 'type' => 'string', 'example' => 'cn-beijing'],
'DownlinkTopic' => ['description' => 'MQ下行Topic。', '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' => '根据节点分组ID获取节点分组信息',
'summary' => '调用GetNodeGroup根据节点分组ID获取节点分组信息。',
'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' => '',
],
'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' => '',
],
'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' => '模糊匹配节点分组所使用的JoinEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'formData',
'schema' => ['description' => '模糊匹配分组中的节点DevEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['description' => '本次查询的起始位置，从**0**开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['description' => '本次查询的分组数量上限，大于等于**1**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '指定排序字段，可取值为**CREATED_MILLIS**, 表示根据创建时间排序。',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '配合**SortingField**参数一起使用，**true**表示升序，**false**表示降序。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '节点分组名称2'],
'JoinPermissionOwnerAliyunId' => ['description' => '- 如果关联的是专用入网凭证，该字段表示入网凭证的拥有者的阿里云账号ID。'."\n"
.'- 如果关联的是泛在入网凭证，该字段的值恒为**AliCloud IoT**。', 'type' => 'string', 'example' => 'some-user2'],
'TxMonthSum' => ['description' => '与节点分组关联的入网凭证的当月下行数据包量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'FreqBandPlanGroupId' => ['description' => '节点分组中的节点所采用的频段的频段ID，与分组所关联的入网凭证中指定的一致。', 'type' => 'integer', 'format' => 'int64', 'example' => '102'],
'TxDailySum' => ['description' => '与节点分组关联的入网凭证的当天下行数据包量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'JoinPermissionEnabled' => ['description' => '与节点分组关联的入网凭证的启停状态，**true**表示启用，**false**表示停用。', 'type' => 'boolean', 'example' => 'true'],
'JoinPermissionId' => ['description' => '与节点分组关联的入网凭证的ID。', 'type' => 'string', 'example' => '123456'],
'ClassMode' => ['description' => '节点分组中的节点所采用的LoRaWAN Class模式，与分组所关联的入网凭证中指定的一致。', 'type' => 'string', 'example' => 'A'],
'NodeGroupId' => ['description' => '节点分组ID。', 'type' => 'string', 'example' => '123456'],
'DataDispatchEnabled' => ['description' => '节点分组的数据流转启停状态，**true**表示启用，**false**表示停用。', 'type' => 'boolean', 'example' => 'true'],
'RxDailySum' => ['description' => '与节点分组关联的入网凭证的当天上行数据包量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'JoinEui' => ['description' => '节点分组中的节点所使用的JoinEUI，与分组所关联的入网凭证中指定的JoinEUI一致。', 'type' => 'string', 'example' => '0000000000000000'],
'CreateMillis' => ['description' => '节点分组的创建时间，格式为UNIX时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'JoinPermissionType' => ['description' => '与节点分组关联的入网凭证类型。取值：'."\n"
."\n"
.'- **LOCAL**：专用凭证'."\n"
.'- **ROAMING**：泛在凭证', 'type' => 'string', 'example' => 'LOCAL'],
'NodesCnt' => ['description' => '节点分组中的节点数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Locks' => [
'description' => '节点分组所关联的操作锁列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LockId' => ['description' => '锁ID。', 'type' => 'string', 'example' => '123'],
'LockType' => ['description' => '锁的类型。取值：**WRITE**，所有写操作都加锁，包括编辑、删除等。', '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' => '数据流转目的地。取值：'."\n"
."\n"
.'- **IOT**：数据流转到IoT的产品。'."\n"
.'- **ONS**：数据流转到MQ的Topic。', 'type' => 'string', 'example' => 'IOT'],
'IotProduct' => [
'description' => '如果流转目的地是IoT产品，该字段存储产品信息。',
'type' => 'object',
'properties' => [
'ProductKey' => ['description' => '产品Product Key。', 'type' => 'string', 'example' => 'xxxxxxxx'],
'ProductName' => ['description' => '产品名。', 'type' => 'string', 'example' => '产品名'],
'ProductType' => ['description' => '产品类型。', 'type' => 'string', 'example' => 'IOT_SUITE'],
],
],
'OnsTopics' => [
'description' => '如果流转目的地是MQ，该字段存储MQ Topic信息。',
'type' => 'object',
'properties' => [
'UplinkTopic' => ['description' => 'MQ 上行 Topic。', 'type' => 'string', 'example' => 'topic2'],
'UplinkRegionName' => ['description' => 'MQ 上行 Region Id。', 'type' => 'string', 'example' => 'cn-shanghai'],
'DownlinkRegionName' => ['description' => 'MQ 下行 Region Id。', 'type' => 'string', 'example' => 'cn-beijing'],
'DownlinkTopic' => ['description' => 'MQ 下行 Topic。', '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' => '查询节点分组列表',
'summary' => '查询当前用户账号的符合过滤条件的节点分组列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListNodeGroupTransferFlowStats' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '节点组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '查询开始时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '查询结束时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514737000000'],
],
[
'name' => 'TimeIntervalUnit',
'in' => 'formData',
'schema' => [
'description' => '时间间隔的单位。取值：'."\n"
.'- **INTERVAL_IN_HOURS**：按照小时统计'."\n"
.'- **INTERVAL_IN_DAYS**：按照天统计',
'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' => '请求ID。', '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' => '统计UNIX时间戳, 以毫秒为单位。', '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' => '查询节点组流量统计列表',
'summary' => '调用ListNodeGroupTransferFlowStats查询节点组流量统计列表。',
],
'ListNodeGroupTransferPackets' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['description' => '根据DevEUI过滤数据包。', 'type' => 'string', 'required' => false, 'example' => '0000000000000001'],
],
[
'name' => 'Category',
'in' => 'formData',
'schema' => [
'description' => '数据包分类。取值：'."\n"
."\n"
.'- **DOWNLINK_PACKET**：下行包'."\n"
.'- **UPLINK_PACKET**：上行包',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'UPLINK_PACKET',
'enum' => ['DOWNLINK_PACKET', 'UPLINK_PACKET', 'INVALID_PACKET'],
],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '分页页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '分页大小，大于等于1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '300', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'BeginMillis',
'in' => 'formData',
'schema' => ['description' => '查询开始时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'formData',
'schema' => ['description' => '查询结束时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '排序字段，取值：**LOG_MILLIS**，表示按照时间排序。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'LOG_MILLIS',
'enum' => ['LOG_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '配合**SortingField**参数一起使用，**true**表示升序，**false**表示降序。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '数据包传输的UNIX时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'GwOwnerAliyunId' => ['description' => '数据包所经过网关所属用户的阿里云账号ID。', 'type' => 'string', 'example' => 'xxx'],
'ProcessEvent' => ['description' => '该报文的处理结果，取值：'."\n"
."\n"
.'- **SUCCESS**：成功。'."\n"
.'- **DEVADDR_ILLEGAL**：DevAddr不合法。'."\n"
.'- **MIC_FAIL**：MIC校验失败。'."\n"
.'- **DEVEUI_ILLEGAL**：DevEui不合法。'."\n"
.'- **JOINEUI_ILLEGAL**：JoinEui不合法。'."\n"
.'- **STATUS_INVALID**：节点状态不合法。'."\n"
.'- **REDUPLICATE**：重复包。'."\n"
.'- **ISOLATED**：网间隔离。'."\n"
.'- **APPKEY_ILLEGAL**：AppKey不合法。'."\n"
.'- **UPDATE_RUNTIME_CFG_FAIL**：更新运行时配置失败。'."\n"
.'- **DELAY_PROCESS**：延迟处理。'."\n"
.'- **GWEUI_ILLEGAL**：GwEui不合法。'."\n"
.'- **GW_STATUS_INVALID**：网关状态不合法。'."\n"
.'- **GW_FREQ_NOT_MATCH**：网关频点不匹配。'."\n"
.'- 其它：未知错误。', 'type' => 'string', 'example' => 'SUCCESS'],
'Base64EncodedMacPayload' => ['description' => 'Base64编码后的MACPayload报文。', 'type' => 'string', 'example' => 'xxx'],
'FPort' => ['description' => '收发此数据包时所使用的FPort。', 'type' => 'integer', 'format' => 'int32', 'example' => '99'],
'Lsnr' => ['description' => '收发此数据包的信噪比。', 'type' => 'number', 'format' => 'float', 'example' => '-10.5'],
'FreqBandPlanGroupId' => ['description' => '数据包所经过的网关所采用的频段的频段ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '101'],
'HasData' => ['description' => '此数据包中是否包含业务数据。', 'type' => 'boolean', 'example' => 'true'],
'ClassMode' => ['description' => '收发此数据包时的通信模式。', 'type' => 'string', 'example' => 'C'],
'MacPayloadSize' => ['description' => '此数据包的MACPayload报文长度。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
'MessageType' => ['description' => '消息类型，取值：'."\n"
."\n"
.'- JOIN_REQUEST：Join-request消息'."\n"
.'- JOIN_ACCEPT：Join-accept消息'."\n"
.'- UNCONFIRMED_UP：Unconfirmed上行消息'."\n"
.'- UNCONFIRMED_DOWN：Unconfirmed下行消息'."\n"
.'- CONFIRMED_UP：Confirmed上行消息'."\n"
.'- CONFIRMED_DOWN：Confirmed下行消息'."\n"
.'- REJOIN_REQUEST：Rejoin-request消息'."\n"
.'- PROPRIETARY：Proprietary消息（私有消息）', 'type' => 'string', 'example' => 'JOIN_REQUEST'],
'Datr' => ['description' => '收发此数据包的数据速率。', 'type' => 'string', 'example' => 'SF12BW125'],
'DevAddr' => ['description' => '收发此数据包的节点的网络地址。', 'type' => 'string', 'example' => '00000000'],
'DevEui' => ['description' => '收发此数据包的节点的DevEUI。', 'type' => 'string', 'example' => '0000000000000001'],
'MacCommandCIDs' => [
'type' => 'string',
'items' => ['description' => '这个数据包所携带的MAC指令列表。', 'type' => 'string', 'example' => '["0x01","0x02"]', 'index' => 200],
],
'GwEui' => ['description' => '收发此数据包所经过的网关的GwEUI。', 'type' => 'string', 'example' => '0000000000000000'],
'Rssi' => ['description' => '收发此数据包的RSSI。', 'type' => 'integer', 'format' => 'int32', 'example' => '-110'],
'HasMacCommand' => ['description' => '此数据包中是否包含MAC指令。', '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' => '获取节点分组上下行数据包的统计信息',
'summary' => '调用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' => '节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'formData',
'schema' => ['description' => '模糊匹配节点的DevEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['description' => '本次查询的起始位置，从**0**开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['description' => '本次查询的节点数量上限，大于等于**1**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '指定排序字段，可取值为**CREATED_MILLIS**，表示根据创建时间排序。',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS', 'LAST_JOIN_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '配合**SortingField**参数一起使用，**true**表示升序，**false**表示降序。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '最近一次入网的时间，UNIX时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'DevAddr' => ['description' => '节点的网络地址。', 'type' => 'string', 'example' => '12345678'],
'DevEui' => ['description' => '节点的DevEUI。', 'type' => 'string', 'example' => '0000000000000000'],
'BoundMillis' => ['description' => '节点加入当前节点分组的时间，UNIX时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'ClassMode' => ['description' => '节点所采用的LoRaWAN Class模式，可取值：A、B、C。', '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' => '查询指定节点分组中的节点列表',
'summary' => '调用ListNodesByNodeGroupId根据过滤条件，查询指定节点分组中的节点列表。',
],
'ListNodesByOwnedJoinPermissionId' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '入网凭证ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'formData',
'schema' => ['description' => '模糊匹配节点的DevEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Offset',
'in' => 'formData',
'schema' => ['description' => '本次查询的起始位置，从**0**开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'formData',
'schema' => ['description' => '本次查询的节点数量上限，大于等于**1**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'formData',
'schema' => [
'description' => '指定排序字段，可取值为**CREATED_MILLIS**, 表示根据创建时间排序。',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS', 'LAST_JOIN_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'formData',
'schema' => ['description' => '配合**SortingField**参数一起使用，**true**表示升序，**false**表示降序。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '最近一次入网的时间，UNIX时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'DevAddr' => ['description' => '节点的网络地址。', 'type' => 'string', 'example' => '12345678'],
'DevEui' => ['description' => '节点的DevEUI。', 'type' => 'string', 'example' => '0000000000000000'],
'BoundMillis' => ['description' => '节点加入当前节点分组的时间，UNIX时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'ClassMode' => ['description' => '节点所采用的LoRaWAN Class模式，可取值：A、B、C。', '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' => '查询使用了特定入网凭证的节点列表',
'summary' => '调用ListNodesByOwnedJoinPermissionId根据过滤条件，查询使用了特定入网凭证的节点列表。',
'description' => '> 所指定的入网凭证必须时当前用户账号所拥有的入网凭证。',
],
'ListNodeTransferPacketPaths' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['description' => '根据DevEUI过滤数据包。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000001'],
],
[
'name' => 'Base64EncodedMacPayload',
'in' => 'formData',
'schema' => ['description' => '数据包的MacPayload，由**ListNodeGroupTransferPackets**接口的返回值获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxx'],
],
[
'name' => 'LogMillis',
'in' => 'formData',
'schema' => ['description' => '收到此数据包的时间，由**ListNodeGroupTransferPackets**的返回值获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '14643600000'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '当前页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '分页大小，大于等于1。', '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' => '请求ID。', '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' => '收发此数据包的节点的DevEUI。', 'type' => 'string', 'example' => '0000000000000001'],
'GwEui' => ['description' => '收发数据包所经过的网关的GwEUI。', 'type' => 'string', 'example' => '0000000000000000'],
'Lsnr' => ['description' => '收发此数据包的信噪比。', 'type' => 'number', 'format' => 'float', 'example' => '-10.5'],
'Rssi' => ['description' => '收发此数据包的RSSI。', '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' => '获取节点上行数据包的平行路径',
'summary' => '调用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' => '',
],
'BindJoinPermissionToNodeGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '参与关联的节点分组ID。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '参与关联的入网凭证ID。', 'type' => 'string', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '建立入网凭证和节点分组的关联',
'summary' => '调用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' => '模糊匹配节点分组中节点所使用的 JoinEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'formData',
'schema' => ['description' => '模糊匹配节点分组中节点的 DevEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '满足过滤条件的节点分组总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'RequestId' => ['description' => '请求ID。', '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' => '统计符合过滤条件的节点分组总数',
'summary' => '调用CountNodeGroups统计符合过滤条件的节点分组总数。',
],
'CountNodesByNodeGroupId' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '节点分组ID。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'formData',
'schema' => ['description' => '模糊匹配节点的DevEUI。', 'type' => 'string', 'required' => false, 'example' => '0000000000000000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '满足过滤条件的节点数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'RequestId' => ['description' => '请求ID。', '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' => '统计节点数量',
'summary' => '统计某节点分组中且满足过滤条件的节点数量。',
],
'CountNodesByOwnedJoinPermissionId' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '入网凭证ID。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'formData',
'schema' => ['description' => '模糊匹配节点的DevEUI。', 'type' => 'string', 'required' => false, 'example' => '0000000000000000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '满足过滤条件的节点数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'RequestId' => ['description' => '请求ID。', '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' => '统计节点数量',
'summary' => '统计使用某入网凭证且满足过滤条件的节点的数量。',
'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' => '',
],
'RemoveNodeFromGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'formData',
'schema' => ['description' => '要移除的节点的DevEUI。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '从节点分组中移除节点',
'summary' => '调用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' => '',
],
'UnbindJoinPermissionFromNodeGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'formData',
'schema' => ['description' => '要接触关联的节点分组ID。', 'type' => 'string', 'required' => false, 'example' => '123'],
],
[
'name' => 'JoinPermissionId',
'in' => 'formData',
'schema' => ['description' => '参与关联的入网凭证ID。', 'type' => 'string', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', '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' => '接触入网凭证和节点分组的关联',
'summary' => '调用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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
'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' => '',
],
],
'endpoints' => [
['regionId' => 'cn-hangzhou', 'endpoint' => 'linkwan.cn-hangzhou.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'endpoint' => 'linkwan.cn-shanghai.aliyuncs.com'],
],
];