'1.0',
'info' => ['style' => 'RPC', 'product' => 'LinkWAN', 'version' => '2019-03-01'],
'directories' => [
[
'children' => ['CountGateways', 'GetGatewayStatusStat'],
'type' => 'directory',
'title' => '网关',
'id' => 317595,
],
[
'children' => ['CreateNodeGroup', 'DeleteNodeGroup', 'UpdateNodeGroup', 'CountNodeGroups', 'GetNodeGroup', 'ListNodeGroups'],
'type' => 'directory',
'title' => '节点分组',
'id' => 317603,
],
[
'children' => [
'AcceptJoinPermissionAuthOrder', 'AddNodeToGroup', 'ApplyRoamingJoinPermission', 'BindJoinPermissionToNodeGroup', 'CancelJoinPermissionAuthOrder', 'CheckCloudProductOpenStatus', 'CheckUserChargeStatus', 'CountGatewayTupleOrders', 'CountNodeTupleOrders', 'CountNodesByNodeGroupId', 'CountNodesByOwnedJoinPermissionId', 'CountNotifications', 'CountOwnedJoinPermissions', 'CountRentedJoinPermissions', 'CreateGateway', 'CreateLocalJoinPermission', 'DeleteGateway', 'DeleteLocalJoinPermission', 'GetFreqBandPlanGroup', 'GetGateway',
'GetGatewayPacketStat', 'GetGatewayTransferPacketsDownloadUrl', 'GetGatewayTupleOrder', 'GetGatewayTuplesDownloadUrl', 'GetJoinPermissionAuthOrder', 'GetNode', 'GetNodeGroupTransferPacketsDownloadUrl', 'GetNodeTransferPacket', 'GetNodeTransferPacketsDownloadUrl', 'GetNodeTupleOrder', 'GetNodeTuplesDownloadUrl', 'GetNotification', 'GetOwnedJoinPermission', 'GetRentedJoinPermission', 'GetUserLicense', 'ListActivatedFeatures', 'ListActiveGateways', 'ListFreqBandPlanGroups', 'ListGatewayOnlineRecords', 'ListGatewayTransferFlowStats',
'ListGatewayTransferPackets', 'ListGatewayTupleOrders', 'ListGateways', 'ListGatewaysGisInfo', 'ListNodeGroupTransferFlowStats', 'ListNodeGroupTransferPackets', 'ListNodeTransferPacketPaths', 'ListNodeTransferPackets', 'ListNodeTupleOrders', 'ListNodesByNodeGroupId', 'ListNodesByOwnedJoinPermissionId', 'ListNotifications', 'ListOwnedJoinPermissions', 'ListRentedJoinPermissions', 'RejectJoinPermissionAuthOrder', 'RemoveNodeFromGroup', 'ReturnJoinPermission', 'SendUnicastCommand', 'SubmitGatewayTupleOrder', 'SubmitJoinPermissionAuthOrder',
'SubmitNodeTupleOrder', 'UnbindJoinPermissionFromNodeGroup', 'UpdateDataDispatchConfig', 'UpdateDataDispatchEnablingState', 'UpdateGateway', 'UpdateGatewayEnablingState', 'UpdateNotificationsHandleState', 'UpdateOwnedLocalJoinPermission', 'UpdateOwnedLocalJoinPermissionEnablingState', 'UpdateRoamingJoinPermission', 'UpdateRoamingJoinPermissionEnablingState',
],
'title' => '其他',
'type' => 'directory',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AcceptJoinPermissionAuthOrder' => [
'summary' => '调用AcceptJoinPermissionAuthOrder接受专用入网凭证授权工单。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'IllegalOrderStateTransition', 'errorMessage' => 'The order status conversion is invalid.', 'description' => '工单状态转换非法'],
],
],
'title' => '接受专用入网凭证授权工单',
'description' => '开发者（解决方案供应商）通过该接口接受一个由网络运营者授权的专用入网凭证。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AcceptJoinPermissionAuthOrder'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'AddNodeToGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'query',
'schema' => ['description' => '节点的DevEUI。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'PinCode',
'in' => 'query',
'schema' => ['description' => '节点的PIN Code。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'],
],
[
'name' => 'NodeGroupId',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'ExceedNodeLimit', 'errorMessage' => 'The maximum number of nodes is exceeded.', 'description' => '超出节点可使用额度'],
['errorCode' => 'NodeGroupDoesNotExist', 'errorMessage' => 'The specified node group does not exist.', 'description' => '节点组不存在'."\n"],
['errorCode' => 'DevEuiDuplicated', 'errorMessage' => 'A node with the same devEui already exists.', 'description' => '节点重复添加'],
['errorCode' => 'NodeAlreadyAdded', 'errorMessage' => 'The specified node has already been added to another node group.', 'description' => '节点已经添加到其他分组'],
['errorCode' => 'InvalidPinCode', 'errorMessage' => 'An error occurred while verifying PinCode.', 'description' => 'PinCode校验失败'],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.', 'description' => '资源被其他云产品锁定'."\n"],
['errorCode' => 'NodeDoesNotExist', 'errorMessage' => 'The specified node does not exist.', 'description' => '节点不存在'."\n"],
],
],
'title' => '在节点分组中增加新的节点',
'summary' => '调用AddNodeToGroup在节点分组中增加新的节点。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddNodeToGroup'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'ApplyRoamingJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'FreqBandPlanGroupId',
'in' => 'query',
'schema' => ['description' => '泛在凭证所采用的频段ID。取值：'."\n"
."\n"
.'- **102**：CN470异频。'."\n"
.'- **101**：CN470同频。'."\n"
.'- **201**：AS923同频。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '102'],
],
[
'name' => 'ClassMode',
'in' => 'query',
'schema' => [
'description' => '泛在凭证所采用的LoRaWAN Class模式。取值：A、B、C。',
'type' => 'string',
'required' => true,
'example' => 'A',
'enum' => ['A', 'B', 'C', 'D2D'],
],
],
[
'name' => 'JoinPermissionName',
'in' => 'query',
'schema' => ['description' => '泛在凭证名称，支持中文、英文字母、数字和下划线（_），长度限制4～30个字符，一个中文占两个字符。', 'type' => 'string', 'required' => true, 'example' => '泛在凭证1'],
],
[
'name' => 'RxDelay',
'in' => 'query',
'schema' => ['description' => 'Class A的接收窗口延迟时间，取值范围1s~15s。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'DataRate',
'in' => 'query',
'schema' => ['description' => '当**ClassMode**取值为**B**时，设置期望下行速率，取值范围0~5。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '泛在凭证的ID。', 'type' => 'string', 'example' => '1234'],
'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 '],
'Success' => ['description' => '是否调用成功。返回值：'."\n"
."\n"
.'- **true**：调用成功。'."\n"
.'- ** false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'ExceedRoamingJoinPermissionLimit', 'errorMessage' => 'The maximum number of roaming join permissions is exceeded.', 'description' => '超出漫游凭证系统限额'],
['errorCode' => 'JoinPermissionNameDuplicated', 'errorMessage' => 'The specified join permission name already exists.', 'description' => '入网凭证名称重复'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.', 'description' => '名称不合法'],
['errorCode' => 'InvalidFreqBandPlan', 'errorMessage' => 'The frequency band plan is invalid.', 'description' => '频段计划不可用'],
],
],
'title' => '申请泛在凭证',
'summary' => '调用ApplyRoamingJoinPermission申请泛在凭证。',
'description' => '# 限制说明'."\n"
."\n"
.'- 单阿里云账号的泛在凭证数量为一个。'."\n"
.'- 单阿里云账号调用该接口的每秒请求数（QPS）最大限制为5。'."\n"
."\n"
.'> RAM用户共享阿里云账号配额。',
'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~108601~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyRoamingJoinPermission'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"1234\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\t\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue\\n123","errorExample":""}]',
],
'BindJoinPermissionToNodeGroup' => [
'summary' => '调用BindJoinPermissionToNodeGroup建立入网凭证和节点分组的关联。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => ['description' => '参与关联的节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'JoinPermissionId',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'JoinPermissionDoesNotExist', 'errorMessage' => 'The specified join permission does not exist.', 'description' => '入网凭证不存在'],
['errorCode' => 'JoinPermissionAlreadyBoundNodeGroup', 'errorMessage' => 'The specified join permission has already been bound to another node group.', 'description' => '入网凭证已经绑定了节点组'],
['errorCode' => 'NodeGroupDoesNotExist', 'errorMessage' => 'The specified node group does not exist.', 'description' => '节点组不存在'."\n"],
['errorCode' => 'NodeGroupAlreadyBoundJoinPermission', 'errorMessage' => 'This node group is already bound to a join permission.', 'description' => '节点组已经绑定入网凭证'."\n"],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.', 'description' => '资源被其他云产品锁定'."\n"],
],
],
'title' => '建立入网凭证和节点分组的关联',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindJoinPermissionToNodeGroup'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'CancelJoinPermissionAuthOrder' => [
'summary' => '调用CancelJoinPermissionAuthOrder取消专用入网凭证授权工单。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'IllegalOrderStateTransition', 'errorMessage' => 'The order status conversion is invalid.', 'description' => '工单状态转换非法'],
],
],
'title' => '取消专用入网凭证授权工单',
'description' => '网络运营者可以通过该接口取消一个尚未被接受的授权工单。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelJoinPermissionAuthOrder'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'CheckCloudProductOpenStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'ServiceCode',
'in' => 'query',
'schema' => ['description' => '云产品的 Service Code，对于物联网络管理平台而言恒为“linkwan”。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'linkwan'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '当前用户账号是否开通了物联网络管理平台服务。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 '],
'Success' => ['description' => '是否成功。'."\n"
."\n", 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '检查服务开通状态',
'summary' => '检查当前用户账号的物联网络管理平台服务的开通状态，供阿里云内部服务使用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckCloudProductOpenStatus'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\t\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue\\ntrue","errorExample":""}]',
],
'CheckUserChargeStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '用户欠费状态。'."\n"
."\n"
.'NORMAL： 正常'."\n"
."\n"
.'ARREARAGE： 欠费状态', 'type' => 'string', 'example' => 'NORMAL'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 '],
'Success' => ['description' => '是否成功。'."\n"
."\n", 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '检查用户欠费状态',
'summary' => '检查用户欠费状态。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckUserChargeStatus'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"NORMAL\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\t\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"NORMAL\\n89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue","errorExample":""}]',
],
'CountGatewayTupleOrders' => [
'summary' => '统计当前用户账号已提交的网关安全密钥工单的数量，可指定统计特定状态的工单。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'States',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '工单状态过滤列表。若不使用此参数，则表示统计所有状态的工单。'."\n"
."\n"
.'参考工单状态取值'."\n",
'type' => 'array',
'items' => ['type' => 'string', 'description' => ''],
'required' => false,
'example' => 'APPLYING',
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '满足状态过滤条件的工单数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '42'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 '],
'Success' => ['description' => '是否成功。'."\n"
."\n", 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '统计网关安全密钥工单数量',
'requestParamsDescription' => '# 类型说明'."\n"
."\n"
.'### 工单状态取值'."\n"
."\n"
.'| 名称 | 类型 | 说明 |'."\n"
.'| --- | --- | --- |'."\n"
.'| APPLYING | String | 申请中。 |'."\n"
.'| ACCEPTING | String | 颁发中。 |'."\n"
.'| ACCEPTED | String | 颁发成功。 |'."\n"
.'| ACCEPTING_FAILED | String | 颁发失败。 |'."\n"
.'| REJECTED | String | 已拒绝。 |'."\n"
.'| REVOKING | String | 撤回中。 |'."\n"
.'| REVOKING_FAILED | String | 撤回失败。 |'."\n"
.'| REVOKED | String | 撤回成功。 |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountGatewayTupleOrders'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 42,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\t\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue\\n42","errorExample":""}]',
],
'CountGateways' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'OnlineState',
'in' => 'query',
'schema' => [
'description' => '网关在离线状态过滤。'."\n"
."\n"
.'若未传入此参数，则不限制在线状态。可取值为**ONLINE**和**OFFLINE**。',
'type' => 'string',
'required' => false,
'example' => 'ONLINE',
'enum' => ['ONLINE', 'OFFLINE'],
],
],
[
'name' => 'FuzzyGwEui',
'in' => 'query',
'schema' => ['description' => 'GwEUI模糊过滤。', 'type' => 'string', 'required' => false, 'example' => '123456'],
],
[
'name' => 'FuzzyCity',
'in' => 'query',
'schema' => ['description' => '城市名模糊过滤。', 'type' => 'string', 'required' => false, 'example' => '杭州'],
],
[
'name' => 'FuzzyName',
'in' => 'query',
'schema' => ['description' => '网关名称模糊过滤。', 'type' => 'string', 'required' => false, 'example' => 'name'],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'query',
'schema' => ['description' => '网关频段ID过滤。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
],
[
'name' => 'IsEnabled',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '统计网关数量',
'summary' => '统计当前用户账号名下符合过滤条件的网关数量。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountGateways'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'CountNodeGroups' => [
'summary' => '调用CountNodeGroups统计符合过滤条件的节点分组总数。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
.'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n"
."\n"
.'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', 'type' => 'string', 'required' => false, 'example' => 'iot-060a09wy'],
],
[
'name' => 'FuzzyName',
'in' => 'query',
'schema' => ['description' => '模糊匹配节点分组名称。', 'type' => 'string', 'required' => false, 'example' => 'group1'],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'query',
'schema' => ['description' => '模糊匹配节点分组中节点所使用的 JoinEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => 'CountNodeGroups',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountNodeGroups'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'CountNodeTupleOrders' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'States',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '工单状态过滤列表。若不使用此参数，则表示统计所有状态的工单。'."\n"
."\n"
.'参考工单状态取值'."\n"
."\n",
'type' => 'array',
'items' => ['type' => 'string', 'description' => ''],
'required' => false,
'example' => 'ACCEPTED',
'maxItems' => 10,
],
],
[
'name' => 'IsKpm',
'in' => 'query',
'schema' => ['description' => '判断是否是KPM所发起的工单，是否是安全产线发起的工单。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '满足过滤条件的工单数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '42'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 '],
'Success' => ['description' => '是否成功。'."\n"
."\n", 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '统计节点安全元组工单数量',
'summary' => '统计当前用户账号所提交的节点安全元组工单数量，可指定统计特定类型及特定状态的工单。',
'requestParamsDescription' => '### 类型说明'."\n"
."\n\n"
.'### 工单状态取值'."\n"
."\n"
.'| 名称 | 类型 | 说明 |'."\n"
.'| --- | --- | --- |'."\n"
.'| APPLYING | String | 申请中。 |'."\n"
.'| ACCEPTING | String | 颁发中。 |'."\n"
.'| ACCEPTED | String | 颁发成功。 |'."\n"
.'| ACCEPTING_FAILED | String | 颁发失败。 |'."\n"
.'| REJECTED | String | 已拒绝。 |'."\n"
.'| REVOKING | String | 撤回中。 |'."\n"
.'| REVOKING_FAILED | String | 撤回失败。 |'."\n"
.'| REVOKED | String | 撤回成功。 |',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountNodeTupleOrders'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 42,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\t\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue\\n42","errorExample":""}]',
],
'CountNodesByNodeGroupId' => [
'summary' => '统计某节点分组中且满足过滤条件的节点数量。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => ['description' => '节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '统计节点数量',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountNodesByNodeGroupId'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'CountNodesByOwnedJoinPermissionId' => [
'summary' => '统计使用某入网凭证且满足过滤条件的节点的数量。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => ['description' => '入网凭证ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '统计节点数量',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountNodesByOwnedJoinPermissionId'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'CountNotifications' => [
'summary' => '调用CountNotifications统计符合过滤条件的通知数量。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'Category',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '通知类型列表，传null值则不过滤类型。'."\n"
."\n"
.'- GATEWAY_OFFLINE：网关离线信息。'."\n"
."\n"
.'- JOIN_PERMISSION_AUTH_APPLYING：凭证授权中。'."\n"
."\n"
.'- JOIN_PERMISSION_AUTH_ACCEPTED：凭证授权成功。'."\n"
."\n"
.'- JOIN_PERMISSION_AUTH_CANCELED：撤销凭证授权。'."\n"
."\n"
.'- JOIN_PERMISSION_AUTH_REJECTED：拒绝凭证授权。'."\n",
'type' => 'array',
'items' => ['description' => '通知类型列表，传null值则不过滤类型。'."\n"
."\n"
.'- GATEWAY_OFFLINE：网关离线信息。'."\n"
."\n"
.'- JOIN_PERMISSION_AUTH_APPLYING：凭证授权中。'."\n"
."\n"
.'- JOIN_PERMISSION_AUTH_ACCEPTED：凭证授权成功。'."\n"
."\n"
.'- JOIN_PERMISSION_AUTH_CANCELED：撤销凭证授权。'."\n"
."\n"
.'- JOIN_PERMISSION_AUTH_REJECTED：拒绝凭证授权。', 'type' => 'string', 'required' => false, 'example' => 'GATEWAY_OFFLINE'],
'required' => false,
'example' => 'GATEWAY_OFFLINE',
'maxItems' => 100,
],
],
[
'name' => 'HandleState',
'in' => 'query',
'schema' => ['description' => '根据通知处理状态过滤，传null值则不过滤处理状态。', 'type' => 'string', 'required' => false, 'example' => 'UNHANDLED'],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => ['description' => '查询开始时间，毫秒为单位的 UNIX 时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '统计符合过滤条件的通知数量',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountNotifications'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 10,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 10\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'CountOwnedJoinPermissions' => [
'summary' => '统计符合过滤条件的当前用户账号所拥有的入网凭证的数量。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'FuzzyRenterAliyunId',
'in' => 'query',
'schema' => ['description' => '模糊匹配入网凭证租户的阿里云账号ID。', 'type' => 'string', 'required' => false, 'example' => 'some-user'],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'query',
'schema' => ['description' => '模糊匹配入网凭证使用的JoinEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => ['description' => '按照凭证的启停用状态进行过滤。'."\n"
."\n"
.'**true**表示启用，**false**表示停用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'FuzzyJoinPermissionName',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '统计入网凭证数量',
'description' => '> 能够被用户账号“拥有”的入网凭证一定是专用入网凭证。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountOwnedJoinPermissions'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'CountRentedJoinPermissions' => [
'summary' => '统计当前用户账号所租用的且符合过滤条件的入网凭证数量。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'FuzzyOwnerAliyunId',
'in' => 'query',
'schema' => ['description' => '模糊匹配入网凭证拥有者的阿里云账号ID。', 'type' => 'string', 'required' => false, 'example' => 'some-user'],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'query',
'schema' => ['description' => '模糊匹配入网凭证的JoinEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => ['description' => '按照凭证的启停用状态进行过滤。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'BoundNodeGroup',
'in' => 'query',
'schema' => ['description' => '根据入网凭证是否关联到节点分组进行过滤。'."\n"
."\n"
.'**true**表示已关联，**false**表示未关联。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => '按照凭证的类型进行过滤。取值：'."\n"
."\n"
.'- **LOCAL**：专用凭证'."\n"
.'- **ROAMING**：泛在凭证', 'type' => 'string', 'required' => false, 'example' => 'LOCAL'],
],
[
'name' => 'FuzzyJoinPermissionName',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '统计入网凭证数量',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountRentedJoinPermissions'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'CreateGateway' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n"
."\n"
.'>'."\n"
.'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n"
.'- 若无**实例概览**页面或ID值，则无需传入。'."\n"
."\n"
.'>'."\n"
."\n"
.'实例的更多信息，请参见[实例概述](~~356505~~)。', 'type' => 'string', 'required' => false, 'example' => 'iot-***-v6***'],
],
[
'name' => 'GwEui',
'in' => 'query',
'schema' => ['description' => '网关唯一标识。', 'type' => 'string', 'required' => true, 'example' => '0000000000000000'],
],
[
'name' => 'PinCode',
'in' => 'query',
'schema' => ['description' => '网关PinCode，用于确保录入者拥有该网关。', 'type' => 'string', 'required' => true, 'example' => '000000'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '自定义网关名称。'."\n"
."\n"
.'- 仅支持中文汉字、英文字母、数字、下划线（_）。'."\n"
."\n"
.'- 必须以中文汉字、英文字母或数字开头。'."\n"
."\n"
.'- 长度不超过30个字符，不少于4个字符（一个中文汉字算一个字符）。', 'type' => 'string', 'required' => true, 'example' => 'vmee'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '自定义网关描述信息，长度不超过100个字符（一个中文汉字算一个字符）。', 'type' => 'string', 'required' => false, 'example' => 'my gateway'],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'query',
'schema' => ['description' => '网关频段ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'],
],
[
'name' => 'CommunicationMode',
'in' => 'query',
'schema' => [
'description' => '网关通信模式。取值：'."\n"
."\n"
.'- FULL_DUPLEX：全双工。'."\n"
."\n"
.'- HALF_DUPLEX：半双工。',
'type' => 'string',
'required' => true,
'example' => 'HALF_DUPLEX',
'enum' => ['HALF_DUPLEX', 'FULL_DUPLEX'],
],
],
[
'name' => 'City',
'in' => 'query',
'schema' => ['description' => '网关所在城市名称。', 'type' => 'string', 'required' => true, 'example' => '杭州'],
],
[
'name' => 'District',
'in' => 'query',
'schema' => ['description' => '网关所在城区名称。', 'type' => 'string', 'required' => true, 'example' => '滨江区'],
],
[
'name' => 'Address',
'in' => 'query',
'schema' => ['description' => '网关所在详细地址。', 'type' => 'string', 'required' => true, 'example' => '详细地址'],
],
[
'name' => 'GisCoordinateSystem',
'in' => 'query',
'schema' => [
'description' => '网关经纬度所采用的坐标系统，可取值为**WGS_84**, **GCJ_02**。',
'type' => 'string',
'required' => true,
'example' => 'GCJ_02',
'enum' => ['WGS_84', 'GCJ_02'],
],
],
[
'name' => 'Longitude',
'in' => 'query',
'schema' => ['description' => '网关经度。', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '123.45678'],
],
[
'name' => 'Latitude',
'in' => 'query',
'schema' => ['description' => '网关纬度。', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '23.45678'],
],
[
'name' => 'AddressCode',
'in' => 'query',
'schema' => ['description' => '网关所在地区ID，由`http://lbs.amap.com/api/javascript-api/download`定义。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**：调用成功。'."\n"
.'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'GwEuiDuplicated', 'errorMessage' => 'A gateway with the same gwEui already exists.', 'description' => 'GwEUI 已存在'],
['errorCode' => 'GatewayTupleAlreadyAbandoned', 'errorMessage' => 'The specified gateway tuple has been abandoned.', 'description' => '网关元组已经废弃'],
['errorCode' => 'IotHubTripleMissing', 'errorMessage' => 'The IoT Platform trituple of this gateway does not exist.', 'description' => '找不到网关的物联网平台设备证书（ProductKey、DeviceName、DeviceSecret）'],
['errorCode' => 'InvalidPinCode', 'errorMessage' => 'An error occurred while verifying PinCode.', 'description' => 'PinCode校验失败'],
['errorCode' => 'GatewayAlreadyBoundToOthers', 'errorMessage' => 'This gateway has already been bound to another account.', 'description' => '网关已经绑定到其它账号'],
['errorCode' => 'ExceedGatewayLimit', 'errorMessage' => 'The maximum number of gateways is exceeded.', 'description' => '超出网关可使用额度'],
['errorCode' => 'InvalidFreqBandPlan', 'errorMessage' => 'The frequency band plan is invalid.', 'description' => '频段计划不可用'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.', 'description' => '名称不合法'],
['errorCode' => 'GatewayInstanceInvalid', 'errorMessage' => 'The instance ID is invalid.', 'description' => '无效的实例id。'],
['errorCode' => 'GatewayDistributeFail', 'errorMessage' => 'Failed to distribute the gateway tuple.', 'description' => '网关密钥分发失败。'],
],
],
'title' => '录入网关',
'summary' => '调用CreateGateway录入网关。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGateway'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'CreateLocalJoinPermission' => [
'summary' => '当前用户账号将成为该凭证的拥有者，拥有该凭证。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'query',
'schema' => ['description' => '专用入网凭证所采用的频段的频段ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '101'],
],
[
'name' => 'ClassMode',
'in' => 'query',
'schema' => [
'description' => '专用入网凭证采用的LoRaWAN Class模式。可取值：A、B、C。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'A',
'enum' => ['A', 'B', 'C'],
],
],
[
'name' => 'UseDefaultJoinEui',
'in' => 'query',
'schema' => ['description' => '专用入网凭证是否使用阿里云统一JoinEUI。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
[
'name' => 'JoinPermissionName',
'in' => 'query',
'schema' => ['description' => '自定义专用入网凭证名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'],
],
[
'name' => 'RxDelay',
'in' => 'query',
'schema' => ['description' => 'classA的接收窗口延时。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'DataRate',
'in' => 'query',
'schema' => ['description' => '工作速率。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4'],
],
[
'name' => 'JoinEui',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'ExceedLocalJoinPermissionLimit', 'errorMessage' => 'The maximum number of local join permissions that you can create is exceeded.', 'description' => '超出本地凭证已购买额度'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'JoinPermissionNameDuplicated', 'errorMessage' => 'The specified join permission name already exists.', 'description' => '入网凭证名称重复'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.', 'description' => '名称不合法'],
['errorCode' => 'InvalidFreqBandPlan', 'errorMessage' => 'The frequency band plan is invalid.', 'description' => '频段计划不可用'],
],
],
'title' => '创建专用入网凭证',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLocalJoinPermission'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"123\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 123\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'CreateNodeGroup' => [
'summary' => '调用CreateNodeGroup创建节点分组。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'NodeGroupName',
'in' => 'query',
'schema' => ['description' => '节点分组的名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'group1'],
],
[
'name' => 'JoinPermissionId',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NodeGroupNameDuplicated', 'errorMessage' => 'The specified node group name already exists.', 'description' => '节点组名称重复'],
['errorCode' => 'NodeGroupAlreadyBoundJoinPermission', 'errorMessage' => 'This node group is already bound to a join permission.', 'description' => '节点组已经绑定入网凭证'."\n"],
['errorCode' => 'JoinPermissionDoesNotExist', 'errorMessage' => 'The specified join permission does not exist.', 'description' => '入网凭证不存在'],
['errorCode' => 'JoinPermissionAlreadyBoundNodeGroup', 'errorMessage' => 'The specified join permission has already been bound to another node group.', 'description' => '入网凭证已经绑定了节点组'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.', 'description' => '名称不合法'],
],
],
'title' => '创建节点分组',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateNodeGroup'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"123456\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 123456\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'DeleteGateway' => [
'summary' => '调用DeleteGateway删除已录入的网关。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
.'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n"
."\n"
.'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', 'type' => 'string', 'required' => false, 'example' => 'iot-060a09b1'],
],
[
'name' => 'GwEui',
'in' => 'query',
'schema' => ['description' => '网关唯一标识。', 'type' => 'string', 'required' => 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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'GatewayDistributeFail', 'errorMessage' => 'Failed to distribute the gateway tuple.', 'description' => '网关密钥分发失败。'],
],
],
'title' => 'DeleteGateway',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGateway'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'DeleteLocalJoinPermission' => [
'summary' => '调用DeleteLocalJoinPermission删除当前用户账号所拥有的专用入网凭证。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'JoinPermissionAlreadyAuthorized', 'errorMessage' => 'The specified join permission has already been granted to another renter.', 'description' => '入网凭证已经授权给了其它用户'],
],
],
'title' => '删除当前用户账号所拥有的专用入网凭证',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLocalJoinPermission'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'DeleteNodeGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.', 'description' => '资源被其他云产品锁定'."\n"],
['errorCode' => 'NodeGroupAlreadyBoundJoinPermission', 'errorMessage' => 'This node group is already bound to a join permission.', 'description' => '节点组已经绑定入网凭证'."\n"],
],
],
'title' => '删除节点分组',
'summary' => '调用DeleteNodeGroup删除节点分组。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteNodeGroup'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'GetFreqBandPlanGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'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'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '获取频段信息',
'summary' => '调用GetFreqBandPlanGroup获取频段信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFreqBandPlanGroup'],
],
],
'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 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":""}]',
],
'GetGateway' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
.'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n"
."\n"
.'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', 'type' => 'string', 'required' => false, 'example' => 'iot-060a09b1'],
],
[
'name' => 'GwEui',
'in' => 'query',
'schema' => ['description' => '网关唯一标识。', 'type' => 'string', 'required' => 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' => [
'ChargeStatus' => ['description' => '网关欠费状态。'."\n"
."\n"
.'- NORMAL：网关未欠费，正常工作。'."\n"
.'- ARREARAGE：网关欠费。', 'type' => 'string', 'example' => 'NORMAL'],
'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' => '网关的在线、离线状态。'."\n"
."\n"
.'- **ONLINE**：在线。'."\n"
."\n"
.'- **OFFLINE**：离线。', 'type' => 'string', 'example' => 'ONLINE'],
'AuthTypes' => ['description' => '网关合约类型。'."\n"
."\n"
.'- **HYBRID**：hybrid网关。'."\n"
.'- **SINGLE_CHANNEL**：单通道网关。'."\n"
.'- **STANDARD**：标准合约网关。', 'type' => 'string', 'example' => 'STANDARD'],
'OnlineStateChangedMillis' => ['description' => '最近一次在线、离线状态的变更时间。'."\n"
."\n"
.'格式为UNIX时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'CommunicationMode' => ['description' => '网关通信模式。可取值为：'."\n"
."\n"
.'- FULL_DUPLEX：全双工。'."\n"
."\n"
.'- HALF_DUPLEX：半双工。', 'type' => 'string', 'example' => 'HALF_DUPLEX'],
'Description' => ['description' => '自定义网关描述。', 'type' => 'string', 'example' => '网关描述'],
'Enabled' => ['description' => '该网关是否处于启用状态。'."\n"
."\n"
.'- true：启用状态。'."\n"
."\n"
.'- false：停用状态。', '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'],
'EmbeddedNsId' => ['description' => 'Hybrid网关id。'."\n", 'type' => 'string', 'example' => '123'],
'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'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => 'GetGateway',
'summary' => '调用GetGateway获取网关信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGateway'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"ChargeStatus\\": \\"NORMAL\\",\\n \\"ClassBSupported\\": true,\\n \\"FreqBandPlanGroupId\\": 123,\\n \\"District\\": \\"某某区\\",\\n \\"GisCoordinateSystem\\": \\"GCJ_02\\",\\n \\"City\\": \\"某某市\\",\\n \\"TimeCorrectable\\": true,\\n \\"OnlineState\\": \\"ONLINE\\",\\n \\"AuthTypes\\": \\"STANDARD\\",\\n \\"OnlineStateChangedMillis\\": 1514736000000,\\n \\"CommunicationMode\\": \\"HALF_DUPLEX\\",\\n \\"Description\\": \\"网关描述\\",\\n \\"Enabled\\": true,\\n \\"ClassBWorking\\": true,\\n \\"Address\\": \\"详细地址\\",\\n \\"Longitude\\": 123.45678,\\n \\"EmbeddedNsId\\": \\"123\\",\\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 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":""}]',
],
'GetGatewayPacketStat' => [
'summary' => '调用GetGatewayPacketStat获取网关有效包无效包统计。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n"
."\n"
.'>'."\n"
.'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n"
.'- 若无**实例概览**页面或ID值，则无需传入。'."\n"
."\n"
.'>'."\n"
."\n"
.'实例的更多信息，请参见[实例概述](~~356505~~)。', 'type' => 'string', 'required' => false, 'example' => 'iot-***-v6***'],
],
[
'name' => 'GwEui',
'in' => 'query',
'schema' => ['description' => '要查询的网关的GwEUI。', 'type' => 'string', 'required' => true, 'example' => '0000000000000000'],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => ['description' => '查询开始时间，单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1514766000000'],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => ['description' => '查询结束时间，单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1514766000000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**：调用成功。'."\n"
.'- **false**：调用失败。', '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'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '获取网关有效包无效包统计',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGatewayPacketStat'],
],
],
'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 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":""}]',
],
'GetGatewayStatusStat' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
.'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n"
."\n"
.'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', 'type' => 'string', 'required' => false, 'example' => 'iot-060a09b1'],
],
[
'name' => 'GwEui',
'in' => 'query',
'schema' => ['description' => '网关的GwEUI。', 'type' => 'string', 'required' => 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'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => 'GetGatewayStatusStat',
'summary' => '调用GetGatewayStatusStat获取网关状态统计，如 CPU、内存占用等。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGatewayStatusStat'],
],
],
'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 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":""}]',
],
'GetGatewayTransferPacketsDownloadUrl' => [
'summary' => '该链接指向一个CSV文件，其中包括了网关上下行数据包的统计数据。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'GwEui',
'in' => 'query',
'schema' => ['description' => '要查询的网关的GwEUI。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'DevEui',
'in' => 'query',
'schema' => ['description' => '根据DevEUI过滤数据包。', 'type' => 'string', 'required' => false, 'example' => '0000000000000001'],
],
[
'name' => 'Category',
'in' => 'query',
'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' => 'query',
'schema' => ['description' => '查询开始时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => ['description' => '查询结束时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '排序字段。取值：**LOG_MILLIS**，表示按照时间排序。',
'type' => 'string',
'required' => false,
'example' => 'LOG_MILLIS',
'enum' => ['LOG_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '获取下载链接',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGatewayTransferPacketsDownloadUrl'],
],
],
'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 http://xxx.xxx.xxx/xxx.csv\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'GetGatewayTupleOrder' => [
'summary' => '获取网关安全密钥工单的信息，传入工单 ID, 返回此工单的处理状态等信息。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => ['description' => '工单 Id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。'."\n"
."\n", 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 '],
'Data' => [
'description' => '网关安全密钥工单信息。',
'type' => 'object',
'properties' => [
'AcceptedMillis' => ['description' => '工单审批通过的 UNIX 时间戳，以毫秒为单位。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1514822400000'],
'RequiredCount' => ['description' => '工单申请的网关安全密钥数量。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'CreatedMillis' => ['description' => '提交此工单的 UNIX 时间戳，以毫秒为单位。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'OrderState' => ['description' => '工单的状态。'."\n"
."\n"
.'参考工单状态取值'."\n", 'type' => 'string', 'example' => 'ACCEPTED'],
'OrderId' => ['description' => '工单 Id。'."\n", 'type' => 'string', 'example' => '1234'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '获取网关安全密钥工单信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => '# 类型说明'."\n"
."\n"
.'### 工单状态取值'."\n"
."\n"
.'| 名称 | 类型 | 说明 |'."\n"
.'| --- | --- | --- |'."\n"
.'| APPLYING | String | 申请中。 |'."\n"
.'| REJECTED | String | 已拒绝。 |'."\n"
.'| ACCEPTING | String | 颁发中。 |'."\n"
.'| ACCEPTING_FAILED | String | 颁发失败。 |'."\n"
.'| ACCEPTED | String | 颁发成功。 |'."\n"
.'| REVOKING | String | 撤回中。 |'."\n"
.'| REVOKING_FAILED | String | 撤回失败。 |'."\n"
.'| REVOKED | String | 撤回成功。 |'."\n",
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGatewayTupleOrder'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\t\\",\\n \\"Data\\": {\\n \\"AcceptedMillis\\": 1514822400000,\\n \\"RequiredCount\\": 10,\\n \\"CreatedMillis\\": 1514736000000,\\n \\"OrderState\\": \\"ACCEPTED\\",\\n \\"OrderId\\": \\"1234\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue\\n\\n 1234\\n ACCEPTED\\n 1\\n 1514736000000\\n 1514822400000\\n","errorExample":""}]',
],
'GetGatewayTuplesDownloadUrl' => [
'summary' => '网关安全元组工单审批通过后，可以获取一个下载链接，该链接指向一个 CSV 文件，其中存储了颁发给该用户的网关安全元组。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => ['description' => '工单 Id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '网关安全元组文件下载链接。', 'type' => 'string', 'example' => 'http://xxx.xxx/xxx.csv'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 '],
'Success' => ['description' => '是否成功。'."\n"
."\n", 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
['errorCode' => 'GatewayTupleOrderNotAccepted', 'errorMessage' => 'The order on gateway tuple downloading is not approved. You cannot download the gateway tuple.', 'description' => '网关元组工单没有审批通过，无法下载网关元组。'],
],
],
'title' => '获取网关安全元组下载链接',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGatewayTuplesDownloadUrl'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"http://xxx.xxx/xxx.csv\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\t\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue\\nhttp://xxx.xxx/xxx.csv","errorExample":""}]',
],
'GetJoinPermissionAuthOrder' => [
'summary' => '调用GetJoinPermissionAuthOrder获取专用凭证授权工单的详细信息。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'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'],
'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'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '获取专用凭证授权工单的详细信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJoinPermissionAuthOrder'],
],
],
'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 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":""}]',
],
'GetNode' => [
'summary' => '调用GetNode获取节点信息。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'query',
'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' => [
'DevAddr' => ['description' => '节点的网络地址。', 'type' => 'string', 'example' => '12345678'],
'LastJoinMillis' => ['description' => '最近一次入网的时间，UNIX时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'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'],
'AuthTypes' => [
'type' => 'string',
'items' => ['description' => '网关合约类型。'."\n"
."\n"
.'- HYBRID：hybrid网关'."\n"
.'- SINGLE_CHANNEL：单通道网关'."\n"
.'- STANDARD：标准合约网关', 'type' => 'string', 'example' => 'STANDARD', 'index' => 200],
'description' => '',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '获取节点信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNode'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"DevAddr\\": \\"12345678\\",\\n \\"LastJoinMillis\\": 1514736000000,\\n \\"DevEui\\": \\"0000000000000000\\",\\n \\"BoundMillis\\": 1514736000000,\\n \\"ClassMode\\": \\"A\\",\\n \\"AuthTypes\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\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":""}]',
],
'GetNodeGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
.'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n"
."\n"
.'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-0pp1n8t****'],
],
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => ['description' => '节点分组ID，可调用[ListNodeGroups](~~109944~~)接口查询获取。', 'type' => 'string', 'required' => true, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否调用成功。返回值：'."\n"
.'- **true**：调用成功。'."\n"
.'- ** false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '调用成功时返回的节点分组信息列表。',
'type' => 'object',
'properties' => [
'RxMonthSum' => ['description' => '与节点分组关联的入网凭证的当月上行数据包量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'NodeGroupName' => ['description' => '节点分组的名称。', 'type' => 'string', 'example' => '节点分组名称'],
'MulticastNodeCapacity' => ['description' => '节点分组所关联的组播组能够容纳的节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
'JoinPermissionOwnerAliyunId' => ['description' => '- 如果关联的是专用凭证，该字段表示入网凭证拥有者的阿里云账号。'."\n"
.'- 如果关联的是泛在凭证，该字段值为**AliCloud IoT**。', 'type' => 'string', 'example' => 'some-user'],
'MulticastEnabled' => ['description' => '节点分组所关联的组播组是否被启用。返回值：'."\n"
."\n"
.'- **true**：启用。'."\n"
.'- **false**：停用。', 'type' => 'boolean', 'example' => 'false'],
'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' => '与节点分组关联的入网凭证的启停状态。返回值：'."\n"
."\n"
.'- **true**：启用。'."\n"
.'- **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'],
'MulticastNodeCount' => ['description' => '节点分组所关联的组播组当前已经添加的节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'DataDispatchEnabled' => ['description' => '节点分组的数据流转启停状态。返回值：'."\n"
."\n"
.'- **true**：启用。'."\n"
.'- **false**：停用。', 'type' => 'boolean', 'example' => 'false'],
'MulticastGroupId' => ['description' => '节点分组所关联的组播组ID。', 'type' => 'string', 'example' => '1234'],
'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'],
],
'description' => '',
],
],
'DataDispatchConfig' => [
'description' => '节点分组的数据流转配置。',
'type' => 'object',
'properties' => [
'Destination' => ['description' => '数据流转目的地。返回值：'."\n"
."\n"
.'- **IOT**：数据流转到物联网平台的产品。'."\n"
.'- **ONS**：数据流转到MQ的Topic。', 'type' => 'string', 'example' => 'IOT'],
'IotProduct' => [
'description' => '如果流转目的地是物联网平台的产品，该字段存储产品信息。',
'type' => 'object',
'properties' => [
'DebugSwitch' => ['description' => '数据流转目的地为**IOT**的调试开关。返回值：'."\n"
."\n"
.'- **true**：打开调试开关。'."\n"
.'- **false**：关闭调试开关。', 'type' => 'boolean', 'example' => 'true'],
'ProductKey' => ['description' => '产品的ProductKey。', 'type' => 'string', 'example' => 'HMyB*******'],
'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'],
],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => 'GetNodeGroup',
'summary' => '调用GetNodeGroup获取节点分组信息。',
'description' => '# 限制说明'."\n"
."\n"
.'单阿里云账号调用该接口的每秒请求数（QPS）最大限制为5。'."\n"
."\n"
.'> RAM用户共享阿里云账号配额。',
'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~108601~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeGroup'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"RxMonthSum\\": 0,\\n \\"NodeGroupName\\": \\"节点分组名称\\",\\n \\"MulticastNodeCapacity\\": 1000,\\n \\"JoinPermissionOwnerAliyunId\\": \\"some-user\\",\\n \\"MulticastEnabled\\": false,\\n \\"TxMonthSum\\": 0,\\n \\"FreqBandPlanGroupId\\": 102,\\n \\"TxDailySum\\": 0,\\n \\"JoinPermissionEnabled\\": true,\\n \\"JoinPermissionId\\": \\"1234569\\",\\n \\"ClassMode\\": \\"A\\",\\n \\"NodeGroupId\\": \\"123456\\",\\n \\"MulticastNodeCount\\": 10,\\n \\"DataDispatchEnabled\\": false,\\n \\"MulticastGroupId\\": \\"1234\\",\\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 \\"DebugSwitch\\": true,\\n \\"ProductKey\\": \\"HMyB*******\\",\\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":"\\n89EF6CAA-958F-F32C-BE45-FE003C6DE097\\n\\n 10\\n 0\\n A\\n 1000\\n 节点分组名称\\n 0\\n 0\\n 0\\n 10\\n false\\n LOCAL\\n some-user\\n 123456\\n 1234\\n 1514736000000\\n 1234569\\n 凭证1\\n true\\n 102\\n 0\\n false\\n \\n 1514736000000\\n true\\n WRITE\\n 123\\n \\n \\n IOT\\n \\n true\\n 产品名\\n IOT_SUITE\\n HMyB*******\\n \\n \\n \\n\\ntrue\\n","errorExample":""}]',
],
'GetNodeGroupTransferPacketsDownloadUrl' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n"
."\n"
.'>'."\n"
.'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n"
.'- 若无**实例概览**页面或ID值，则无需传入。'."\n"
."\n"
.'>'."\n"
."\n"
.'实例的更多信息，请参见[实例概述](~~356505~~)。', 'type' => 'string', 'required' => false, 'example' => 'iot-***-v6***'],
],
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => ['description' => '节点分组ID。', 'type' => 'string', 'required' => true, 'example' => '123'],
],
[
'name' => 'DevEui',
'in' => 'query',
'schema' => ['description' => '根据DevEUI过滤数据包。', 'type' => 'string', 'required' => false, 'example' => '0000000000000001'],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => [
'description' => '数据包分类。取值：'."\n"
."\n"
.'- **DOWNLINK_PACKET**：下行包。'."\n"
.'- **UPLINK_PACKET**：上行包。',
'type' => 'string',
'required' => true,
'example' => 'DOWNLINK_PACKET',
'enum' => ['DOWNLINK_PACKET', 'UPLINK_PACKET', 'INVALID_PACKET'],
],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => ['description' => '查询开始时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => ['description' => '查询结束时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '排序字段。取值：**LOG_MILLIS**，表示按照时间排序。',
'type' => 'string',
'required' => false,
'example' => 'LOG_MILLIS',
'enum' => ['LOG_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => ['description' => '需配合**SortingField**参数一起使用。'."\n"
."\n"
.'- **true**：升序。'."\n"
."\n"
.'- **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' => '是否调用成功。'."\n"
.'- **true**：调用成功。'."\n"
.'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '获取下载链接',
'summary' => '该链接指向一个CSV文件，其中包括了节点分组上下行数据包的统计数据。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeGroupTransferPacketsDownloadUrl'],
],
],
'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 http://xxx.xxx.xxx/xxx.csv\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'GetNodeTransferPacket' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
.'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n"
."\n"
.'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-0pp1n8t****'],
],
[
'name' => 'DevEui',
'in' => 'query',
'schema' => ['description' => '数据包所涉及的DevEUI，为16位HEX。', 'type' => 'string', 'required' => true, 'example' => '0000000000000001'],
],
[
'name' => 'Base64EncodedMacPayload',
'in' => 'query',
'schema' => ['description' => 'Base64编码后的MACPayload报文，可调用[ListNodeGroupTransferPackets](~~109959~~)接口查询获取。', 'type' => 'string', 'required' => true, 'example' => 'SGVsbG8hIQ=='],
],
[
'name' => 'LogMillis',
'in' => 'query',
'schema' => ['description' => '数据包的发送时间，可调用[ListNodeGroupTransferPackets](~~109959~~)接口查询获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1514736000000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否调用成功。返回值：'."\n"
.'- **true**：调用成功。'."\n"
.'- ** false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '调用成功时返回的数据包信息列表。',
'type' => 'object',
'properties' => [
'GwOwnerAliyunId' => ['description' => '数据包所经过网关所属用户的阿里云账号。', 'type' => 'string', 'example' => 'XXX'],
'LogMillis' => ['description' => '数据包传输的UNIX时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', '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' => 'SGVsbG8hIQ=='],
'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' => '此数据包中是否包含业务数据。返回值：'."\n"
."\n"
.'- **true**：包含。'."\n"
.'- **false**：不包含。', 'type' => 'boolean', 'example' => 'true'],
'ClassMode' => ['description' => '收发此数据包时的LoRaWAN Class模式。', 'type' => 'string', 'example' => 'C'],
'MacPayloadSize' => ['description' => '此数据包的MACPayload报文长度。', 'type' => 'integer', 'format' => 'int32', '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'],
'GwEui' => ['description' => '收发此数据包所经过的网关的GwEUI。', 'type' => 'string', 'example' => '0000000000000000'],
'Rssi' => ['description' => '收发此数据包的RSSI。', 'type' => 'integer', 'format' => 'int32', 'example' => '-110'],
'HasMacCommand' => ['description' => '此数据包中是否包含MAC指令。返回值：'."\n"
."\n"
.'- **true**：包含。'."\n"
.'- **false**：不包含。', 'type' => 'boolean', 'example' => 'true'],
'Freq' => ['description' => '收发此数据包的频点。', 'type' => 'number', 'format' => 'float', 'example' => '470.3'],
'MacCommandCIDs' => [
'type' => 'array',
'items' => ['description' => '这个数据包所携带的MAC指令列表。', 'type' => 'object', 'example' => '["0x01","0x02"]'],
'description' => '',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
],
],
'title' => '获取某条节点上下行数据包',
'summary' => '调用GetNodeTransferPacket获取某条节点上下行数据包。',
'description' => '# 限制说明'."\n"
."\n"
.'单阿里云账号调用该接口的每秒请求数（QPS）最大限制为5。'."\n"
."\n"
.'> RAM用户共享阿里云账号配额。',
'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~108601~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeTransferPacket'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"GwOwnerAliyunId\\": \\"XXX\\",\\n \\"LogMillis\\": 1514736000000,\\n \\"ProcessEvent\\": \\"SUCCESS\\",\\n \\"Base64EncodedMacPayload\\": \\"SGVsbG8hIQ==\\",\\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 [\\n \\"0x01\\",\\n \\"0x02\\"\\n ]\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\n \\n XXX\\n 1514736000000\\n SUCCESS\\n SGVsbG8hIQ==\\n 99\\n -10.5\\n 101\\n true\\n C\\n 15\\n JOIN_REQUEST\\n SF12BW125\\n 00000000\\n 0000000000000001\\n 0000000000000000\\n -110\\n true\\n 470.3\\n \\n \\n","errorExample":""}]',
],
'GetNodeTransferPacketsDownloadUrl' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'query',
'schema' => ['description' => '根据 GwEUI 过滤数据包。'."\n", 'type' => 'string', 'required' => false, 'example' => '0000000000000001'],
],
[
'name' => 'DevEui',
'in' => 'query',
'schema' => ['description' => '根据 DevEUI 过滤数据包。'."\n", 'type' => 'string', 'required' => true, 'example' => '0000000000000001'],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => [
'description' => '数据包分类，可选：DOWNLINK_PACKET（下行包）、UPLINK_PACKET（上行包）、INVALID_PACKET（无效包）。'."\n",
'type' => 'string',
'required' => true,
'example' => 'DOWNLINK_PACKET',
'enum' => ['DOWNLINK_PACKET', 'UPLINK_PACKET', 'INVALID_PACKET'],
],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => ['description' => '查询开始时间，毫秒为单位的 UNIX 时间戳。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => ['description' => '查询结束时间，毫秒为单位的 UNIX 时间戳。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '排序字段，可选 LOG_MILLIS（按照时间排序）。'."\n",
'type' => 'string',
'required' => false,
'example' => 'LOG_MILLIS',
'enum' => ['LOG_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => ['description' => '配合 SortingField 参数一起使用，true 表示升序，false 表示降序。'."\n"
."\n"
.'默认降序。', '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。'."\n"
."\n", 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 '],
'Success' => ['description' => '是否成功。'."\n"
."\n", 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '获取下载链接',
'summary' => '该链接指向一个 CSV 文件，其中包括了节点上下行数据包的统计数据。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeTransferPacketsDownloadUrl'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"http://xxx.xxx.xxx/xxx.csv\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\t\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue\\nhttp://xxx.xxx.xxx/xxx.csv","errorExample":""}]',
],
'GetNodeTupleOrder' => [
'summary' => '获取节点安全元组工单信息，传入工单 ID, 返回此工单的处理状态等信息。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => ['description' => '工单 Id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。'."\n"
."\n", 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 '],
'Data' => [
'description' => '节点安全元组工单信息。',
'type' => 'object',
'properties' => [
'RequiredCount' => ['description' => '工单申请的节点安全密钥数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'CreatedMillis' => ['description' => '提交工单的 UNIX 时间戳，以毫秒为单位。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'IsKpm' => ['description' => '是否是安全产线发起的密钥申请。', 'type' => 'boolean', 'example' => 'false'],
'AcceptedMillis' => ['description' => '工单审批通过的 UNIX 时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514822400000'],
'OrderId' => ['description' => '工单 Id。', 'type' => 'string', 'example' => '1234'],
'OrderState' => ['description' => '工单状态。'."\n"
."\n"
.'审批状态取值'."\n"
."\n"
.'APPLYING 申请中。'."\n"
.'ACCEPTING 颁发中。'."\n"
.'ACCEPTED 颁发成功。'."\n"
.'ACCEPTING_FAILED 颁发失败。'."\n"
.'REJECTED 已拒绝。'."\n"
.'REVOKING 撤回中。'."\n"
.'REVOKING_FAILED 撤回失败。'."\n"
.'REVOKED 撤回成功。', 'type' => 'string', 'example' => 'ACCEPTED'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '获取节点安全元组工单信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => '# 类型说明'."\n"
."\n"
.'### 审批状态取值'."\n"
."\n"
.'| 名称 | 类型 | 说明 |'."\n"
.'| --- | --- | --- |'."\n"
.'| APPLYING | String | 申请中。 |'."\n"
.'| ACCEPTING | String | 颁发中。 |'."\n"
.'| ACCEPTED | String | 颁发成功。 |'."\n"
.'| ACCEPTING_FAILED | String | 颁发失败。 |'."\n"
.'| REJECTED | String | 已拒绝。 |'."\n"
.'| REVOKING | String | 撤回中。 |'."\n"
.'| REVOKING_FAILED | String | 撤回失败。 |'."\n"
.'| REVOKED | String | 撤回成功。 |',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeTupleOrder'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\t\\",\\n \\"Data\\": {\\n \\"RequiredCount\\": 10,\\n \\"CreatedMillis\\": 1514736000000,\\n \\"IsKpm\\": false,\\n \\"AcceptedMillis\\": 1514822400000,\\n \\"OrderId\\": \\"1234\\",\\n \\"OrderState\\": \\"ACCEPTED\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue\\n\\n 1234\\n false\\n ACCEPTED\\n 1\\n 1514736000000\\n 1514822400000\\n","errorExample":""}]',
],
'GetNodeTuplesDownloadUrl' => [
'summary' => '节点安全元组工单审批通过后，可以获取一个下载链接，该链接指向一个 CSV 文件，其中存储了颁发给该用户的节点安全元组。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => ['description' => '工单 Id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '节点安全密钥文件下载链接。', 'type' => 'string', 'example' => 'http://xxx.xxx/xxx.csv'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 '],
'Success' => ['description' => '是否成功。'."\n"
."\n", 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '获取节点安全元组下载链接',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeTuplesDownloadUrl'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"http://xxx.xxx/xxx.csv\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\t\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue\\nhttp://xxx.xxx/xxx.csv","errorExample":""}]',
],
'GetNotification' => [
'summary' => '调用GetNotification获取通知信息。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'NotificationId',
'in' => 'query',
'schema' => ['description' => '通知ID。', 'type' => 'string', 'required' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**：调用成功。'."\n"
.'- **false**：调用失败。', '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' => '此通知的处理状态。可取值为：'."\n"
."\n"
.'- **HANDLED**：已处理。'."\n"
."\n"
.'- **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' => '123'],
'OrderId' => ['description' => '工单ID。', 'type' => 'string', 'example' => '123'],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '获取通知信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNotification'],
],
],
'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\\": \\"123\\",\\n \\"OrderId\\": \\"123\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\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":""}]',
],
'GetOwnedJoinPermission' => [
'summary' => '根据入网凭证ID获取当前用户账号所拥有的入网凭证。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'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'],
'Data' => [
'description' => '所拥有入网凭证的信息列表。',
'type' => 'object',
'properties' => [
'RxMonthSum' => ['description' => '入网凭证的当月上行数据包量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MulticastNodeCapacity' => ['description' => '入网凭证可接入组播节点容量。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
'MulticastEnabled' => ['description' => '入网凭证组播的启停用状态。', 'type' => 'boolean', 'example' => 'false'],
'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'],
'BoundProductName' => ['type' => 'string'],
'DataRate' => ['description' => '工作速率。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
'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'],
'MulticastNodeCount' => ['description' => '入网凭证已接入组播节点数量。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'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'],
'RxDelay' => ['description' => 'classA的接收窗口延时。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'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'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '获取入网凭证',
'description' => '> 通过该接口获取的一定是当前用户账号所拥有的某个专用入网凭证。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOwnedJoinPermission'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"RxMonthSum\\": 0,\\n \\"MulticastNodeCapacity\\": 1000,\\n \\"MulticastEnabled\\": false,\\n \\"TxMonthSum\\": 0,\\n \\"FreqBandPlanGroupId\\": 102,\\n \\"TxDailySum\\": 0,\\n \\"BoundProductName\\": \\"\\",\\n \\"DataRate\\": 4,\\n \\"JoinPermissionId\\": \\"123\\",\\n \\"ClassMode\\": \\"A\\",\\n \\"DataDispatchDestination\\": \\"IOT\\",\\n \\"MulticastNodeCount\\": 10,\\n \\"RxDailySum\\": 0,\\n \\"JoinEui\\": \\"0000000000000000\\",\\n \\"CreateMillis\\": 1514736000000,\\n \\"Enabled\\": true,\\n \\"RxDelay\\": 1,\\n \\"RenterAliyunId\\": \\"some-user\\",\\n \\"NodesCnt\\": 10,\\n \\"JoinPermissionName\\": \\"凭证1\\",\\n \\"AuthState\\": \\"NEW\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\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":""}]',
],
'GetRentedJoinPermission' => [
'summary' => '根据入网凭证ID，获取当前用户账号租用的入网凭证（可能是专用入网凭证或泛在入网凭证）。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'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'],
'Data' => [
'description' => '租用的入网凭证信息列表。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '入网凭证的类型。取值：'."\n"
."\n"
.'- **LOCAL**：专用凭证。'."\n"
.'- **ROAMING**：泛在凭证。', 'type' => 'string', 'example' => 'LOCAL'],
'RxMonthSum' => ['description' => '入网凭证的当月上行数据包量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'BoundNodeGroupName' => ['description' => '凭证绑定的节点组名称。', 'type' => 'string', 'example' => '123'],
'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'],
'DataRate' => ['description' => '工作速率。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'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'],
'CreateMillis' => ['description' => '入网凭证的创建时间，格式为 UNIX 时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'Enabled' => ['description' => '入网凭证的启停用状态。**true**表示启用，**false**表示停用。', 'type' => 'boolean', 'example' => 'true'],
'RxDelay' => ['description' => 'classA的接收窗口延时。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'BoundNodeGroupId' => ['description' => '凭证绑定的节点组id。', 'type' => 'string', 'example' => '123'],
'NodesCnt' => ['description' => '使用该入网凭证的节点数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'JoinPermissionName' => ['description' => '入网凭证的名称。', 'type' => 'string', 'example' => '凭证1'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '获取租用的入网凭证',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRentedJoinPermission'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"Type\\": \\"LOCAL\\",\\n \\"RxMonthSum\\": 0,\\n \\"BoundNodeGroupName\\": \\"123\\",\\n \\"TxMonthSum\\": 0,\\n \\"FreqBandPlanGroupId\\": 102,\\n \\"TxDailySum\\": 0,\\n \\"DataRate\\": 2,\\n \\"JoinPermissionId\\": \\"123\\",\\n \\"ClassMode\\": \\"A\\",\\n \\"RxDailySum\\": 0,\\n \\"JoinEui\\": \\"0000000000000000\\",\\n \\"CreateMillis\\": 1514736000000,\\n \\"Enabled\\": true,\\n \\"RxDelay\\": 1,\\n \\"BoundNodeGroupId\\": \\"123\\",\\n \\"NodesCnt\\": 10,\\n \\"JoinPermissionName\\": \\"凭证1\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\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":""}]',
],
'GetUserLicense' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'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' => 'object',
'properties' => [
'RoamingJoinPermissionCount' => ['description' => '泛在入网凭证服务的用量。'."\n"
."\n"
.'针对开发者类的用户，表示当前用户账号已经申请的泛在入网凭证的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayTupleCount' => ['description' => '网关安全元组的服务用量。'."\n"
."\n"
.'表示当前用户账号已经申请了的网关安全元组的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayTupleSingleChannelCount' => ['description' => '单通道网关已用数量。'."\n"
."\n"
.'表示当前用户账号接入服务的单通道网关数量。'."\n"
."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayFreeLimit' => ['description' => '网关接入服务的免费容量。'."\n"
."\n"
.'表示当前用户账号可以免费接入的网关数量上限，其值必然小于等于 GatewayLimit。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NodeTupleFreeLimit' => ['description' => '节点安全元组的免费服务容量。'."\n"
."\n"
.'表示当前用户账号可以申请的免费节点安全元组的数量，其值必然小于等于NodeTupleLimit。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NodeFreeLimit' => ['description' => '节点接入服务的免费容量。'."\n"
."\n"
.'表示当前用户账号可以免费接入的节点数量上限，其值必然小于等于NodeLimit。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayTupleHybridLimit' => ['description' => 'hybird网关密钥容量。'."\n"
."\n"
.'表示当前用户账号可以使用的hybird网关密钥数量上限。'."\n"
."\n\n"
."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayTupleStandardCount' => ['description' => '网关合约密钥-标准规格已用数量。'."\n"
."\n"
.'表示当前用户账号已用的网关合约密钥-标准规格数量。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayTupleFreeLimit' => ['description' => '网关安全元组的免费服务容量。'."\n"
."\n"
.'表示当前用户账号可以申请的免费网关安全元组的数量，其值必然小于等于GatewayTupleLimit。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayCount' => ['description' => '网关接入服务的用量。'."\n"
."\n"
.'表示当前用户账号已经接入的网关数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NodeTupleRelayLimit' => ['description' => '中继密钥配额。'."\n"
."\n"
.'表示当前用户账号中继密钥配额。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayLimit' => ['description' => '网关接入服务的容量。'."\n"
."\n"
.'表示当前用户账号可以接入的网关数量上限。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayTupleLimit' => ['description' => '网关安全元组的服务容量。'."\n"
."\n"
.'表示当前用户账号最多可以申请的网关安全元组的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'LocalJoinPermissionFreeLimit' => ['description' => '专用入网凭证服务的免费容量。'."\n"
."\n"
.'针对网络运营者类的用户，表示当前用户账号可以免费创建的专用入网凭证的数量上限，其值必然小于等于LocalJoinPermissionLimit。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NodeLimit' => ['description' => '节点接入服务的容量。'."\n"
."\n"
.'表示当前用户账号可以接入的节点数量上限。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'RoamingJoinPermissionLimit' => ['description' => '泛在入网凭证服务的容量。'."\n"
."\n"
.'针对开发者（解决方案供应商）类的用户，表示当前用户账号可以申请的泛在入网凭证的数量上限。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayTupleSingleChannelLimit' => ['description' => '网关单通道密钥配额。'."\n"
."\n"
.'表示当前用户账号网关单通道密钥配额。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'LocalJoinPermissionLimit' => ['description' => '专用入网凭证服务的容量。'."\n"
."\n"
.'针对网络运营者类的用户，表示当前用户账号可以创建的专用入网凭证的数量上限。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Oui' => ['description' => 'LoRaWAN模组、设备制造商类的用户的组织码。改组织码会体现在用户申请到的DevEUI中。', 'type' => 'string', 'example' => '0000'],
'RelayLimit' => ['description' => '中继节点配额。'."\n"
."\n"
.'表示当前用户账号中继节点配额。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayTupleHybridCount' => ['description' => 'hybird网关密钥已用数量。'."\n"
."\n"
.'表示当前用户账号已经使用的hybird网关密钥数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'LocalJoinPermissionCount' => ['description' => '专用入网凭证服务的用量。'."\n"
."\n"
.'针对网络运营者类的用户，表示当前用户账号已经创建的专用入网凭证的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NodeTupleStandardCount' => ['description' => '节点合约密钥-标准规格已用数量。'."\n"
."\n"
.'表示当前用户账号已用节点合约密钥-标准规格数量。'."\n"
."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NodeTupleCount' => ['description' => '节点安全元组的服务用量。'."\n"
."\n"
.'表示当前用户账号已经申请了的节点安全元组的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayDingTalkLimit' => ['description' => '钉钉网关接入服务的容量。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayProfessionalLimit' => ['description' => '专业网关接入服务的容量。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayProfessionalCount' => ['description' => '专业网关接入服务的容量。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'RelayCount' => ['description' => '中继节点已用数量。'."\n"
."\n"
.'表示当前用户已用中级节点数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NodeTupleStandardLimit' => ['description' => '节点合约密钥-标准规格限额。'."\n"
."\n"
.'表示当前用户账号可以接入节点合约密钥-标准规格容量。'."\n"
."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'RoamingJoinPermissionFreeLimit' => ['description' => '泛在入网凭证服务的免费容量。'."\n"
."\n"
.'针对开发者类的用户，表示当前用户账号可以免费申请的泛在入网凭证的数量上限，其值必然小于等于RoamingJoinPermissionLimit。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NodeTupleLimit' => ['description' => '节点（LoRaWAN模组）安全元组的服务容量。'."\n"
."\n"
.'表示当前用户账号最多可以申请的节点安全元组的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NodeCount' => ['description' => '节点接入服务的用量。'."\n"
."\n"
.'表示当前用户账号已经接入的节点数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayDingTalkCount' => ['description' => '钉钉网关接入服务的用量。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayTupleStandardLimit' => ['description' => '网关合约密钥-标准规格限额。'."\n"
."\n"
.'表示当前用户账号可以接入网关合约密钥-标准规格容量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'GatewayPrePayCount' => ['description' => '网关接入服务的预付费数量。'."\n"
."\n"
.'表示当前用户账号已经接入的预付费网关数量。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NodeTupleRelayCount' => ['description' => '中继密钥已用数量。'."\n"
."\n"
.'表示当前用户账号接入的中继密钥数量。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '查询合约信息及合约执行情况',
'summary' => '查询当前用户账号在物联网络管理平台的合约信息及合约执行情况。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserLicense'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"RoamingJoinPermissionCount\\": 100,\\n \\"GatewayTupleCount\\": 100,\\n \\"GatewayTupleSingleChannelCount\\": 100,\\n \\"GatewayFreeLimit\\": 100,\\n \\"NodeTupleFreeLimit\\": 100,\\n \\"NodeFreeLimit\\": 100,\\n \\"GatewayTupleHybridLimit\\": 100,\\n \\"GatewayTupleStandardCount\\": 100,\\n \\"GatewayTupleFreeLimit\\": 100,\\n \\"GatewayCount\\": 100,\\n \\"NodeTupleRelayLimit\\": 100,\\n \\"GatewayLimit\\": 100,\\n \\"GatewayTupleLimit\\": 100,\\n \\"LocalJoinPermissionFreeLimit\\": 100,\\n \\"NodeLimit\\": 100,\\n \\"RoamingJoinPermissionLimit\\": 100,\\n \\"GatewayTupleSingleChannelLimit\\": 100,\\n \\"LocalJoinPermissionLimit\\": 100,\\n \\"Oui\\": \\"0000\\",\\n \\"RelayLimit\\": 100,\\n \\"GatewayTupleHybridCount\\": 100,\\n \\"LocalJoinPermissionCount\\": 100,\\n \\"NodeTupleStandardCount\\": 100,\\n \\"NodeTupleCount\\": 100,\\n \\"GatewayDingTalkLimit\\": 100,\\n \\"GatewayProfessionalLimit\\": 100,\\n \\"GatewayProfessionalCount\\": 100,\\n \\"RelayCount\\": 100,\\n \\"NodeTupleStandardLimit\\": 100,\\n \\"RoamingJoinPermissionFreeLimit\\": 100,\\n \\"NodeTupleLimit\\": 100,\\n \\"NodeCount\\": 100,\\n \\"GatewayDingTalkCount\\": 100,\\n \\"GatewayTupleStandardLimit\\": 100,\\n \\"GatewayPrePayCount\\": 100,\\n \\"NodeTupleRelayCount\\": 100\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n \\r\\n 100\\r\\n 0000\\r\\n 100\\r\\n 100\\r\\n 100\\r\\n 100\\r\\n 100\\r\\n 100\\r\\n 100\\r\\n 100\\r\\n 100\\r\\n 100\\r\\n 100\\r\\n 100\\r\\n 100\\r\\n 100\\r\\n 100\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'ListActivatedFeatures' => [
'summary' => '列举当前用户账号在物联网络管理平台所能使用的功能。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'Environment',
'in' => 'query',
'schema' => ['description' => '当前的调用环境，默认为空，表示公共实例，如果是物联网平台实例化环境，请传入“IotInstance”', 'type' => 'string', 'required' => false, 'example' => 'IotInstance'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。'."\n"
."\n", 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 '],
'Data' => [
'type' => 'array',
'items' => ['description' => '当前用户账号在物联网络管理平台所能使用的功能的列表。'."\n"
."\n"
.' GATEWAY_TUPLE：网关密钥管理功能'."\n"
."\n"
.' NODE_TUPLE：节点密钥管理功能'."\n"
."\n"
.' NODE：节点管理功能'."\n"
."\n"
.' GATEWAY：网关管理功能'."\n"
."\n"
.' LOCAL_JOIN_PERMISSION：本地凭证管理功能'."\n"
."\n"
.' ROAMING_JOIN_PERMISSION：漫游凭证管理功能'."\n"
."\n"
.' JOIN_PERMISSION_AUTHORIZATION：凭证权限授受能力'."\n"
."\n"
.' LAB_NODE：实验室节点功能'."\n"
."\n"
.' LAB_GATEWAY：实验室网关功能'."\n"
."\n"
.' NOTIFICATION：通知功能'."\n"
."\n"
.' UNICAST：单播指令下行功能'."\n"
."\n"
.' MULTICAST：组播指令下行功能'."\n"
."\n"
.' RELAY：中继管理功能'."\n"
."\n"
.' D2D：点对点通信能力'."\n", 'type' => 'string', 'example' => 'GATEWAY_TUPLE'],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '列举物联网络管理平台所能使用的功能',
'requestParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListActivatedFeatures'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\t\\",\\n \\"Data\\": [\\n \\"GATEWAY_TUPLE\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue\\nGATEWAY\\nJOIN_PERMISSION_AUTHORIZATION\\nLOCAL_JOIN_PERMISSION\\nROAMING_JOIN_PERMISSION\\nLAB_NODE\\nLAB_GATEWAY\\nGATEWAY_TUPLE\\nNODE_TUPLE\\nNOTIFICATION\\nKPM_PRODUCT_LINE\\nNODE\\nUNICAST\\nMULTICAST","errorExample":""}]',
],
'ListActiveGateways' => [
'summary' => '调用ListActiveGateways查询今日活跃网关。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'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' => [
'ChargeStatus' => ['description' => '网关欠费状态。'."\n"
."\n"
.'- NORMAL：网关未欠费，正常工作'."\n"
.'- ARREARAGE：网关欠费状态', 'type' => 'string', 'example' => 'NORMAL'],
'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' => 'vmeixme'],
'AddressCode' => ['description' => '网关地址码。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '查询今日活跃网关',
'description' => '****',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListActiveGateways'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": [\\n {\\n \\"ChargeStatus\\": \\"NORMAL\\",\\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\\": \\"vmeixme\\",\\n \\"AddressCode\\": 123\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\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":""}]',
],
'ListFreqBandPlanGroups' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'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'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '获取频段列表',
'summary' => '调用ListFreqBandPlanGroups获取频段列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFreqBandPlanGroups'],
],
],
'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 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":""}]',
],
'ListGatewayOnlineRecords' => [
'summary' => '调用ListGatewayOnlineRecords查询网关在线离线记录。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'query',
'schema' => ['description' => '网关的GwEUI。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'OffSet',
'in' => 'query',
'schema' => ['description' => '查询的起始位置，从0开始的偏移值。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => '查询的记录数量上限，大于等于1。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '5'],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '排序字段，可选值为：**STATE_CHANGED_MILLIS**，表示按照状态改变时间排序。',
'type' => 'string',
'required' => false,
'example' => 'STATE_CHANGED_MILLIS',
'enum' => ['STATE_CHANGED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '查询网关在线离线记录',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGatewayOnlineRecords'],
],
],
'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 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":""}]',
],
'ListGatewayTransferFlowStats' => [
'summary' => '调用ListGatewayTransferFlowStats查询网关流量统计列表。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'GwEui',
'in' => 'query',
'schema' => ['description' => '网关的GwEUI。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => ['description' => '查询开始时间，以毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => ['description' => '查询结束时间，以毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514737000000'],
],
[
'name' => 'TimeIntervalUnit',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '查询网关流量统计列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGatewayTransferFlowStats'],
],
],
'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 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":""}]',
],
'ListGatewayTransferPackets' => [
'summary' => '调用ListGatewayTransferPackets获取网关上下行数据包的统计信息。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['description' => '物联网平台的实例id，为空表示公共实例。', 'type' => 'string', 'required' => false, 'example' => 'iotx-oxssh****'],
],
[
'name' => 'GwEui',
'in' => 'query',
'schema' => ['description' => '要查询的网关的GwEUI。', 'type' => 'string', 'required' => true, 'example' => '0000000000000000'],
],
[
'name' => 'DevEui',
'in' => 'query',
'schema' => ['description' => '根据DevEUI过滤数据包。', 'type' => 'string', 'required' => false, 'example' => '0000000000000001'],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => [
'description' => '数据包分类。'."\n"
."\n"
.'- DOWNLINK_PACKET：下行包。'."\n"
."\n"
.'- UPLINK_PACKET：上行包。'."\n"
."\n"
.'- INVALID_PACKET：无效包。',
'type' => 'string',
'required' => true,
'example' => 'DOWNLINK_PACKET',
'enum' => ['DOWNLINK_PACKET', 'UPLINK_PACKET', 'INVALID_PACKET'],
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小，大于等于1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '2'],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => ['description' => '查询开始时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => ['description' => '查询结束时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '排序字段，取值：**LOG_MILLIS**，表示按照时间排序。',
'type' => 'string',
'required' => false,
'example' => 'LOG_MILLIS',
'enum' => ['LOG_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'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' => '该报文的处理结果。', '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' => '消息类型。', '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'],
'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'],
'MacCommandCIDs' => [
'type' => 'array',
'items' => ['description' => '这个数据包所携带的MAC指令列表。', 'type' => 'object', 'example' => '["0x01","0x02"]'],
'description' => '',
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '获取网关上下行数据包的统计信息',
'description' => '****',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGatewayTransferPackets'],
],
],
'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 [\\n \\"0x01\\",\\n \\"0x02\\"\\n ]\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\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":""}]',
],
'ListGatewayTupleOrders' => [
'summary' => '获取用户已提交的网关元组工单列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'State',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '工单状态过滤列表，若不使用此参数，则表示查询所有状态的工单。可取值为：'."\n"
."\n"
.'- APPLYING：申请中。'."\n"
."\n"
.'- REJECTED：已拒绝。'."\n"
."\n"
.'- ACCEPTING：分发中。'."\n"
."\n"
.'- ACCEPTED：分发成功。'."\n"
."\n"
.'- ACCEPTING_FAILED：分发失败。'."\n"
."\n"
.'- REVOKING：撤回中。'."\n"
."\n"
.'- REVOKED：撤回成功。'."\n"
."\n"
.'- REVOKING_FAILED：撤回失败。'."\n",
'type' => 'array',
'items' => ['description' => '工单状态过滤列表，若不使用此参数，则表示查询所有状态的工单。可取值为：'."\n"
."\n"
.'- APPLYING：申请中。'."\n"
."\n"
.'- REJECTED：已拒绝。'."\n"
."\n"
.'- ACCEPTING：分发中。'."\n"
."\n"
.'- ACCEPTED：分发成功。'."\n"
."\n"
.'- ACCEPTING_FAILED：分发失败。'."\n"
."\n"
.'- REVOKING：撤回中。'."\n"
."\n"
.'- REVOKED：撤回成功。'."\n"
."\n"
.'- REVOKING_FAILED：撤回失败。', 'type' => 'string', 'required' => false, 'example' => 'APPLYING'],
'required' => false,
'example' => 'APPLYING',
'maxItems' => 100,
],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => ['description' => '本次查询的起始位置，从0开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => '本次查询的工单数量上限，需大于等于1。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '查询结果排序字段。可取值为：'."\n"
."\n"
.'- **CREATED_MILLIS**：根据工单发起时间排序。'."\n"
."\n"
.'- **ACCEPTED_MILLIS**：根据工单审批通过时间排序。',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS', 'ACCEPTED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => ['description' => '需配合**SortingField**参数一起使用。'."\n"
."\n"
.'- **true**：表示升序。'."\n"
."\n"
.'- **false**：表示降序。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**：调用成功。'."\n"
.'- **false**：调用失败。', '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' => '42'],
'List' => [
'description' => '查询到的网关密钥工单信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RequiredCount' => ['description' => '网关密钥颁发数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'CreatedMillis' => ['description' => '提交此工单的UNIX时间戳，单位为毫秒。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'TupleType' => ['description' => '网关密钥类型。'."\n"
."\n"
.'- **singlechannel**：低速版（单通道型）。'."\n"
."\n"
.'- **standard**：标准版。'."\n"
."\n"
.'- **hybrid**：高速版（Hybrid型）。'."\n"
."\n"
.'- **noncontractual**：高速版。'."\n"
."\n", 'type' => 'string', 'example' => 'standard'],
'AcceptedMillis' => ['description' => '工单审批通过的UNIX时间戳，单位为毫秒。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1514822400000'],
'OrderId' => ['description' => '网关密钥订单编号。', 'type' => 'string', 'example' => '1234'],
'OrderState' => ['description' => '网关密钥申请状态。', 'type' => 'string', 'example' => 'ACCEPTED'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
],
],
'title' => '获取用户已提交的网关元组工单列表',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGatewayTupleOrders'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 42,\\n \\"List\\": [\\n {\\n \\"RequiredCount\\": 2,\\n \\"CreatedMillis\\": 1514736000000,\\n \\"TupleType\\": \\"standard\\",\\n \\"AcceptedMillis\\": 1514822400000,\\n \\"OrderId\\": \\"1234\\",\\n \\"OrderState\\": \\"ACCEPTED\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\n \\n 42\\n \\n 2\\n 1514736000000\\n standard\\n 1514822400000\\n 1234\\n ACCEPTED\\n
\\n \\n","errorExample":""}]',
],
'ListGateways' => [
'summary' => '根据过滤条件查询当前用户账号名下的网关信息列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n"
."\n"
.'>'."\n"
.'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n"
.'- 若无**实例概览**页面或ID值，则无需传入。'."\n"
."\n"
.'>'."\n"
."\n"
.'实例的更多信息，请参见[实例概述](~~356505~~)。', 'type' => 'string', 'required' => false, 'example' => 'iot-***-v6***'],
],
[
'name' => 'OnlineState',
'in' => 'query',
'schema' => [
'description' => '网关的在线、离线状态过滤。如未传入此参数，则不限制在线状态。可取值为：'."\n"
."\n"
.'- **ONLINE**：在线。'."\n"
."\n"
.'- **OFFLINE**：离线。',
'type' => 'string',
'required' => false,
'example' => 'OFFLINE',
'enum' => ['ONLINE', 'OFFLINE'],
],
],
[
'name' => 'FuzzyGwEui',
'in' => 'query',
'schema' => ['description' => 'GwEUI模糊过滤。', 'type' => 'string', 'required' => false, 'example' => '123456'],
],
[
'name' => 'FuzzyCity',
'in' => 'query',
'schema' => ['description' => '城市名模糊过滤。', 'type' => 'string', 'required' => false, 'example' => 'CityName'],
],
[
'name' => 'FuzzyName',
'in' => 'query',
'schema' => ['description' => '网关名称模糊过滤。', 'type' => 'string', 'required' => false, 'example' => 'GatewayName'],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'query',
'schema' => ['description' => '网关频段ID过滤。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
],
[
'name' => 'IsEnabled',
'in' => 'query',
'schema' => ['description' => '网关的启用、停用状态过滤。如未传入此参数，则不限制启停状态。可取值为：'."\n"
."\n"
.'- **true**：启用。'."\n"
."\n"
.'- **false**：停用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => ['description' => '本次查询的起始位置，从0开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => '本次查询的网关数量上限，最大支持200，须大于等于1。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '指定排序字段，可取值为**ONLINE_STATE_CHANGED_MILLIS**。',
'type' => 'string',
'required' => false,
'example' => 'ONLINE_STATE_CHANGED_MILLIS',
'enum' => ['ONLINE_STATE_CHANGED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => ['description' => '配合**SortingField**参数一起使用。'."\n"
."\n"
.'- **true**：升序。'."\n"
."\n"
.'- **false**：降序。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**：调用成功。'."\n"
.'- **false**：调用失败。', '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' => [
'ChargeStatus' => ['description' => '网关欠费状态。'."\n"
."\n"
.'- **NORMAL**：网关未欠费，正常工作。'."\n"
.'- **ARREARAGE**：网关欠费。', 'type' => 'string', 'example' => 'NORMAL'],
'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' => '网关的在线、离线状态。可取值为：'."\n"
."\n"
.'- **ONLINE**：在线。'."\n"
."\n"
.'- **OFFLINE**：离线。', 'type' => 'string', 'example' => 'ONLINE'],
'AuthTypes' => ['description' => '网关合约类型。'."\n"
."\n"
.'- **HYBRID**：hybrid网关。'."\n"
."\n"
.'- **SINGLE_CHANNEL**：单通道网关。'."\n"
."\n"
.'- **STANDARD**：标准合约网关。', 'type' => 'string', 'example' => 'STANDARD'],
'OnlineStateChangedMillis' => ['description' => '最近一次在线、离线状态的变更时间。'."\n"
."\n"
.'格式为UNIX时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'CommunicationMode' => ['description' => '网关通信模式。可取值为：'."\n"
."\n"
.'- **FULL_DUPLEX**：全双工。'."\n"
."\n"
.'- **HALF_DUPLEX**：半双工。', 'type' => 'string', 'example' => 'HALF_DUPLEX'],
'Description' => ['description' => '自定义网关描述。', 'type' => 'string', 'example' => '网关描述'],
'Enabled' => ['description' => '该网关是否处于启用状态。'."\n"
."\n"
.'- **true**：启用状态。'."\n"
."\n"
.'- **false**：停用状态。', 'type' => 'boolean', 'example' => 'true'],
'ClassBWorking' => ['description' => '该网关是否正工作在Class B模式下。'."\n"
."\n"
.'- **true**：是。'."\n"
."\n"
.'- **false**：否。', 'type' => 'boolean', 'example' => 'true'],
'Address' => ['description' => '网关所在详细地址。', 'type' => 'string', 'example' => '详细地址'],
'Longitude' => ['description' => '网关经度。', 'type' => 'number', 'format' => 'float', 'example' => '123.45678'],
'EmbeddedNsId' => ['description' => 'Hybrid网关id。', 'type' => 'string', 'example' => '123'],
'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'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '查询网关信息列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGateways'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 2,\\n \\"List\\": [\\n {\\n \\"ChargeStatus\\": \\"NORMAL\\",\\n \\"ClassBSupported\\": true,\\n \\"FreqBandPlanGroupId\\": 123,\\n \\"District\\": \\"某某区\\",\\n \\"GisCoordinateSystem\\": \\"GCJ_02\\",\\n \\"City\\": \\"某某市\\",\\n \\"TimeCorrectable\\": true,\\n \\"OnlineState\\": \\"ONLINE\\",\\n \\"AuthTypes\\": \\"STANDARD\\",\\n \\"OnlineStateChangedMillis\\": 1514736000000,\\n \\"CommunicationMode\\": \\"HALF_DUPLEX\\",\\n \\"Description\\": \\"网关描述\\",\\n \\"Enabled\\": true,\\n \\"ClassBWorking\\": true,\\n \\"Address\\": \\"详细地址\\",\\n \\"Longitude\\": 123.45678,\\n \\"EmbeddedNsId\\": \\"123\\",\\n \\"Latitude\\": 23.45678,\\n \\"Name\\": \\"网关名称\\",\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"AddressCode\\": 123\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\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":""}]',
],
'ListGatewaysGisInfo' => [
'summary' => '查询当前用户账号名下所有网关的地理位置信息。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n"
."\n"
.'>'."\n"
.'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n"
.'- 若无**实例概览**页面或ID值，则无需传入。'."\n"
."\n"
.'>'."\n"
."\n"
.'实例的更多信息，请参见[实例概述](~~356505~~)。', 'type' => 'string', 'required' => false, 'example' => 'iot-***-v6***'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**：调用成功。'."\n"
.'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID，阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '网关位置信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ChargeStatus' => ['description' => '网关欠费状态。'."\n"
."\n"
.'- **NORMAL**：网关未欠费，正常工作。'."\n"
.'- **ARREARAGE**：网关欠费。', 'type' => 'string', 'example' => 'NORMAL'],
'GisSourceType' => ['description' => '网关GIS来源，可取值：'."\n"
."\n"
.'- **USER_INPUT**：用户输入。'."\n"
."\n"
.'- **HARDWARE**：网关上报。', 'type' => 'string', 'example' => 'HARDWARE'],
'FreqBandPlanGroupId' => ['description' => '网关采用的频段ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '102'],
'Enabled' => ['description' => '网关是否可用。', 'type' => 'boolean', 'example' => 'true'],
'GisCoordinateSystem' => ['description' => '网关经纬度所采用的坐标系统，可取值为：**WGS_84**，**GCJ_02**。', 'type' => 'string', 'example' => 'GCJ_02'],
'Longitude' => ['description' => '网关经度。', 'type' => 'number', 'format' => 'float', 'example' => '123.45678'],
'Latitude' => ['description' => '网关纬度。', 'type' => 'number', 'format' => 'float', 'example' => '23.45678'],
'OnlineState' => ['description' => '网关的在线、离线状态。可取值：'."\n"
."\n"
.'- **ONLINE**：在线。'."\n"
."\n"
.'- **OFFLINE**：离线。', 'type' => 'string', 'example' => 'OFFLINE'],
'Name' => ['description' => '自定义网关名称。', 'type' => 'string', 'example' => '网关名称'],
'GwEui' => ['description' => '网关唯一标识。', 'type' => 'string', 'example' => '0000000000000000'],
'AuthTypes' => ['description' => '网关合约类型。'."\n"
."\n"
.'- **HYBRID**：Hybrid网关。'."\n"
.'- **SINGLE_CHANNEL**：单通道网关。'."\n"
.'- **STANDARD**：标准合约网关。', 'type' => 'string', 'example' => 'STANDARD'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
],
],
'title' => '查询所有网关地理位置信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGatewaysGisInfo'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": [\\n {\\n \\"ChargeStatus\\": \\"NORMAL\\",\\n \\"GisSourceType\\": \\"HARDWARE\\",\\n \\"FreqBandPlanGroupId\\": 102,\\n \\"Enabled\\": true,\\n \\"GisCoordinateSystem\\": \\"GCJ_02\\",\\n \\"Longitude\\": 123.45678,\\n \\"Latitude\\": 23.45678,\\n \\"OnlineState\\": \\"OFFLINE\\",\\n \\"Name\\": \\"网关名称\\",\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"AuthTypes\\": \\"STANDARD\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\n \\n NORMAL\\n HARDWARE\\n 102\\n true\\n GCJ_02\\n 123.45678\\n 23.45678\\n OFFLINE\\n 网关名称\\n 0000000000000000\\n STANDARD\\n \\n","errorExample":""}]',
],
'ListNodeGroupTransferFlowStats' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => ['description' => '节点组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => ['description' => '查询开始时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => ['description' => '查询结束时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514737000000'],
],
[
'name' => 'TimeIntervalUnit',
'in' => 'query',
'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' => '1010'],
'StatMillis' => ['description' => '统计UNIX时间戳, 以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'UplinkCount' => ['description' => '该时间段的上行数据包数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '查询节点组流量统计列表',
'summary' => '调用ListNodeGroupTransferFlowStats查询节点组流量统计列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeGroupTransferFlowStats'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": [\\n {\\n \\"DownlinkCount\\": 1010,\\n \\"StatMillis\\": 1514736000000,\\n \\"UplinkCount\\": 10\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\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":""}]',
],
'ListNodeGroupTransferPackets' => [
'summary' => '调用ListNodeGroupTransferPackets获取节点分组上下行数据包的统计信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => ['description' => '节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'DevEui',
'in' => 'query',
'schema' => ['description' => '根据DevEUI过滤数据包。', 'type' => 'string', 'required' => false, 'example' => '0000000000000001'],
],
[
'name' => 'Category',
'in' => 'query',
'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' => 'query',
'schema' => ['description' => '分页页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小，大于等于1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '300', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => ['description' => '查询开始时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => ['description' => '查询结束时间，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '排序字段，取值：**LOG_MILLIS**，表示按照时间排序。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'LOG_MILLIS',
'enum' => ['LOG_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'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' => '满足过滤条件的数据包总数。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'List' => [
'description' => '列表信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LogMillis' => ['description' => '数据包传输的 UNIX 时间戳，以毫秒为单位。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'GwOwnerAliyunId' => ['description' => '数据包所经过网关所属用户的阿里云账号 Id。'."\n", 'type' => 'string', 'example' => 'XXX'],
'ProcessEvent' => ['description' => '该报文的处理结果，取值内容参考 ProcessEvent 取值。'."\n", 'type' => 'string', 'example' => 'DEVADDR_ILLEGAL'],
'Base64EncodedMacPayload' => ['description' => 'Base64 编码后的 MACPayload 报文。'."\n", 'type' => 'string', 'example' => 'XXX'],
'FPort' => ['description' => '收发此数据包时所使用的 FPort。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '99'],
'Lsnr' => ['description' => '收发此数据包的信噪比。'."\n", 'type' => 'number', 'format' => 'float', 'example' => '-10.5'],
'FreqBandPlanGroupId' => ['description' => '数据包所经过的网关所采用的频段的频段 Id。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '101'],
'HasData' => ['description' => '此数据包中是否包含业务数据。'."\n", 'type' => 'boolean', 'example' => 'true'],
'FcntUp' => ['type' => 'integer', 'format' => 'int64'],
'ClassMode' => ['description' => '收发此数据包时的 LoRaWAN Class 模式。'."\n", 'type' => 'string', 'example' => 'C'],
'MacPayloadSize' => ['description' => '此数据包的 MACPayload 报文长度。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
'MessageType' => ['description' => '消息类型，取值如下表。'."\n", 'type' => 'string', 'example' => 'CONFIRMED_DATA_UP'],
'Datr' => ['description' => '收发此数据包的数据速率。'."\n", 'type' => 'string', 'example' => 'SF12BW125'],
'DevAddr' => ['description' => '收发此数据包的节点的网络地址。'."\n", 'type' => 'string', 'example' => '00000000'],
'DevEui' => ['description' => '收发此数据包的节点的 DevEUI。', 'type' => 'string', 'example' => '0000000000000001'],
'FcntDown' => ['type' => 'integer', 'format' => 'int64'],
'MacCommandCIDs' => [
'type' => 'string',
'items' => ['description' => '这个数据包所携带的 MAC 指令列表。'."\n", 'type' => 'string', 'example' => '"0x01"，"0x02"', 'index' => 200],
'description' => '',
],
'GwEui' => ['description' => '收发此数据包所经过的网关的 GwEUI。'."\n", 'type' => 'string', 'example' => '0000000000000000'],
'Rssi' => ['description' => '收发此数据包的 RSSI。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '-110'],
'HasMacCommand' => ['description' => '此数据包中是否包含 MAC 指令。'."\n", 'type' => 'boolean', 'example' => 'true'],
'Freq' => ['description' => '收发此数据包的频点。'."\n", 'type' => 'number', 'format' => 'float', 'example' => '470.3'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '获取节点分组上下行数据包的统计信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeGroupTransferPackets'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 20,\\n \\"List\\": [\\n {\\n \\"LogMillis\\": 1514736000000,\\n \\"GwOwnerAliyunId\\": \\"XXX\\",\\n \\"ProcessEvent\\": \\"DEVADDR_ILLEGAL\\",\\n \\"Base64EncodedMacPayload\\": \\"XXX\\",\\n \\"FPort\\": 99,\\n \\"Lsnr\\": -10.5,\\n \\"FreqBandPlanGroupId\\": 101,\\n \\"HasData\\": true,\\n \\"FcntUp\\": 0,\\n \\"ClassMode\\": \\"C\\",\\n \\"MacPayloadSize\\": 15,\\n \\"MessageType\\": \\"CONFIRMED_DATA_UP\\",\\n \\"Datr\\": \\"SF12BW125\\",\\n \\"DevAddr\\": \\"00000000\\",\\n \\"DevEui\\": \\"0000000000000001\\",\\n \\"FcntDown\\": 0,\\n \\"MacCommandCIDs\\": \\"\\",\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"Rssi\\": -110,\\n \\"HasMacCommand\\": true,\\n \\"Freq\\": 470.3\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\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":""}]',
],
'ListNodeGroups' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
.'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n"
."\n"
.'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-0pp1n8t****'],
],
[
'name' => 'FuzzyName',
'in' => 'query',
'schema' => ['description' => '模糊匹配节点分组名称。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'query',
'schema' => ['description' => '模糊匹配节点分组所使用的JoinEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'query',
'schema' => ['description' => '模糊匹配分组中的节点DevEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => ['description' => '本次查询的起始位置，从0开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => '本次查询的分组数量，取值范围0~200。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '指定排序字段，取值为**CREATED_MILLIS**，表示根据创建时间排序。',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => ['description' => '配合**SortingField**参数一起使用，指定字段排序方式。取值：'."\n"
."\n"
.'- **true**：升序。'."\n"
.'- **false**：降序。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否调用成功。返回值：'."\n"
.'- **true**：调用成功。'."\n"
.'- ** false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '调用成功时返回的当前阿里云账号下的节点分组列表。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '节点分组总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'List' => [
'description' => '节点分组列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RxMonthSum' => ['description' => '与节点分组关联的入网凭证的当月上行数据包量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'NodeGroupName' => ['description' => '节点分组的名称。', 'type' => 'string', 'example' => '节点分组名称2'],
'JoinPermissionOwnerAliyunId' => ['description' => '- 如果关联的是**专用凭证**，该字段表示入网凭证拥有者的阿里云账号。'."\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' => '与节点分组关联的入网凭证的启停状态。返回值：'."\n"
."\n"
.'- **true**：启用。'."\n"
.'- **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' => '节点分组的数据流转启停状态。返回值：'."\n"
."\n"
.'- **true**：启用。'."\n"
.'- **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'],
'JoinPermissionName' => ['description' => '与节点分组关联的入网凭证的名称。', 'type' => 'string', 'example' => 'test'],
'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'],
],
'description' => '',
],
],
'DataDispatchConfig' => [
'description' => '节点分组的数据流转配置。',
'type' => 'object',
'properties' => [
'Destination' => ['description' => '数据流转目的地。返回值：'."\n"
."\n"
.'- **IOT**：数据流转到物联网平台的产品。'."\n"
.'- **ONS**：数据流转到MQ的Topic。', 'type' => 'string', 'example' => 'IOT'],
'IotProduct' => [
'description' => '如果流转目的地是物联网平台的产品，该字段存储产品信息。',
'type' => 'object',
'properties' => [
'DebugSwitch' => ['description' => '数据流转目的地为**IOT**的调试开关。返回值：'."\n"
."\n"
.'- **true**：打开调试开关。'."\n"
.'- **false**：关闭调试开关。', 'type' => 'boolean', 'example' => 'false'],
'ProductKey' => ['description' => '产品的ProductKey。', '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-shanghai'],
'DownlinkRegionName' => ['description' => 'MQ下行Region ID。', 'type' => 'string', 'example' => 'cn-beijing'],
'DownlinkTopic' => ['description' => 'MQ下行Topic。', 'type' => 'string', 'example' => 'topic1'],
],
],
],
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
],
],
'title' => 'ListNodeGroups',
'summary' => '调用ListNodeGroups查询当前阿里云账号下的节点分组列表。',
'description' => '# 限制说明'."\n"
."\n"
.'单阿里云账号调用该接口的每秒请求数（QPS）最大限制为5。'."\n"
."\n"
.'> RAM用户共享阿里云账号配额。',
'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~108601~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeGroups'],
],
],
'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 \\"JoinPermissionName\\": \\"test\\",\\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 \\"DebugSwitch\\": false,\\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":"\\n89EF6CAA-958F-F32C-BE45-FE003C6DE097\\n\\n 10\\n \\n 10\\n 0\\n A\\n 节点分组名称2\\n 0\\n 0\\n 0\\n LOCAL\\n some-user2\\n 123456\\n 1514736000000\\n 123456\\n test\\n true\\n 102\\n 0\\n true\\n \\n 1514736000000\\n true\\n WRITE\\n 123\\n \\n \\n IOT\\n \\n false\\n 产品名\\n IOT_SUITE\\n xxxxxxxx\\n \\n \\n \\n
\\n\\ntrue\\n","errorExample":""}]',
],
'ListNodeTransferPacketPaths' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'DevEui',
'in' => 'query',
'schema' => ['description' => '根据DevEUI过滤数据包。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000001'],
],
[
'name' => 'Base64EncodedMacPayload',
'in' => 'query',
'schema' => ['description' => '数据包的MacPayload，由**ListNodeGroupTransferPackets**接口的返回值获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxx'],
],
[
'name' => 'LogMillis',
'in' => 'query',
'schema' => ['description' => '收到此数据包的时间，由ListNodeGroupTransferPackets的返回值获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '14643600000'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
],
],
'title' => '获取节点上行数据包的平行路径',
'summary' => '调用ListNodeTransferPacketPaths获取节点上行数据包的平行路径。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeTransferPacketPaths'],
],
],
'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 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":""}]',
],
'ListNodeTransferPackets' => [
'summary' => '获取节点分组上下行数据包的统计信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'query',
'schema' => ['description' => '根据**DevEUI**参数过滤数据包。'."\n", 'type' => 'string', 'required' => true, 'example' => '0000000000000001'],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => [
'description' => '数据包分类，可取值为：'."\n"
."\n"
.'- **DOWNLINK_PACKET**：下行包。'."\n"
."\n"
.'- **UPLINK_PACKET**：上行包。'."\n"
."\n"
.'- **INVALID_PACKET**：无效包。'."\n",
'type' => 'string',
'required' => true,
'example' => 'DOWNLINK_PACKET',
'enum' => ['DOWNLINK_PACKET', 'UPLINK_PACKET', 'INVALID_PACKET'],
],
],
[
'name' => 'GwEui',
'in' => 'query',
'schema' => ['description' => '根据**GwEUI**参数过滤数据包。'."\n", 'type' => 'string', 'required' => false, 'example' => '0000000000000001'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页页码，从1开始。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小，需大于等于1。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '300', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => ['description' => '查询开始时间，单位为毫秒的UNIX时间戳。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => ['description' => '查询结束时间，单位为毫秒的**UNIX**时间戳。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '排序字段，可设置为**LOG_MILLIS**（按照时间排序）。'."\n",
'type' => 'string',
'required' => false,
'example' => 'LOG_MILLIS',
'enum' => ['LOG_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => ['description' => '需配合**SortingField**参数一起使用。'."\n"
."\n"
.'- **true**：表示升序。'."\n"
."\n"
.'- **false**：表示降序（默认值）。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**：调用成功。'."\n"
.'- **false**：调用失败。'."\n"
."\n", 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID，阿里云为该请求生成的唯一标识符。'."\n"
."\n", 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 '],
'Data' => [
'description' => '返回的结果。'."\n"
."\n\n"
."\n\n"
."\n\n"
."\n\n"
."\n\n"
."\n\n"
."\n\n"
."\n\n"
."\n",
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '满足过滤条件的数据包总数。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'List' => [
'description' => '满足过滤条件的数据包列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LogMillis' => ['description' => '数据包传输的UNIX时间戳，单位为毫秒。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'Datr' => ['description' => '收发此数据包的数据速率。'."\n", 'type' => 'string', 'example' => 'SF12BW125'],
'Snr' => ['description' => '收发此数据包的信噪比。'."\n", 'type' => 'number', 'format' => 'float', 'example' => '-10.5'],
'DevEui' => ['description' => '收发此数据包的节点的DevEUI。'."\n", 'type' => 'string', 'example' => '0000000000000001'],
'GwEui' => ['description' => '收发此数据包所经过的网关的GwEUI。'."\n", 'type' => 'string', 'example' => '0000000000000000'],
'ClassMode' => ['description' => '收发此数据包时的LoRaWAN Class模式。'."\n", 'type' => 'string', 'example' => 'C'],
'Rssi' => ['description' => '收发此数据包的RSSI。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '-110'],
'Freq' => ['description' => '收发此数据包的频点。'."\n", 'type' => 'number', 'format' => 'float', 'example' => '470.3'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '获取节点分组上下行数据包的统计信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeTransferPackets'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\t\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"LogMillis\\": 1514736000000,\\n \\"Datr\\": \\"SF12BW125\\",\\n \\"Snr\\": -10.5,\\n \\"DevEui\\": \\"0000000000000001\\",\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"ClassMode\\": \\"C\\",\\n \\"Rssi\\": -110,\\n \\"Freq\\": 470.3\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\t\\n \\n 10\\n \\n 1514736000000\\n SF12BW125\\n -10.5\\n 0000000000000001\\n 0000000000000000\\n C\\n -110\\n 470.3\\n
\\n \\n","errorExample":""}]',
],
'ListNodeTupleOrders' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'State',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '工单状态过滤，如未传入此参数，则不限制工单状态。'."\n"
."\n"
.'工单状态取值请参见下方类型说明。',
'type' => 'array',
'items' => ['description' => '工单状态过滤，如未传入此参数，则不限制工单状态。可取值：'."\n"
."\n"
.'- APPLYING：申请中。'."\n"
."\n"
.'- REJECTED：已拒绝。'."\n"
."\n"
.'- ACCEPTING：分发中。'."\n"
."\n"
.'- ACCEPTED：分发成功。'."\n"
."\n"
.'- ACCEPTING_FAILED：分发失败。'."\n"
."\n"
.'- REVOKING：撤回中。'."\n"
."\n"
.'- REVOKED：撤回成功。'."\n"
."\n"
.'- REVOKING_FAILED：撤回失败。'."\n", 'type' => 'string', 'required' => false, 'example' => 'APPLYING'],
'required' => false,
'example' => 'APPLYING',
'maxItems' => 10,
],
],
[
'name' => 'IsKpm',
'in' => 'query',
'schema' => ['description' => '是否是Kpm发起的工单。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => ['description' => '本次查询的起始位置，从0开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => '本次查询的工单数量上限，须大于等于1。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '查询结果的排序字段，可取值为：'."\n"
."\n"
.'- CREATED_MILLIS：根据工单发起时间排序。'."\n"
."\n"
.'- ACCEPTED_MILLIS：根据工单审批通过时间排序。',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS', 'ACCEPTED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => ['description' => '需配合**SortingField**字段一起使用。'."\n"
."\n"
.'- **true**：表示升序。'."\n"
."\n"
.'- **false**：表示降序。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**：调用成功。'."\n"
.'- **false**：调用失败。'."\n"
."\n", 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID，阿里云为该请求生成的唯一标识符。'."\n"
."\n", 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Data' => [
'description' => '返回的结果。'."\n"
."\n\n"
."\n\n"
."\n\n"
."\n\n"
."\n\n"
."\n\n"
."\n\n"
."\n\n"
."\n\n"
."\n\n"
."\n",
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '满足过滤条件的工单数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '42'],
'List' => [
'description' => '满足过滤条件的节点元组工单信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FailedCount' => ['description' => '节点颁发失败数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'RequiredCount' => ['description' => '节点密钥申请数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'CreatedMillis' => ['description' => '提交此工单的UNIX时间戳，单位为毫秒。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'IsKpm' => ['description' => '是否是Kpm发起的工单。'."\n"
."\n"
.'- **true**：是。'."\n"
."\n"
.'- **false**：否。', 'type' => 'boolean', 'example' => 'false'],
'TupleType' => ['description' => '节点密钥类型。'."\n"
."\n", 'type' => 'string', 'example' => 'noncontractual'],
'AcceptedMillis' => ['description' => '工单审批通过的UNIX时间戳，单位为毫秒。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1514822400000'],
'SuccessCount' => ['description' => '节点密钥颁发数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'LoraVersion' => ['description' => 'LoRaWAN协议版本。'."\n", 'type' => 'string', 'example' => '1.0.2'],
'OrderState' => ['description' => '节点密钥申请状态。', 'type' => 'string', 'example' => 'ACCEPTED'],
'OrderId' => ['description' => '工单编号。', 'type' => 'string', 'example' => '1234'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
],
],
'title' => '获取用户已提交的节点元组工单列表',
'summary' => '获取用户已提交的节点元组工单列表。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeTupleOrders'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 42,\\n \\"List\\": [\\n {\\n \\"FailedCount\\": 0,\\n \\"RequiredCount\\": 1,\\n \\"CreatedMillis\\": 1514736000000,\\n \\"IsKpm\\": false,\\n \\"TupleType\\": \\"noncontractual\\",\\n \\"AcceptedMillis\\": 1514822400000,\\n \\"SuccessCount\\": 1,\\n \\"LoraVersion\\": \\"1.0.2\\",\\n \\"OrderState\\": \\"ACCEPTED\\",\\n \\"OrderId\\": \\"1234\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue\\n\\n 42\\n \\n 1234\\n false\\n ACCEPTED\\n 1\\n 1\\n 0\\n 1.0.2\\n 1514736000000\\n 1514822400000\\n noncontractual\\n
\\n \\n 1235\\n false\\n REJECTED\\n 1\\n 1\\n 0\\n 1.0.2\\n 1514736000000\\n 1514822400000\\n noncontractual\\n
\\n","errorExample":""}]',
],
'ListNodesByNodeGroupId' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => ['description' => '节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'query',
'schema' => ['description' => '模糊匹配节点的DevEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => ['description' => '本次查询的起始位置，从0开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => '本次查询的节点数量上限，大于等于1。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '指定排序字段，可取值为**CREATED_MILLIS**，表示根据创建时间排序。',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS', 'LAST_JOIN_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'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'],
'MulticastGroupId' => ['description' => '组播ID值。', 'type' => 'string', 'example' => 'xxxx'],
'DevEui' => ['description' => '节点的DevEUI。', 'type' => 'string', 'example' => '0000000000000000'],
'NodeType' => ['type' => 'string'],
'JoinEui' => ['type' => 'string'],
'BoundMillis' => ['description' => '节点加入当前节点分组的时间，UNIX时间戳，以毫秒为单位。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514736000000'],
'ClassMode' => ['description' => '节点所采用的LoRaWAN Class模式，可取值：A、B、C。', 'type' => 'string', 'example' => 'A'],
'AuthTypes' => [
'type' => 'string',
'items' => ['description' => '网关合约类型。'."\n"
."\n"
.'- **HYBRID**：hybrid网关'."\n"
.'- **SINGLE_CHANNEL**：单通道网关'."\n"
.'- **STANDARD**：标准合约网关', 'type' => 'string', 'example' => 'STANDARD', 'index' => 200],
'description' => '',
],
'Appkey' => ['type' => 'string'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
],
],
'title' => '查询指定节点分组中的节点列表',
'summary' => '调用ListNodesByNodeGroupId根据过滤条件，查询指定节点分组中的节点列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodesByNodeGroupId'],
],
],
'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 \\"MulticastGroupId\\": \\"xxxx\\",\\n \\"DevEui\\": \\"0000000000000000\\",\\n \\"NodeType\\": \\"\\",\\n \\"JoinEui\\": \\"\\",\\n \\"BoundMillis\\": 1514736000000,\\n \\"ClassMode\\": \\"A\\",\\n \\"AuthTypes\\": \\"\\",\\n \\"Appkey\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\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":""}]',
],
'ListNodesByOwnedJoinPermissionId' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => ['description' => '入网凭证ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'FuzzyDevEui',
'in' => 'query',
'schema' => ['description' => '模糊匹配节点的DevEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => ['description' => '本次查询的起始位置，从0开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => '本次查询的节点数量上限，大于等于1。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '指定排序字段，可取值为**CREATED_MILLIS**, 表示根据创建时间排序。',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS', 'LAST_JOIN_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
],
],
'title' => '查询使用了特定入网凭证的节点列表',
'summary' => '调用ListNodesByOwnedJoinPermissionId根据过滤条件，查询使用了特定入网凭证的节点列表。',
'description' => '所指定的入网凭证必须时当前用户账号所拥有的入网凭证。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodesByOwnedJoinPermissionId'],
],
],
'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 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":""}]',
],
'ListNotifications' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'Category',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '通知类型列表，传 null 则不过滤类型。',
'type' => 'array',
'items' => ['description' => '通知类型列表，传**null**则不过滤类型。'."\n"
."\n"
.'- GATEWAY_OFFLINE：网关离线通知。'."\n"
."\n"
.'- JOIN_PERMISSION_AUTH_APPLYING：入网凭证申请。'."\n"
."\n"
.'- JOIN_PERMISSION_AUTH_ACCEPTED：入网凭证审批通过。'."\n"
."\n"
.'- JOIN_PERMISSION_AUTH_CANCELED：入网凭证申请撤销。'."\n"
."\n"
.'- JOIN_PERMISSION_AUTH_REJECTED：入网凭证申请拒绝。'."\n"
."\n"
.'- GATEWAY_DATAFLOW_LIMIT：网关限流。', 'type' => 'string', 'required' => false, 'example' => 'GATEWAY_OFFLINE'],
'required' => false,
'example' => 'GATEWAY_OFFLINE',
'maxItems' => 100,
],
],
[
'name' => 'HandleState',
'in' => 'query',
'schema' => [
'description' => '根据通知处理状态过滤，传**null**则不过滤处理状态。'."\n"
."\n"
.'- **HANDLED**：已处理。'."\n"
."\n"
.'- **UNHANDLED**：未处理。',
'type' => 'string',
'required' => false,
'example' => 'HANDLED',
'enum' => ['HANDLED', 'UNHANDLED'],
],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => ['description' => '查询的起始位置，需从0开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => '查询的通知数量上限，需大于等于1。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => ['description' => '开始时间查询，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1514736000000'],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => ['description' => '结束时间查询，毫秒为单位的UNIX时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1514736000000'],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '排序字段，可取值为**NOTICE_MILLIS**（按照通知发生时间排序）。',
'type' => 'string',
'required' => false,
'example' => 'NOTICE_MILLIS',
'enum' => ['NOTICE_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => ['description' => '配合**SortingField**参数一起使用。'."\n"
."\n"
.'- **true**：表示升序。'."\n"
."\n"
.'- **false**：表示降序。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**：调用成功。'."\n"
.'- **false**：调用失败。', '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' => '记录网关离线信息。'."\n"
."\n"
.'当**Category**字段为**GATEWAY_OFFLINE**时，该字段有值。',
'type' => 'object',
'properties' => [
'GwEui' => ['description' => '网关的GwEUI。', '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' => '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'],
],
],
'GatewayDataflowLimit' => [
'description' => '网关限流通知。',
'type' => 'object',
'properties' => [
'AlarmDetail' => ['description' => '通知内容。', 'type' => 'string', 'example' => 'GATEWAY_DATAFLOW_LIMIT'],
'DataflowLimitMillis' => ['description' => '限流时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1653450720919'],
'GwEui' => ['description' => '网关的唯一标识。', 'type' => 'string', 'example' => '0000000000000000'],
],
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [],
'title' => '获取通知列表',
'summary' => '调用ListNotifications获取通知列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNotifications'],
],
],
'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 \\"GatewayDataflowLimit\\": {\\n \\"AlarmDetail\\": \\"GATEWAY_DATAFLOW_LIMIT\\",\\n \\"DataflowLimitMillis\\": 1653450720919,\\n \\"GwEui\\": \\"0000000000000000\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\n \\n 100\\n \\n 1514736000000\\n GATEWAY_OFFLINE\\n HANDLED\\n 123\\n 1514736000001\\n \\n 0000000000000000\\n 1514736000000\\n \\n \\n 1514736000000\\n 1514736000000\\n 0000000000000001\\n some-user\\n 1514736000000\\n some-user1\\n 1514736000000\\n 126\\n 凭证2\\n ACCEPTED\\n 123\\n \\n \\n GATEWAY_DATAFLOW_LIMIT\\n 1653450720919\\n 0000000000000000\\n \\n
\\n \\n","errorExample":""}]',
],
'ListOwnedJoinPermissions' => [
'summary' => '根据过滤条件，查询当前用户账号所拥有的入网凭证列表。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'FuzzyRenterAliyunId',
'in' => 'query',
'schema' => ['description' => '模糊匹配入网凭证租户的阿里云账号ID。', 'type' => 'string', 'required' => false, 'example' => 'some-user'],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'query',
'schema' => ['description' => '模糊匹配入网凭证所使用的JoinEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => ['description' => '根据入网凭证的启停用状态过滤。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'FuzzyJoinPermissionName',
'in' => 'query',
'schema' => ['description' => '模糊匹配入网凭证的名称。', 'type' => 'string', 'required' => false, 'example' => '凭证1'],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => ['description' => '本次查询的起始位置，从 0 开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => '本次查询的入网凭证的数量上限，大于等于 1。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '指定排序字段，可取值为**CREATED_MILLIS**, 表示根据创建时间排序。',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'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'],
'RxDelay' => ['description' => 'classA的接收窗口延时。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'RenterAliyunId' => ['description' => '入网凭证租户的阿里云账号ID。', 'type' => 'string', 'example' => 'some-user1'],
'DataRate' => ['description' => '工作速率。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
'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' => 'NEW'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
],
],
'title' => '查询入网凭证列表',
'description' => '通过该接口获取到的当前用户账号名下的是专用入网凭证。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOwnedJoinPermissions'],
],
],
'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 \\"RxDelay\\": 1,\\n \\"RenterAliyunId\\": \\"some-user1\\",\\n \\"DataRate\\": 4,\\n \\"JoinPermissionId\\": \\"102\\",\\n \\"JoinPermissionName\\": \\"凭证1\\",\\n \\"ClassMode\\": \\"A\\",\\n \\"AuthState\\": \\"NEW\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\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":""}]',
],
'ListRentedJoinPermissions' => [
'summary' => '查询当前用户账号所租用的入网凭证列表（可能是专用入网凭证或泛在入网凭证）。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'FuzzyOwnerAliyunId',
'in' => 'query',
'schema' => ['description' => '模糊匹配入网凭证拥有者的阿里云账号ID。', 'type' => 'string', 'required' => false, 'example' => 'some-user'],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'query',
'schema' => ['description' => '模糊匹配入网凭证使用的JoinEUI。', 'type' => 'string', 'required' => false, 'example' => 'd896e0'],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => ['description' => '按照凭证的启停用状态进行过滤。**true**表示启用，**false**表示停用。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'BoundNodeGroup',
'in' => 'query',
'schema' => ['description' => '根据入网凭证是否关联到节点分组进行过滤。**true**表示已关联，**false**表示未关联。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '按照入网凭证的类型进行过滤，取值：'."\n"
."\n"
.'- **LOCAL**：专用凭证'."\n"
.'- **ROAMING**：泛在凭证',
'type' => 'string',
'required' => false,
'example' => 'LOCAL',
'enum' => ['LOCAL', 'ROAMING'],
],
],
[
'name' => 'FuzzyJoinPermissionName',
'in' => 'query',
'schema' => ['description' => '模糊匹配入网凭证的名称。', 'type' => 'string', 'required' => false, 'example' => '凭证1'],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => ['description' => '本次查询的起始位置，从 0 开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '0'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => '本次查询的入网凭证数量的上限，大于等于 1。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '指定排序字段，可取值为**CREATED_MILLIS**, 表示根据创建时间排序。',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => ['CREATED_MILLIS'],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'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'],
'BoundNodeGroupName' => ['description' => '入网凭证绑定的节点组名称。', 'type' => 'string', 'example' => '123'],
'FreqBandPlanGroupId' => ['description' => '入网凭证采用的频段的频段ID。', 'type' => 'string', 'example' => '102'],
'DataRate' => ['description' => '工作速率。', 'type' => 'string', 'example' => '4'],
'JoinPermissionId' => ['description' => '入网凭证ID。', 'type' => 'string', 'example' => '123'],
'ClassMode' => ['description' => '入网凭证采用的LoRaWAN Class模式，可取值：A、B、C。', 'type' => 'string', 'example' => 'A'],
'JoinEui' => ['description' => '入网凭证使用的的JoinEUI。', 'type' => 'string', 'example' => '0000000000000000'],
'Enabled' => ['description' => '入网凭证的启停用状态。', 'type' => 'boolean', 'example' => 'true'],
'BoundNodeGroup' => ['description' => '入网凭证是否已关联到节点分组。', 'type' => 'boolean', 'example' => 'false'],
'RxDelay' => ['description' => 'classA的接收窗口延时。', 'type' => 'string', 'example' => '1'],
'BoundNodeGroupId' => ['description' => '入网凭证绑定的节点组id。', 'type' => 'string', 'example' => '123'],
'OwnerAliyunId' => ['description' => '- 如果该入网凭证是**专用入网凭证**，该字段表示拥有者的阿里云账号ID。'."\n"
.'- 如果该入网凭证是**泛在入网凭证**，该字段恒为AliCloud IoT。', 'type' => 'string', 'example' => 'some-user1'],
'JoinPermissionName' => ['description' => '入网凭证的名称。', 'type' => 'string', 'example' => '凭证1'],
'DataDispatchConfig' => [
'type' => 'object',
'properties' => [
'Destination' => ['type' => 'string'],
'IotProduct' => [
'type' => 'object',
'properties' => [
'DebugSwitch' => ['type' => 'boolean'],
'ProductKey' => ['type' => 'string'],
'ProductName' => ['type' => 'string'],
'ProductType' => ['type' => 'string'],
],
],
'OnsTopics' => [
'type' => 'object',
'properties' => [
'UplinkTopic' => ['type' => 'string'],
'UplinkRegionName' => ['type' => 'string'],
'DownlinkRegionName' => ['type' => 'string'],
'DownlinkTopic' => ['type' => 'string'],
],
],
],
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
],
],
'title' => '查询入网凭证列表',
'description' => '****',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRentedJoinPermissions'],
],
],
'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 \\"BoundNodeGroupName\\": \\"123\\",\\n \\"FreqBandPlanGroupId\\": \\"102\\",\\n \\"DataRate\\": \\"4\\",\\n \\"JoinPermissionId\\": \\"123\\",\\n \\"ClassMode\\": \\"A\\",\\n \\"JoinEui\\": \\"0000000000000000\\",\\n \\"Enabled\\": true,\\n \\"BoundNodeGroup\\": false,\\n \\"RxDelay\\": \\"1\\",\\n \\"BoundNodeGroupId\\": \\"123\\",\\n \\"OwnerAliyunId\\": \\"some-user1\\",\\n \\"JoinPermissionName\\": \\"凭证1\\",\\n \\"DataDispatchConfig\\": {\\n \\"Destination\\": \\"\\",\\n \\"IotProduct\\": {\\n \\"DebugSwitch\\": true,\\n \\"ProductKey\\": \\"\\",\\n \\"ProductName\\": \\"\\",\\n \\"ProductType\\": \\"\\"\\n },\\n \\"OnsTopics\\": {\\n \\"UplinkTopic\\": \\"\\",\\n \\"UplinkRegionName\\": \\"\\",\\n \\"DownlinkRegionName\\": \\"\\",\\n \\"DownlinkTopic\\": \\"\\"\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\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":""}]',
],
'RejectJoinPermissionAuthOrder' => [
'summary' => '调用RejectJoinPermissionAuthOrder回绝专用入网凭证授权工单。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
['errorCode' => 'IllegalOrderStateTransition', 'errorMessage' => 'The order status conversion is invalid.', 'description' => '工单状态转换非法'],
],
],
'title' => '回绝专用入网凭证授权工单',
'description' => '> 开发者（解决方案供应商）通过该接口回绝一个由网络运营者授权的专用入网凭证。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RejectJoinPermissionAuthOrder'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'RemoveNodeFromGroup' => [
'summary' => '调用RemoveNodeFromGroup从节点分组中移除节点。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'query',
'schema' => ['description' => '要移除的节点的DevEUI。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'NodeGroupId',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.', 'description' => '资源被其他云产品锁定'."\n"],
['errorCode' => 'NodeGroupDoesNotExist', 'errorMessage' => 'The specified node group does not exist.', 'description' => '节点组不存在'."\n"],
['errorCode' => 'NodeDoesNotExist', 'errorMessage' => 'The specified node does not exist.', 'description' => '节点不存在'."\n"],
],
],
'title' => '从节点分组中移除节点',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveNodeFromGroup'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'ReturnJoinPermission' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => ['description' => '要归还的入网凭证ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'JoinPermissionType',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'JoinPermissionAlreadyBoundNodeGroup', 'errorMessage' => 'The specified join permission has already been bound to another node group.', 'description' => '入网凭证已经绑定了节点组'],
],
],
'title' => '归还租用的入网凭证',
'summary' => '归还租用的入网凭证（可以是专用入网凭证或泛在入网凭证）。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReturnJoinPermission'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'SendUnicastCommand' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['description' => '物联网平台的实例id，为空表示公共实例。', 'type' => 'string', 'required' => false, 'example' => 'iotx-oxssharez'],
],
[
'name' => 'DevEui',
'in' => 'query',
'schema' => ['description' => '目标节点。', 'type' => 'string', 'required' => true, 'example' => '0000000000000000'],
],
[
'name' => 'MaxRetries',
'in' => 'query',
'schema' => ['description' => '最大重发次数，默认为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '0', 'default' => '0'],
],
[
'name' => 'CleanUp',
'in' => 'query',
'schema' => ['description' => '是否清空该节点的堆积指令，并下发该指令。默认为**false**。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
[
'name' => 'FPort',
'in' => 'query',
'schema' => ['description' => 'fPort。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '223', 'minimum' => '1', 'example' => '0'],
],
[
'name' => 'Confirmed',
'in' => 'query',
'schema' => ['description' => '是否是confirmed指令，默认为**false**。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
[
'name' => 'Content',
'in' => 'query',
'schema' => ['description' => '要发送的内容。16进制字符串，最长51个字节（如果换算成16进制字符串，最长为51*2个字符）。', 'type' => 'string', 'required' => 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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'Abandoned', 'errorMessage' => 'An error occurred while processing this request, because the API has been abandoned.', 'description' => '该接口已经被废弃。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
],
],
'title' => '发送单播信息',
'summary' => '调用SendUnicastCommand发送单播信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendUnicastCommand'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'SubmitGatewayTupleOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RequiredCount',
'in' => 'query',
'schema' => ['description' => '要申请的网关安全密钥的数量。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'],
],
[
'name' => 'TupleType',
'in' => 'query',
'schema' => ['description' => '网关密钥类型。'."\n"
."\n"
.'- singlechannel：低速版（单通道型）。'."\n"
."\n"
.'- standard：标准版。'."\n"
."\n"
.'- hybrid：高速版（Hybrid型）。'."\n"
."\n"
.'- noncontractual：高速版。', 'type' => 'string', 'required' => true, 'example' => 'noncontractual'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '工单ID。', 'type' => 'string', 'example' => '12345'],
'RequestId' => ['description' => '请求ID，阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**：调用成功。'."\n"
.'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'ExceedGatewayTupleLimit', 'errorMessage' => 'The maximum number of gateway tuples is exceeded.', 'description' => '超出网关元组限额'],
],
],
'title' => '提交网关密钥申请工单',
'summary' => '提交网关密钥申请工单。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitGatewayTupleOrder'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"12345\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 12345\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\n true\\n","errorExample":""}]',
],
'SubmitJoinPermissionAuthOrder' => [
'summary' => '调用SubmitJoinPermissionAuthOrder发起专用入网凭证授权工单。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => ['description' => '要授权的专用入网凭证ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'RenterAliyunId',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'TooManyRenterNonExistentFailures', 'errorMessage' => 'You have entered invalid renter usernames for several times. Try again later.', 'description' => '被授权者账号名输入错误次数过多，请稍后再试。'],
['errorCode' => 'JoinPermissionAlreadyAuthorized', 'errorMessage' => 'The specified join permission has already been granted to another renter.', 'description' => '入网凭证已经授权给了其它用户'],
['errorCode' => 'RenterDoesNotExist', 'errorMessage' => 'The specified renter does not exist.', 'description' => '被授权的用户不存在'],
],
],
'title' => '发起专用入网凭证授权工单',
'description' => '网络运营者可以通过该接口向开发者（解决方案供应商）授权一个专用入网凭证。不过只是发起了一个授权工单，需待开发者接受该授权后，授权才能完成。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitJoinPermissionAuthOrder'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 1234,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1234\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'SubmitNodeTupleOrder' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'LoraVersion',
'in' => 'query',
'schema' => [
'description' => 'LoRaWAN协议版本。'."\n",
'type' => 'string',
'required' => true,
'example' => '1.0.2',
'enum' => ['1.0.2', '1.1'],
],
],
[
'name' => 'RequiredCount',
'in' => 'query',
'schema' => ['description' => '要申请的节点密钥数量。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'TupleType',
'in' => 'query',
'schema' => ['description' => '申请的密钥类型'."\n"
."\n"
.'noncontractual：专业版密钥'."\n"
."\n"
.'standard：标准版密钥'."\n"
."\n"
.'relay：中继密钥', 'type' => 'string', 'required' => true, 'example' => 'standard'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '工单 Id。'."\n"
."\n\n"
."\n\n", 'type' => 'string', 'example' => '12345'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
'Success' => ['description' => '是否成功。'."\n"
."\n", 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
],
],
'title' => '提交节点密钥申请工单',
'summary' => '提交节点密钥申请工单。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitNodeTupleOrder'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"12345\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue\\n12345","errorExample":""}]',
],
'UnbindJoinPermissionFromNodeGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => ['description' => '要接触关联的节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'JoinPermissionId',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.', 'description' => '资源被其他云产品锁定'."\n"],
],
],
'title' => '接触入网凭证和节点分组的关联',
'summary' => '调用UnbindJoinPermissionFromNodeGroup接触入网凭证和节点分组的关联。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindJoinPermissionFromNodeGroup'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'UpdateDataDispatchConfig' => [
'summary' => '调用UpdateDataDispatchConfig更新节点分组的数据流转配置。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => ['description' => '要更新的节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'DataDispatchDestination',
'in' => 'query',
'schema' => [
'description' => '数据流转目的地。取值：'."\n"
."\n"
.'- **IOT**：数据流转到IoT的产品。'."\n"
.'- **ONS**：数据流转到MQ的Topic。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'IOT',
'enum' => ['IOT', 'MQ'],
],
],
[
'name' => 'ProductType',
'in' => 'query',
'schema' => [
'description' => '数据流转目的地为IoT的产品类型。取值：'."\n"
."\n"
.'- **IOT_SUITE**：数据流转到 IoT 套件基础版。'."\n"
.'- **IOT_SUITE_SENIOR**：数据流转到 IoT 套件高级版。'."\n"
."\n"
.'数据流转目的地为IoT时，请求参数必填。',
'type' => 'string',
'required' => false,
'example' => 'IOT_SUITE',
'enum' => ['IOT_SUITE', 'IOT_SUITE_SENIOR'],
],
],
[
'name' => 'ProductName',
'in' => 'query',
'schema' => ['description' => '数据流转目的地为IoT的产品名称。'."\n"
."\n"
.'数据流转目的地为IoT时，请求参数必填。', 'type' => 'string', 'required' => false, 'example' => '产品1'],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => ['description' => '数据流转目的地为IoT的Product Key。'."\n"
."\n"
.'数据流转目的地为IoT时，请求参数必填。', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxx'],
],
[
'name' => 'DebugSwitch',
'in' => 'query',
'schema' => ['description' => '数据流转目的地为 IoT 的调试开关。'."\n"
."\n"
.'调试开关主要针对物联网平台自定义Topic，针对物联网络管理控制台，请勿修改自定义topic。'."\n"
."\n"
.'自定义Topic如下：'."\n"
."\n"
.'/ProductKey/${deviceName}/user/update'."\n"
."\n"
.'/ProductKey/${deviceName}/user/get', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'UplinkRegionName',
'in' => 'query',
'schema' => ['description' => '数据流转目的地为MQ的上行Region Id。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
],
[
'name' => 'UplinkTopic',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.', 'description' => '资源被其他云产品锁定'."\n"],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '更新节点分组的数据流转配置',
'requestParamsDescription' => "\n",
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDataDispatchConfig'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'UpdateDataDispatchEnablingState' => [
'summary' => '调用UpdateDataDispatchEnablingState启停节点分组的数据流转。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => ['description' => '节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'DataDispatchEnabled',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.', 'description' => '资源被其他云产品锁定'."\n"],
],
],
'title' => '启停节点分组的数据流转',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDataDispatchEnablingState'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'UpdateGateway' => [
'summary' => '调用UpdateGateway更新网关信息。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'GwEui',
'in' => 'query',
'schema' => ['description' => '网关唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '自定义网关名称。', 'type' => 'string', 'required' => false, 'example' => '网关名称'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '自定义网关描述。', 'type' => 'string', 'required' => false, 'example' => '网关描述'],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'query',
'schema' => ['description' => '网关频段ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
],
[
'name' => 'CommunicationMode',
'in' => 'query',
'schema' => [
'description' => '网关通信模式。可取值为FULL_DUPLEX(全双工）、HALF_DUPLEX(半双工)。',
'type' => 'string',
'required' => false,
'example' => 'HALF_DUPLEX',
'enum' => ['HALF_DUPLEX', 'FULL_DUPLEX'],
],
],
[
'name' => 'AddressCode',
'in' => 'query',
'schema' => ['description' => '网关所在地区ID，由`http://lbs.amap.com/api/javascript-api/download`定义。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
],
[
'name' => 'City',
'in' => 'query',
'schema' => ['description' => '网关所在城市名称。', 'type' => 'string', 'required' => false, 'example' => '某某市'],
],
[
'name' => 'District',
'in' => 'query',
'schema' => ['description' => '网关所在城区名称。', 'type' => 'string', 'required' => false, 'example' => '某某区'],
],
[
'name' => 'Address',
'in' => 'query',
'schema' => ['description' => '网关所在详细地址。', 'type' => 'string', 'required' => false, 'example' => '详细地址'],
],
[
'name' => 'GisCoordinateSystem',
'in' => 'query',
'schema' => [
'description' => '网关经纬度所采用的坐标系统，可取值为**WGS_84**, **GCJ_02**。',
'type' => 'string',
'required' => false,
'example' => 'GCJ_02',
'enum' => ['GCJ_02', 'WGS_84'],
],
],
[
'name' => 'Longitude',
'in' => 'query',
'schema' => ['description' => '网关经度。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '123.45678'],
],
[
'name' => 'Latitude',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.', 'description' => '名称不合法'],
],
],
'title' => '更新网关信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGateway'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'UpdateGatewayEnablingState' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'GwEui',
'in' => 'query',
'schema' => ['description' => '网关唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0000000000000000'],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => ['description' => '是否开启网关。'."\n"
."\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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
],
],
'title' => '启动、关闭网关',
'summary' => '调用UpdateGatewayEnablingState启动、关闭网关。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGatewayEnablingState'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'UpdateNodeGroup' => [
'summary' => '调用UpdateNodeGroup更新节点分组。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => ['description' => '节点分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'],
],
[
'name' => 'NodeGroupName',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
['errorCode' => 'NodeGroupNameDuplicated', 'errorMessage' => 'The specified node group name already exists.', 'description' => '节点组名称重复'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.', 'description' => '名称不合法'],
['errorCode' => 'ResourceLocked', 'errorMessage' => 'The specified resource has been locked by another product.', 'description' => '资源被其他云产品锁定'."\n"],
],
],
'title' => '更新节点分组',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateNodeGroup'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'UpdateNotificationsHandleState' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'NotificationId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '通知ID列表。',
'type' => 'array',
'items' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'required' => true,
'example' => '1',
'maxItems' => 100,
],
],
[
'name' => 'TargetHandleState',
'in' => 'query',
'schema' => [
'description' => '要设置的处理状态，可取值为**HANDLED**（已处理）, **UNHANDLED**（未处理）。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'UNHANDLED',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
],
],
'title' => '更新通知的处理状态',
'summary' => '调用UpdateNotificationsHandleState更新通知的处理状态。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateNotificationsHandleState'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'UpdateOwnedLocalJoinPermission' => [
'summary' => '调用UpdateOwnedLocalJoinPermission更新当前用户账号所拥有的专用入网凭证。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => ['description' => '专用入网凭证ID，用来指定要更新的入网凭证。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'query',
'schema' => ['description' => '专用入网凭证所采用的频段的频段ID，用于更新旧频段。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '201'],
],
[
'name' => 'ClassMode',
'in' => 'query',
'schema' => [
'description' => '专用入网凭证采用的LoRaWAN Class模式，用于更新旧的 Class 模式。可取值：A、B、C。',
'type' => 'string',
'required' => false,
'example' => 'A',
'enum' => ['A', 'B', 'C'],
],
],
[
'name' => 'JoinPermissionName',
'in' => 'query',
'schema' => ['description' => '自定义入网凭证名称，用于更新旧名称。', 'type' => 'string', 'required' => false, 'example' => '凭证1'],
],
[
'name' => 'RxDelay',
'in' => 'query',
'schema' => ['description' => 'classA的接收窗口延时。'."\n", 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'DataRate',
'in' => 'query',
'schema' => ['description' => '工作速率。', 'type' => 'string', 'required' => false, 'example' => '4'],
],
[
'name' => 'JoinEui',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'JoinPermissionAlreadyAuthorized', 'errorMessage' => 'The specified join permission has already been granted to another renter.', 'description' => '入网凭证已经授权给了其它用户'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
['errorCode' => 'JoinPermissionNameDuplicated', 'errorMessage' => 'The specified join permission name already exists.', 'description' => '入网凭证名称重复'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.', 'description' => '名称不合法'],
['errorCode' => 'InvalidFreqBandPlan', 'errorMessage' => 'The frequency band plan is invalid.', 'description' => '频段计划不可用'],
],
],
'title' => '更新当前用户账号所拥有的专用入网凭证',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOwnedLocalJoinPermission'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'UpdateOwnedLocalJoinPermissionEnablingState' => [
'summary' => '启用、停用当前用户账号所拥有的专用入网凭证。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => ['description' => '要操作的专用入网凭证ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'],
],
[
'name' => 'Enabled',
'in' => 'query',
'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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '启用或停用专用入网凭证',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOwnedLocalJoinPermissionEnablingState'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
],
'UpdateRoamingJoinPermission' => [
'summary' => '更新当前用户账号所申请的泛在入网凭证。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => ['description' => '要更新的泛在入网凭证的ID。', 'type' => 'string', 'required' => true, 'example' => '123'],
],
[
'name' => 'JoinPermissionName',
'in' => 'query',
'schema' => ['description' => '自定义入网凭证名称，用于更新旧名称。', 'type' => 'string', 'required' => false, 'example' => '泛在凭证1'],
],
[
'name' => 'RxDelay',
'in' => 'query',
'schema' => ['description' => 'class A的接收窗口延时，单位为ms。'."\n", 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'DataRate',
'in' => 'query',
'schema' => ['description' => '工作速率。', 'type' => 'string', 'required' => false, 'example' => '4'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**：调用成功。'."\n"
.'- **false**：调用失败。'."\n", 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID，阿里云为该请求生成的唯一标识符。'."\n"
."\n", 'type' => 'string', 'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'JoinPermissionAlreadyBoundNodeGroup', 'errorMessage' => 'The specified join permission has already been bound to another node group.', 'description' => '入网凭证已经绑定了节点组'],
['errorCode' => 'JoinPermissionNameDuplicated', 'errorMessage' => 'The specified join permission name already exists.', 'description' => '入网凭证名称重复'],
['errorCode' => 'InvalidName', 'errorMessage' => 'The specified name is invalid.', 'description' => '名称不合法'],
],
],
'title' => '更新当前用户账号所申请的泛在入网凭证',
'description' => '## QPS限制'."\n"
.'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为5。'."\n"
."\n"
.'> RAM用户共享阿里云账号配额。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRoamingJoinPermission'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue","errorExample":""}]',
],
'UpdateRoamingJoinPermissionEnablingState' => [
'summary' => '更新泛在凭证的启用状态。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => ['description' => '泛在凭证id。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234'],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => ['description' => '泛在凭证启用状态。', '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'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ForbiddenByRam', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'description' => '用户没有执行该操作所需要的RAM权限。'],
['errorCode' => 'ForbiddenByRiskControl', 'errorMessage' => 'This operation cannot be performed because of security risks.', 'description' => '存在安全风险，无法执行该操作'],
['errorCode' => 'NonExistent', 'errorMessage' => 'The specified resource does not exist.', 'description' => '要操作的资源不存在。'],
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '内部错误。'],
['errorCode' => 'CloudProductNotActivated', 'errorMessage' => 'The Link WAN service has not been activated.', 'description' => '未开通 Link WAN 云产品'],
['errorCode' => 'FeatureNotActivated', 'errorMessage' => 'The feature has not been activated.', 'description' => '功能未开通'],
['errorCode' => 'NotResourceOwner', 'errorMessage' => 'You are not authorized to use this resource.', 'description' => '无权访问此资源'],
],
],
'title' => '更新泛在凭证的启用状态',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRoamingJoinPermissionEnablingState'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue","errorExample":""}]',
],
],
'endpoints' => [
['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkwan.cn-shanghai.aliyuncs.com', 'endpoint' => 'linkwan.cn-shanghai.aliyuncs.com', 'vpc' => 'linkwan-vpc.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkwan.cn-hangzhou.aliyuncs.com', 'endpoint' => 'linkwan.cn-hangzhou.aliyuncs.com', 'vpc' => 'linkwan-vpc.cn-hangzhou.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'Abandoned', 'message' => 'An error occurred while processing this request, because the API has been abandoned.', 'http_code' => 400, 'description' => '该接口已经被废弃。'],
['code' => 'Arrearage', 'message' => 'The specified user account has an outstanding payment.', 'http_code' => 400, 'description' => '用户账户欠费'],
['code' => 'BoundLabNodesIsNotEmpty', 'message' => 'You cannot delete this gateway, because it is bound to lab nodes.', 'http_code' => 400, 'description' => '绑定的实验室节点不为空'],
['code' => 'CloudProductNotActivated', 'message' => 'The Link WAN service has not been activated.', 'http_code' => 400, 'description' => '未开通 Link WAN 云产品'],
['code' => 'ConcurrentConflict', 'message' => 'The resource is operated by another user.', 'http_code' => 400, 'description' => '当前资源在其他账号下'],
['code' => 'D2D.ConfigExisted', 'message' => 'The configuration already exists.', 'http_code' => 400, 'description' => '局域网配置已存在。'],
['code' => 'D2D.ConfigNotExisted', 'message' => 'The configuration does not exist.', 'http_code' => 400, 'description' => '局域网配置不存在。'],
['code' => 'D2D.TaskProcessing', 'message' => 'Another task is in progress.', 'http_code' => 400, 'description' => '任务执行中。'],
['code' => 'DevEuiAlreadyUsed', 'message' => 'DevEui has been used by another device.', 'http_code' => 400, 'description' => 'DevEui 已经被其他设备占用'],
['code' => 'DevEuiDuplicated', 'message' => 'A node with the same devEui already exists.', 'http_code' => 400, 'description' => '节点重复添加'],
['code' => 'DomainInvalid', 'message' => 'The specified domain is invalid. Contact Customer Services.', 'http_code' => 400, 'description' => '域名不合法,请联系客服处理。'],
['code' => 'EmbeddedNsContainingNodesCannotBeDeleted', 'message' => 'You cannot delete an embedded network server that contains nodes.', 'http_code' => 400, 'description' => '包含节点的内嵌 network server 不可以被删除。'],
['code' => 'EmbeddedNsNodeAlreadyAdded', 'message' => 'The specified node has already been added to the embedded network server.', 'http_code' => 400, 'description' => '节点已经添加到内嵌 network server，无法重复添加。'],
['code' => 'EmbeddedNsNodeCapacityIsFull', 'message' => 'You cannot add more nodes to the embedded network server.', 'http_code' => 400, 'description' => '内嵌 network server 的节点容量已满，无法继续添加节点。'],
['code' => 'EmbeddedNsNodeDevAddrDuplicated', 'message' => 'You cannot add the specified node to the embedded network server. The specified node and a node of the embedded network server have the same DevAddr.', 'http_code' => 400, 'description' => '节点的 DevAddr 与已有节点的 DevAddr 重复，无法添加该节点到 embedded network server 中。'],
['code' => 'EmbeddedNsNodeSyncActionIsRunning', 'message' => 'Applying the node configuration to the embedded network server. You cannot modify or delete the node.', 'http_code' => 400, 'description' => '该节点正在被同步到内嵌 network server 中，无法被修改或删除。'],
['code' => 'EmbeddedNsNodeTupleAlreadyUsed', 'message' => 'The node tuple is being used. You cannot add this node to the embedded network server.', 'http_code' => 400, 'description' => '节点元组已经被使用，无法添加到内嵌 network server 中。'],
['code' => 'ExceedCustomLocalJoinPermissionLimit', 'message' => 'The maximum number of custom local join permissions that you can create is exceeded.', 'http_code' => 400, 'description' => '超出了定制专用凭证的最大限额'],
['code' => 'ExceedExternalNodeLimit', 'message' => 'The maximum number of external nodes is exceeded.', 'http_code' => 400, 'description' => '超出外部节点的最大限额'],
['code' => 'ExceedExternalNodeTupleLimit', 'message' => 'The maximum number of external node tuples is exceeded.', 'http_code' => 400, 'description' => '超出外部节点元组的最大限额'],
['code' => 'ExceedGatewayLimit', 'message' => 'The maximum number of gateways is exceeded.', 'http_code' => 400, 'description' => '超出网关可使用额度'],
['code' => 'ExceedGatewayTupleLimit', 'message' => 'The maximum number of gateway tuples is exceeded.', 'http_code' => 400, 'description' => '超出网关元组限额'],
['code' => 'ExceedLabGatewayLimit', 'message' => 'The maximum number of lab gateways is exceeded.', 'http_code' => 400, 'description' => '超出实验室网关系统限额'],
['code' => 'ExceedLabNodeLimit', 'message' => 'The maximum number of lab nodes is exceeded.', 'http_code' => 400, 'description' => '超出实验室节点系统限额'],
['code' => 'ExceedLocalJoinPermissionLimit', 'message' => 'The maximum number of local join permissions that you can create is exceeded.', 'http_code' => 400, 'description' => '超出本地凭证已购买额度'],
['code' => 'ExceedMaxMulticastNodeCapacity', 'message' => 'The maximum number of multicast nodes is exceeded.', 'http_code' => 400, 'description' => '超过组播可设定节点最大数量'],
['code' => 'ExceedMaxNodeTuplesRequiredCount', 'message' => 'The maximum number of node tuples in each request is exceeded.', 'http_code' => 400, 'description' => '超出节点元组单次可申请的最大数量'],
['code' => 'ExceedMaxOperationCount', 'message' => 'The maximum number of operations is exceeded.', 'http_code' => 400, 'description' => '超出可操作的最大数量'],
['code' => 'ExceedMaxTimeInterval', 'message' => 'The maximum time interval is exceeded.', 'http_code' => 400, 'description' => '超出了最大时间区间'],
['code' => 'ExceedNodeLimit', 'message' => 'The maximum number of nodes is exceeded.', 'http_code' => 400, 'description' => '超出节点可使用额度'],
['code' => 'ExceedNodeTupleLimit', 'message' => 'The maximum number of node tuples is exceeded.', 'http_code' => 400, 'description' => '超出节点元组限额'],
['code' => 'ExceedRelayLimit', 'message' => 'The maximum number of relays is exceeded.', 'http_code' => 400, 'description' => '超过中继最大限额'],
['code' => 'ExceedRoamingJoinPermissionLimit', 'message' => 'The maximum number of roaming join permissions is exceeded.', 'http_code' => 400, 'description' => '超出漫游凭证系统限额'],
['code' => 'ExternalNodeTupleAlreadyExisted', 'message' => 'The specified external node tuple already exists.', 'http_code' => 400, 'description' => '该外部节点元组已经存在'],
['code' => 'FeatureNotActivated', 'message' => 'The feature has not been activated.', 'http_code' => 400, 'description' => '功能未开通'],
['code' => 'FlowLimit', 'message' => 'The request was denied due to user flow control.', 'http_code' => 400, 'description' => '两次操作间隔不能小于4小时'],
['code' => 'ForbiddenByRam', 'message' => 'User not authorized to operate on the specified resource, or this API does not support RAM.', 'http_code' => 400, 'description' => '用户没有执行该操作所需要的RAM权限。'],
['code' => 'ForbiddenByRiskControl', 'message' => 'This operation cannot be performed because of security risks.', 'http_code' => 400, 'description' => '存在安全风险，无法执行该操作'],
['code' => 'GatewayAlreadyBoundToOthers', 'message' => 'This gateway has already been bound to another account.', 'http_code' => 400, 'description' => '网关已经绑定到其它账号'],
['code' => 'GatewayDistributeFail', 'message' => 'Failed to distribute the gateway tuple.', 'http_code' => 400, 'description' => '网关密钥分发失败。'],
['code' => 'GatewayInstanceInvalid', 'message' => 'The instance ID is invalid.', 'http_code' => 400, 'description' => '无效的实例id。'],
['code' => 'GatewayTupleAlreadyAbandoned', 'message' => 'The specified gateway tuple has been abandoned.', 'http_code' => 400, 'description' => '网关元组已经废弃'],
['code' => 'GatewayTupleOrderNotAccepted', 'message' => 'The order on gateway tuple downloading is not approved. You cannot download the gateway tuple.', 'http_code' => 400, 'description' => '网关元组工单没有审批通过，无法下载网关元组。'],
['code' => 'GwEuiDuplicated', 'message' => 'A gateway with the same gwEui already exists.', 'http_code' => 400, 'description' => 'GwEUI 已存在'],
['code' => 'IllegalOrderStateTransition', 'message' => 'The order status conversion is invalid.', 'http_code' => 400, 'description' => '工单状态转换非法'],
['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 400, 'description' => '内部错误。'],
['code' => 'InvalidCustomJoinEui', 'message' => 'The specified custom joinEui is invalid.', 'http_code' => 400, 'description' => '定制 JoinEui 非法'],
['code' => 'InvalidExternalDevEui', 'message' => 'The specified external joinEui is invalid.', 'http_code' => 400, 'description' => '外部 DevEui 非法'],
['code' => 'InvalidFreqBandPlan', 'message' => 'The frequency band plan is invalid.', 'http_code' => 400, 'description' => '频段计划不可用'],
['code' => 'InvalidName', 'message' => 'The specified name is invalid.', 'http_code' => 400, 'description' => '名称不合法'],
['code' => 'InvalidParameter', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => '入参错误'],
['code' => 'InvalidPinCode', 'message' => 'An error occurred while verifying PinCode.', 'http_code' => 400, 'description' => 'PinCode校验失败'],
['code' => 'InvalidPinCode', 'message' => 'The specified PIN code is invalid.', 'http_code' => 400, 'description' => 'PinCode 校验失败。'],
['code' => 'IotHubTripleMissing', 'message' => 'The IoT Platform trituple of this gateway does not exist.', 'http_code' => 400, 'description' => '找不到网关的物联网平台设备证书（ProductKey、DeviceName、DeviceSecret）'],
['code' => 'JoinPermissionAlreadyAuthorized', 'message' => 'The specified join permission has already been granted to another renter.', 'http_code' => 400, 'description' => '入网凭证已经授权给了其它用户'],
['code' => 'JoinPermissionAlreadyBoundNodeGroup', 'message' => 'The specified join permission has already been bound to another node group.', 'http_code' => 400, 'description' => '入网凭证已经绑定了节点组'],
['code' => 'JoinPermissionDoesNotExist', 'message' => 'The specified join permission does not exist.', 'http_code' => 400, 'description' => '入网凭证不存在'],
['code' => 'JoinPermissionEnabledFalse', 'message' => 'The join permission is disabled.', 'http_code' => 400, 'description' => '当前凭证尚未启用'],
['code' => 'JoinPermissionMulticastEnabledFalse', 'message' => 'The join permission multicast function is disabled. You cannot view the multicast information.', 'http_code' => 400, 'description' => '当前凭证组播功能未启用，无法查看组播信息。'],
['code' => 'JoinPermissionNameDuplicated', 'message' => 'The specified join permission name already exists.', 'http_code' => 400, 'description' => '入网凭证名称重复'],
['code' => 'LabGatewayDoesNotExist', 'message' => 'The specified lab gateway does not exist.', 'http_code' => 400, 'description' => '实验室网关不存在'],
['code' => 'LAN.ConfigExisted', 'message' => 'The configuration already exists.', 'http_code' => 400, 'description' => '局域网配置已存在。'],
['code' => 'LAN.ConfigNotExisted', 'message' => 'The configuration does not exist.', 'http_code' => 400, 'description' => '局域网配置不存在。'],
['code' => 'LAN.TaskProcessing', 'message' => 'Another task is in progress.', 'http_code' => 400, 'description' => '任务执行中。'],
['code' => 'MissingParameter', 'message' => 'You must specify the parameter.', 'http_code' => 400, 'description' => '未输入对应参数'],
['code' => 'MulticastGroupNotExist', 'message' => 'The specified multicast group does not exist.', 'http_code' => 400, 'description' => '组播不存在。'],
['code' => 'NodeAlreadyAdded', 'message' => 'The specified node has already been added to another node group.', 'http_code' => 400, 'description' => '节点已经添加到其他分组'],
['code' => 'NodeDoesNotExist', 'message' => 'The specified node does not exist.', 'http_code' => 400, 'description' => '节点不存在'."\n"],
['code' => 'NodeGroupAlreadyBoundJoinPermission', 'message' => 'This node group is already bound to a join permission.', 'http_code' => 400, 'description' => '节点组已经绑定入网凭证'."\n"],
['code' => 'NodeGroupAlreadyBoundMulticastGroup', 'message' => 'The specified node group has been bound to a multicast group and cannot be bound again.', 'http_code' => 400, 'description' => '当前节点组已经绑定组播，请勿重复绑定。'],
['code' => 'NodeGroupDoesNotExist', 'message' => 'The specified node group does not exist.', 'http_code' => 400, 'description' => '节点组不存在'."\n"],
['code' => 'NodeGroupNameDuplicated', 'message' => 'The specified node group name already exists.', 'http_code' => 400, 'description' => '节点组名称重复'],
['code' => 'NodeGroupNotExist', 'message' => 'The specified node group does not exist.', 'http_code' => 400, 'description' => '节点组不存在'],
['code' => 'NodeTuple.ExceedTupleLicenseLimit', 'message' => 'The key cannot be generated. The number of requests has exceeded the maximum number of tuple licenses as set out in the user agreement.', 'http_code' => 400, 'description' => '无法生成密钥，因为请求的数量超过了用户合约中的元组数量限额。'],
['code' => 'NodeTuple.KpmKeysGenerationFailed', 'message' => 'An error occurred while KPM is generating keys.', 'http_code' => 400, 'description' => 'KPM 生成密钥失败。'],
['code' => 'NodeTuple.KpmPublicKeyUnregistered', 'message' => 'The publicKey for KPM is not registered.', 'http_code' => 400, 'description' => 'KPM 所需的 publicKey 未注册。'],
['code' => 'NodeTuple.OrderNotReady', 'message' => 'You cannot obtain the node tuples while the order is being processed.', 'http_code' => 400, 'description' => '工单正在处理中，此时无法获取节点元组。'],
['code' => 'NodTupleAlreadyBoundNodeGroup', 'message' => 'The specified node tuple has been bound to a node group.', 'http_code' => 400, 'description' => '该节点元组已经绑定节点分组'],
['code' => 'NoLicense', 'message' => 'The user does not have the role license required to call this method.', 'http_code' => 400, 'description' => '用户没有调用此方法所需的角色证书。'],
['code' => 'NonExistent', 'message' => 'The specified resource does not exist.', 'http_code' => 400, 'description' => '要操作的资源不存在。'],
['code' => 'NotReadyOrEmpty', 'message' => 'No data is available, or no results have been found.', 'http_code' => 400, 'description' => '数据未准备好或查询结果为空'],
['code' => 'NotResourceOwner', 'message' => 'You are not authorized to use this resource.', 'http_code' => 400, 'description' => '无权访问此资源'],
['code' => 'NotUserDefinedNode', 'message' => 'The node type is not user definable.', 'http_code' => 400, 'description' => '非用户自定义节点类型。'],
['code' => 'QueryTimeInvalid', 'message' => 'The time interval between the start time and the end time must be an integer multiple of 10 minutes.', 'http_code' => 400, 'description' => '查询开始和结束时间间隔必须是10分钟的整数倍'],
['code' => 'RelayDevEuiDuplicated', 'message' => 'The specified Relay has been added.', 'http_code' => 400, 'description' => '该中继已经添加过'],
['code' => 'RelayNeverOnline', 'message' => 'The Relay instance has never been online.', 'http_code' => 400, 'description' => '中继需要上线'],
['code' => 'RenterDoesNotExist', 'message' => 'The specified renter does not exist.', 'http_code' => 400, 'description' => '被授权的用户不存在'],
['code' => 'RepeatSubscribe', 'message' => 'You cannot subscribe again with the same parameters.', 'http_code' => 400, 'description' => '相同参数只允许订阅一次，不允许重复订阅。'],
['code' => 'ResourceLocked', 'message' => 'The specified resource has been locked by another product.', 'http_code' => 400, 'description' => '资源被其他云产品锁定'."\n"],
['code' => 'TooManyNodesToBeAdded', 'message' => 'The maximum number of nodes added in one operation to the multicast is exceeded.', 'http_code' => 400, 'description' => '单次加入组播的节点数量过多。'],
['code' => 'TooManyNodesToBeRemoved', 'message' => 'The maximum number of nodes removed in one operation from the multicast is exceeded.', 'http_code' => 400, 'description' => '单次从组播中移除节点数量过多。'],
['code' => 'TooManyPinCodeVerificationFailures', 'message' => 'An invalid PinCode has been entered too many times. Please try again later.', 'http_code' => 400, 'description' => 'PinCode 输入错误次数过多，请稍后再试。'],
['code' => 'TooManyRenterNonExistentFailures', 'message' => 'You have entered invalid renter usernames for several times. Try again later.', 'http_code' => 400, 'description' => '被授权者账号名输入错误次数过多，请稍后再试。'],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGatewayEnablingState'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeGroupTransferFlowStats'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReturnJoinPermission'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRoamingJoinPermission'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountNotifications'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDataDispatchConfig'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGatewayOnlineRecords'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDataDispatchEnablingState'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeTupleOrders'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNotifications'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRentedJoinPermissions'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeTuplesDownloadUrl'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendUnicastCommand'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateNotificationsHandleState'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRoamingJoinPermissionEnablingState'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFreqBandPlanGroups'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountNodeTupleOrders'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGatewaysGisInfo'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountOwnedJoinPermissions'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckUserChargeStatus'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGatewayPacketStat'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGatewayTransferPackets'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOwnedLocalJoinPermission'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeGroups'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountNodeGroups'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountRentedJoinPermissions'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountNodesByNodeGroupId'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddNodeToGroup'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeGroup'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGatewayTransferFlowStats'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeTransferPacket'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteNodeGroup'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJoinPermissionAuthOrder'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RejectJoinPermissionAuthOrder'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGateway'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLocalJoinPermission'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLocalJoinPermission'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeTransferPacketsDownloadUrl'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountNodesByOwnedJoinPermissionId'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGatewayTuplesDownloadUrl'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNotification'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodesByNodeGroupId'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitGatewayTupleOrder'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AcceptJoinPermissionAuthOrder'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveNodeFromGroup'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGateway'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountGatewayTupleOrders'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGatewayTransferPacketsDownloadUrl'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListActiveGateways'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitJoinPermissionAuthOrder'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateNodeGroup'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeTransferPackets'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitNodeTupleOrder'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindJoinPermissionFromNodeGroup'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGatewayStatusStat'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeTupleOrder'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOwnedJoinPermissions'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGateway'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOwnedLocalJoinPermissionEnablingState'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFreqBandPlanGroup'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNode'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindJoinPermissionToNodeGroup'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeGroupTransferPacketsDownloadUrl'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOwnedJoinPermission'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGatewayTupleOrders'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateNodeGroup'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeTransferPacketPaths'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodesByOwnedJoinPermissionId'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CountGateways'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserLicense'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckCloudProductOpenStatus'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGatewayTupleOrder'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRentedJoinPermission'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGateway'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApplyRoamingJoinPermission'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodeGroupTransferPackets'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelJoinPermissionAuthOrder'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListActivatedFeatures'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGateways'],
],
],
];