'1.0',
'info' => [
'style' => 'RPC',
'product' => 'LinkWAN',
'version' => '2019-03-01',
],
'directories' => [
[
'id' => 74414,
'title' => null,
'type' => 'directory',
'children' => [
'CreateGateway',
'DeleteGateway',
'UpdateGateway',
'CountGateways',
'GetGateway',
'GetGatewayStatusStat',
'ListGateways',
],
],
[
'id' => 74422,
'title' => null,
'type' => 'directory',
'children' => [
'CreateNodeGroup',
'DeleteNodeGroup',
'UpdateNodeGroup',
'CountNodeGroups',
'GetNodeGroup',
'ListNodeGroups',
],
],
[
'id' => 0,
'title' => 'Others',
'type' => 'directory',
'children' => [
'AcceptJoinPermissionAuthOrder',
'AddNodeToGroup',
'BindJoinPermissionToNodeGroup',
'ApplyRoamingJoinPermission',
'CancelJoinPermissionAuthOrder',
'CheckCloudProductOpenStatus',
'CheckUserChargeStatus',
'CountGatewayTupleOrders',
'CountNodeTupleOrders',
'CountNodesByNodeGroupId',
'CountNodesByOwnedJoinPermissionId',
'CountNotifications',
'CountOwnedJoinPermissions',
'CountRentedJoinPermissions',
'CreateLocalJoinPermission',
'DeleteLocalJoinPermission',
'GetFreqBandPlanGroup',
'GetGatewayPacketStat',
'GetGatewayTransferPacketsDownloadUrl',
'GetGatewayTupleOrder',
'GetGatewayTuplesDownloadUrl',
'GetJoinPermissionAuthOrder',
'GetNode',
'GetNodeGroupTransferPacketsDownloadUrl',
'GetNodeTransferPacket',
'GetNodeTransferPacketsDownloadUrl',
'GetNodeTupleOrder',
'GetNodeTuplesDownloadUrl',
'GetNotification',
'GetOwnedJoinPermission',
'GetRentedJoinPermission',
'GetUserLicense',
'ListActivatedFeatures',
'ListActiveGateways',
'ListFreqBandPlanGroups',
'ListGatewayOnlineRecords',
'ListGatewayTransferFlowStats',
'ListGatewayTransferPackets',
'ListGatewayTupleOrders',
'ListGatewaysGisInfo',
'ListNodeGroupTransferFlowStats',
'ListNodeGroupTransferPackets',
'ListNodeTransferPacketPaths',
'ListNodeTransferPackets',
'ListNodeTupleOrders',
'ListNodesByNodeGroupId',
'ListNodesByOwnedJoinPermissionId',
'ListNotifications',
'ListOwnedJoinPermissions',
'ListRentedJoinPermissions',
'RejectJoinPermissionAuthOrder',
'RemoveNodeFromGroup',
'ReturnJoinPermission',
'SendUnicastCommand',
'SubmitGatewayTupleOrder',
'SubmitJoinPermissionAuthOrder',
'SubmitNodeTupleOrder',
'UnbindJoinPermissionFromNodeGroup',
'UpdateDataDispatchConfig',
'UpdateDataDispatchEnablingState',
'UpdateGatewayEnablingState',
'UpdateNotificationsHandleState',
'UpdateOwnedLocalJoinPermission',
'UpdateOwnedLocalJoinPermissionEnablingState',
'UpdateRoamingJoinPermission',
'UpdateRoamingJoinPermissionEnablingState',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'CreateGateway' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'required' => true,
'example' => '000000',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'vmee',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'my gateway',
],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '123',
],
],
[
'name' => 'CommunicationMode',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'GwEuiDuplicated',
'errorMessage' => 'A gateway with the same gwEui already exists.',
],
[
'errorCode' => 'GatewayTupleAlreadyAbandoned',
'errorMessage' => 'The specified gateway tuple has been abandoned.',
],
[
'errorCode' => 'IotHubTripleMissing',
'errorMessage' => 'The IoT Platform trituple of this gateway does not exist.',
],
[
'errorCode' => 'InvalidPinCode',
'errorMessage' => 'An error occurred while verifying PinCode.',
],
[
'errorCode' => 'GatewayAlreadyBoundToOthers',
'errorMessage' => 'This gateway has already been bound to another account.',
],
[
'errorCode' => 'ExceedGatewayLimit',
'errorMessage' => 'The maximum number of gateways is exceeded.',
],
[
'errorCode' => 'InvalidFreqBandPlan',
'errorMessage' => 'The frequency band plan is invalid.',
],
[
'errorCode' => 'InvalidName',
'errorMessage' => 'The specified name is invalid.',
],
[
'errorCode' => 'GatewayInstanceInvalid',
'errorMessage' => 'The instance ID is invalid.',
],
[
'errorCode' => 'GatewayDistributeFail',
'errorMessage' => 'Failed to distribute the gateway tuple.',
],
],
],
'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":""}]',
'title' => 'CreateGateway',
],
'DeleteGateway' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'GatewayDistributeFail',
'errorMessage' => 'Failed to distribute the gateway tuple.',
],
],
],
'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":""}]',
'title' => 'DeleteGateway',
],
'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' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
],
[
'name' => 'CommunicationMode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'HALF_DUPLEX',
'enum' => [
'HALF_DUPLEX',
'FULL_DUPLEX',
],
],
],
[
'name' => 'AddressCode',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'InvalidName',
'errorMessage' => 'The specified name is invalid.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateGateway',
],
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'ONLINE',
'enum' => [
'ONLINE',
'OFFLINE',
],
],
],
[
'name' => 'FuzzyGwEui',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
],
[
'name' => 'IsEnabled',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CountGateways',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetGateway' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'ChargeStatus' => [
'description' => '',
'type' => 'string',
'example' => 'NORMAL',
],
'ClassBSupported' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'FreqBandPlanGroupId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
'District' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'GisCoordinateSystem' => [
'description' => '',
'type' => 'string',
'example' => 'GCJ_02',
],
'City' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'TimeCorrectable' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'OnlineState' => [
'description' => '',
'type' => 'string',
'example' => 'ONLINE',
],
'AuthTypes' => [
'description' => '',
'type' => 'string',
'example' => 'STANDARD',
],
'OnlineStateChangedMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'CommunicationMode' => [
'description' => '',
'type' => 'string',
'example' => 'HALF_DUPLEX',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Enabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'ClassBWorking' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Address' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Longitude' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '123.45678',
],
'EmbeddedNsId' => [
'description' => '',
'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' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"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":""}]',
'title' => 'GetGateway',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetGatewayStatusStat' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'MemoryRadio' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '42.0',
],
'OnlineHour' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '42',
],
'Enabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'TxCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'RxCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'GwEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'OnlineState' => [
'description' => '',
'type' => 'string',
'example' => 'ONLINE',
],
'CpuRadio' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '42.0',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"MemoryRadio\\": 42,\\n \\"OnlineHour\\": 42,\\n \\"Enabled\\": true,\\n \\"TxCount\\": 10,\\n \\"RxCount\\": 10,\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"OnlineState\\": \\"ONLINE\\",\\n \\"CpuRadio\\": 42\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n ONLINE\\r\\n 42.0\\r\\n 42.0\\r\\n 10\\r\\n 42\\r\\n 10\\r\\n 0000000000000000\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetGatewayStatusStat',
],
'ListGateways' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-***-v6***',
],
],
[
'name' => 'OnlineState',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'OFFLINE',
'enum' => [
'ONLINE',
'OFFLINE',
],
],
],
[
'name' => 'FuzzyGwEui',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
],
[
'name' => 'IsEnabled',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'minimum' => '0',
'example' => '0',
],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'minimum' => '1',
'example' => '2',
],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ONLINE_STATE_CHANGED_MILLIS',
'enum' => [
'ONLINE_STATE_CHANGED_MILLIS',
],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ChargeStatus' => [
'description' => '',
'type' => 'string',
'example' => 'NORMAL',
],
'ClassBSupported' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'FreqBandPlanGroupId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
'District' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'GisCoordinateSystem' => [
'description' => '',
'type' => 'string',
'example' => 'GCJ_02',
],
'City' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'TimeCorrectable' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'OnlineState' => [
'description' => '',
'type' => 'string',
'example' => 'ONLINE',
],
'AuthTypes' => [
'description' => '',
'type' => 'string',
'example' => 'STANDARD',
],
'OnlineStateChangedMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'CommunicationMode' => [
'description' => '',
'type' => 'string',
'example' => 'HALF_DUPLEX',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Enabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'ClassBWorking' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Address' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Longitude' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '123.45678',
],
'EmbeddedNsId' => [
'description' => '',
'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' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 2,\\n \\"List\\": [\\n {\\n \\"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":""}]',
'title' => 'ListGateways',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'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' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'string',
'example' => '123456',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NodeGroupNameDuplicated',
'errorMessage' => 'The specified node group name already exists.',
],
[
'errorCode' => 'NodeGroupAlreadyBoundJoinPermission',
'errorMessage' => 'This node group is already bound to a join permission.',
],
[
'errorCode' => 'JoinPermissionDoesNotExist',
'errorMessage' => 'The specified join permission does not exist.',
],
[
'errorCode' => 'JoinPermissionAlreadyBoundNodeGroup',
'errorMessage' => 'The specified join permission has already been bound to another node group.',
],
[
'errorCode' => 'InvalidName',
'errorMessage' => 'The specified name is invalid.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"123456\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 123456\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CreateNodeGroup',
],
'DeleteNodeGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123456',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'ResourceLocked',
'errorMessage' => 'The specified resource has been locked by another product.',
],
[
'errorCode' => 'NodeGroupAlreadyBoundJoinPermission',
'errorMessage' => 'This node group is already bound to a join permission.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'DeleteNodeGroup',
],
'UpdateNodeGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
[
'errorCode' => 'NodeGroupNameDuplicated',
'errorMessage' => 'The specified node group name already exists.',
],
[
'errorCode' => 'InvalidName',
'errorMessage' => 'The specified name is invalid.',
],
[
'errorCode' => 'ResourceLocked',
'errorMessage' => 'The specified resource has been locked by another product.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateNodeGroup',
],
'CountNodeGroups' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'd896e0',
],
],
[
'name' => 'FuzzyDevEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'd896e0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CountNodeGroups',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetNodeGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-0pp1n8t****',
],
],
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123456',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'RxMonthSum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'NodeGroupName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'MulticastNodeCapacity' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1000',
],
'JoinPermissionOwnerAliyunId' => [
'description' => '',
'type' => 'string',
'example' => 'some-user',
],
'MulticastEnabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'TxMonthSum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'FreqBandPlanGroupId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '102',
],
'TxDailySum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'JoinPermissionEnabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'JoinPermissionId' => [
'description' => '',
'type' => 'string',
'example' => '1234569',
],
'ClassMode' => [
'description' => '',
'type' => 'string',
'example' => 'A',
],
'NodeGroupId' => [
'description' => '',
'type' => 'string',
'example' => '123456',
],
'MulticastNodeCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'DataDispatchEnabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'MulticastGroupId' => [
'description' => '',
'type' => 'string',
'example' => '1234',
],
'RxDailySum' => [
'description' => '',
'type' => 'string',
'example' => '0',
],
'JoinEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'CreateMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'JoinPermissionType' => [
'description' => '',
'type' => 'string',
'example' => 'LOCAL',
],
'NodesCnt' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'JoinPermissionName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Locks' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LockId' => [
'description' => '',
'type' => 'string',
'example' => '123',
],
'LockType' => [
'description' => '',
'type' => 'string',
'example' => 'WRITE',
],
'CreateMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'Enabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
'DataDispatchConfig' => [
'description' => '',
'type' => 'object',
'properties' => [
'Destination' => [
'description' => '',
'type' => 'string',
'example' => 'IOT',
],
'IotProduct' => [
'description' => '',
'type' => 'object',
'properties' => [
'DebugSwitch' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'ProductKey' => [
'description' => '',
'type' => 'string',
'example' => 'HMyB*******',
],
'ProductName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'ProductType' => [
'description' => '',
'type' => 'string',
'example' => 'IOT_SUITE',
],
],
],
'OnsTopics' => [
'description' => '',
'type' => 'object',
'properties' => [
'UplinkTopic' => [
'description' => '',
'type' => 'string',
'example' => 'topic2',
],
'UplinkRegionName' => [
'description' => '',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'DownlinkRegionName' => [
'description' => '',
'type' => 'string',
'example' => 'cn-beijing',
],
'DownlinkTopic' => [
'description' => '',
'type' => 'string',
'example' => 'topic1',
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"RxMonthSum\\": 0,\\n \\"NodeGroupName\\": \\"节点分组名称\\",\\n \\"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":""}]',
'title' => 'GetNodeGroup',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListNodeGroups' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'd896e0',
],
],
[
'name' => 'FuzzyDevEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'd896e0',
],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'minimum' => '0',
'example' => '0',
],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'maximum' => '200',
'minimum' => '0',
'example' => '2',
],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => [
'CREATED_MILLIS',
],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RxMonthSum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'NodeGroupName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'JoinPermissionOwnerAliyunId' => [
'description' => '',
'type' => 'string',
'example' => 'some-user2',
],
'TxMonthSum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'FreqBandPlanGroupId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '102',
],
'TxDailySum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'JoinPermissionEnabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'JoinPermissionId' => [
'description' => '',
'type' => 'string',
'example' => '123456',
],
'ClassMode' => [
'description' => '',
'type' => 'string',
'example' => 'A',
],
'NodeGroupId' => [
'description' => '',
'type' => 'string',
'example' => '123456',
],
'DataDispatchEnabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RxDailySum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'JoinEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'CreateMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'JoinPermissionType' => [
'description' => '',
'type' => 'string',
'example' => 'LOCAL',
],
'NodesCnt' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'JoinPermissionName' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'Locks' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LockId' => [
'description' => '',
'type' => 'string',
'example' => '123',
],
'LockType' => [
'description' => '',
'type' => 'string',
'example' => 'WRITE',
],
'CreateMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'Enabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
'DataDispatchConfig' => [
'description' => '',
'type' => 'object',
'properties' => [
'Destination' => [
'description' => '',
'type' => 'string',
'example' => 'IOT',
],
'IotProduct' => [
'description' => '',
'type' => 'object',
'properties' => [
'DebugSwitch' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'ProductKey' => [
'description' => '',
'type' => 'string',
'example' => 'xxxxxxxx',
],
'ProductName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'ProductType' => [
'description' => '',
'type' => 'string',
'example' => 'IOT_SUITE',
],
],
],
'OnsTopics' => [
'description' => '',
'type' => 'object',
'properties' => [
'UplinkTopic' => [
'description' => '',
'type' => 'string',
'example' => 'topic2',
],
'UplinkRegionName' => [
'description' => '',
'type' => 'string',
'example' => 'cn-shanghai',
],
'DownlinkRegionName' => [
'description' => '',
'type' => 'string',
'example' => 'cn-beijing',
],
'DownlinkTopic' => [
'description' => '',
'type' => 'string',
'example' => 'topic1',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"RxMonthSum\\": 0,\\n \\"NodeGroupName\\": \\"节点分组名称2\\",\\n \\"JoinPermissionOwnerAliyunId\\": \\"some-user2\\",\\n \\"TxMonthSum\\": 0,\\n \\"FreqBandPlanGroupId\\": 102,\\n \\"TxDailySum\\": 0,\\n \\"JoinPermissionEnabled\\": true,\\n \\"JoinPermissionId\\": \\"123456\\",\\n \\"ClassMode\\": \\"A\\",\\n \\"NodeGroupId\\": \\"123456\\",\\n \\"DataDispatchEnabled\\": true,\\n \\"RxDailySum\\": 0,\\n \\"JoinEui\\": \\"0000000000000000\\",\\n \\"CreateMillis\\": 1514736000000,\\n \\"JoinPermissionType\\": \\"LOCAL\\",\\n \\"NodesCnt\\": 10,\\n \\"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":""}]',
'title' => 'ListNodeGroups',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AcceptJoinPermissionAuthOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'IllegalOrderStateTransition',
'errorMessage' => 'The order status conversion is invalid.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'AcceptJoinPermissionAuthOrder',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddNodeToGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0000000000000000',
],
],
[
'name' => 'PinCode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123456',
],
],
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'ExceedNodeLimit',
'errorMessage' => 'The maximum number of nodes is exceeded.',
],
[
'errorCode' => 'NodeGroupDoesNotExist',
'errorMessage' => 'The specified node group does not exist.',
],
[
'errorCode' => 'DevEuiDuplicated',
'errorMessage' => 'A node with the same devEui already exists.',
],
[
'errorCode' => 'NodeAlreadyAdded',
'errorMessage' => 'The specified node has already been added to another node group.',
],
[
'errorCode' => 'InvalidPinCode',
'errorMessage' => 'An error occurred while verifying PinCode.',
],
[
'errorCode' => 'ResourceLocked',
'errorMessage' => 'The specified resource has been locked by another product.',
],
[
'errorCode' => 'NodeDoesNotExist',
'errorMessage' => 'The specified node does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'AddNodeToGroup',
],
'BindJoinPermissionToNodeGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123456',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'JoinPermissionDoesNotExist',
'errorMessage' => 'The specified join permission does not exist.',
],
[
'errorCode' => 'JoinPermissionAlreadyBoundNodeGroup',
'errorMessage' => 'The specified join permission has already been bound to another node group.',
],
[
'errorCode' => 'NodeGroupDoesNotExist',
'errorMessage' => 'The specified node group does not exist.',
],
[
'errorCode' => 'NodeGroupAlreadyBoundJoinPermission',
'errorMessage' => 'This node group is already bound to a join permission.',
],
[
'errorCode' => 'ResourceLocked',
'errorMessage' => 'The specified resource has been locked by another product.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'BindJoinPermissionToNodeGroup',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ApplyRoamingJoinPermission' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'FreqBandPlanGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '102',
],
],
[
'name' => 'ClassMode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'A',
'enum' => [
'A',
'B',
'C',
'D2D',
],
],
],
[
'name' => 'JoinPermissionName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '',
],
],
[
'name' => 'RxDelay',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'DataRate',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '4',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'string',
'example' => '1234',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 ',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'ExceedRoamingJoinPermissionLimit',
'errorMessage' => 'The maximum number of roaming join permissions is exceeded.',
],
[
'errorCode' => 'JoinPermissionNameDuplicated',
'errorMessage' => 'The specified join permission name already exists.',
],
[
'errorCode' => 'InvalidName',
'errorMessage' => 'The specified name is invalid.',
],
[
'errorCode' => 'InvalidFreqBandPlan',
'errorMessage' => 'The frequency band plan is invalid.',
],
],
],
'responseDemo' => '[{"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":""}]',
'title' => 'ApplyRoamingJoinPermission',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CancelJoinPermissionAuthOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'IllegalOrderStateTransition',
'errorMessage' => 'The order status conversion is invalid.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CancelJoinPermissionAuthOrder',
],
'CheckCloudProductOpenStatus' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'ServiceCode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'linkwan',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 ',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 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":""}]',
'title' => 'CheckCloudProductOpenStatus',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CheckUserChargeStatus' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'string',
'example' => 'NORMAL',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 ',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"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":""}]',
'title' => 'CheckUserChargeStatus',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CountGatewayTupleOrders' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'States',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => 'APPLYING',
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '42',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 ',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 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":""}]',
'title' => 'CountGatewayTupleOrders',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CountNodeTupleOrders' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'States',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => 'ACCEPTED',
'maxItems' => 10,
],
],
[
'name' => 'IsKpm',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '42',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 ',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 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":""}]',
'title' => 'CountNodeTupleOrders',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CountNodesByNodeGroupId' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
[
'name' => 'FuzzyDevEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0000000000000000',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CountNodesByNodeGroupId',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CountNodesByOwnedJoinPermissionId' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
[
'name' => 'FuzzyDevEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0000000000000000',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CountNodesByOwnedJoinPermissionId',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CountNotifications' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'Category',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'GATEWAY_OFFLINE',
],
'required' => false,
'example' => 'GATEWAY_OFFLINE',
'maxItems' => 100,
],
],
[
'name' => 'HandleState',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'UNHANDLED',
],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1514736000000',
],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1514736000000',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 10,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 10\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CountNotifications',
],
'CountOwnedJoinPermissions' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'FuzzyRenterAliyunId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'some-user',
],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'd896e0',
],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CountOwnedJoinPermissions',
],
'CountRentedJoinPermissions' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'FuzzyOwnerAliyunId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'some-user',
],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'd896e0',
],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'BoundNodeGroup',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 100,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 100\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CountRentedJoinPermissions',
],
'CreateLocalJoinPermission' => [
'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' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '101',
],
],
[
'name' => 'ClassMode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'A',
'enum' => [
'A',
'B',
'C',
],
],
],
[
'name' => 'UseDefaultJoinEui',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => '',
'type' => 'string',
'example' => '123',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'ExceedLocalJoinPermissionLimit',
'errorMessage' => 'The maximum number of local join permissions that you can create is exceeded.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'JoinPermissionNameDuplicated',
'errorMessage' => 'The specified join permission name already exists.',
],
[
'errorCode' => 'InvalidName',
'errorMessage' => 'The specified name is invalid.',
],
[
'errorCode' => 'InvalidFreqBandPlan',
'errorMessage' => 'The frequency band plan is invalid.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"123\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 123\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'CreateLocalJoinPermission',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'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' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'JoinPermissionAlreadyAuthorized',
'errorMessage' => 'The specified join permission has already been granted to another renter.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'DeleteLocalJoinPermission',
],
'GetFreqBandPlanGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '201',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'EndFrequency' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '925',
],
'GroupId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '201',
],
'FrequencyType' => [
'description' => '',
'type' => 'string',
'example' => 'SAME_FREQUENCY',
],
'FrequencyRegionId' => [
'description' => '',
'type' => 'string',
'example' => 'CN',
],
'BeginFrequency' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '923',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"EndFrequency\\": 925,\\n \\"GroupId\\": 201,\\n \\"FrequencyType\\": \\"SAME_FREQUENCY\\",\\n \\"FrequencyRegionId\\": \\"CN\\",\\n \\"BeginFrequency\\": 923\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n 923\\r\\n 925\\r\\n CN\\r\\n 201\\r\\n SAME_FREQUENCY\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetFreqBandPlanGroup',
],
'GetGatewayPacketStat' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-***-v6***',
],
],
[
'name' => 'GwEui',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'UplinkInvalid' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'UplinkValid' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'DownlinkValid' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'DownlinkInvalid' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"UplinkInvalid\\": 0,\\n \\"UplinkValid\\": 0,\\n \\"DownlinkValid\\": 0,\\n \\"DownlinkInvalid\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetGatewayPacketStat',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetGatewayTransferPacketsDownloadUrl' => [
'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' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1514736000000',
],
],
[
'name' => 'DevEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0000000000000001',
],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'DOWNLINK_PACKET',
'enum' => [
'DOWNLINK_PACKET',
'UPLINK_PACKET',
'INVALID_PACKET',
],
],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1514736000000',
],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1514736000000',
],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'LOG_MILLIS',
'enum' => [
'LOG_MILLIS',
],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'string',
'example' => 'http://xxx.xxx.xxx/xxx.csv',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"http://xxx.xxx.xxx/xxx.csv\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n http://xxx.xxx.xxx/xxx.csv\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetGatewayTransferPacketsDownloadUrl',
],
'GetGatewayTupleOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1234',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 ',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'AcceptedMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514822400000',
],
'RequiredCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'CreatedMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'OrderState' => [
'description' => '',
'type' => 'string',
'example' => 'ACCEPTED',
],
'OrderId' => [
'description' => '',
'type' => 'string',
'example' => '1234',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\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":""}]',
'title' => 'GetGatewayTupleOrder',
'requestParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetGatewayTuplesDownloadUrl' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 ',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
[
'errorCode' => 'GatewayTupleOrderNotAccepted',
'errorMessage' => 'The order on gateway tuple downloading is not approved. You cannot download the gateway tuple.',
],
],
],
'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":""}]',
'title' => 'GetGatewayTuplesDownloadUrl',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetJoinPermissionAuthOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanceledMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'ApplyingMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'RenterAliyunId' => [
'description' => '',
'type' => 'string',
'example' => 'some_user',
],
'AcceptedMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'OwnerAliyunId' => [
'description' => '',
'type' => 'string',
'example' => 'some_user',
],
'RejectedMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'JoinPermissionId' => [
'description' => '',
'type' => 'string',
'example' => '123456',
],
'OrderState' => [
'description' => '',
'type' => 'string',
'example' => 'ACCEPTED',
],
'OrderId' => [
'description' => '',
'type' => 'string',
'example' => '123',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"CanceledMillis\\": 1514736000000,\\n \\"ApplyingMillis\\": 1514736000000,\\n \\"RenterAliyunId\\": \\"some_user\\",\\n \\"AcceptedMillis\\": 1514736000000,\\n \\"OwnerAliyunId\\": \\"some_user\\",\\n \\"RejectedMillis\\": 1514736000000,\\n \\"JoinPermissionId\\": \\"123456\\",\\n \\"OrderState\\": \\"ACCEPTED\\",\\n \\"OrderId\\": \\"123\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n 123\\r\\n 1514736000000\\r\\n 1514736000000\\r\\n 1514736000000\\r\\n some_user\\r\\n ACCEPTED\\r\\n some_user\\r\\n 123456\\r\\n 1514736000000\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetJoinPermissionAuthOrder',
],
'GetNode' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0000000000000000',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'DevAddr' => [
'description' => '',
'type' => 'string',
'example' => '12345678',
],
'LastJoinMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'DevEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'BoundMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'ClassMode' => [
'description' => '',
'type' => 'string',
'example' => 'A',
],
'AuthTypes' => [
'type' => 'string',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'STANDARD',
'index' => 200,
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"LastJoinMillis\\": 1514736000000,\\n \\"DevAddr\\": \\"12345678\\",\\n \\"DevEui\\": \\"0000000000000000\\",\\n \\"BoundMillis\\": 1514736000000,\\n \\"ClassMode\\": \\"A\\",\\n \\"AuthTypes\\": [\\n \\"STANDARD\\"\\n ]\\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":""}]',
'title' => 'GetNode',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetNodeGroupTransferPacketsDownloadUrl' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-***-v6***',
],
],
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
],
[
'name' => 'DevEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0000000000000001',
],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DOWNLINK_PACKET',
'enum' => [
'DOWNLINK_PACKET',
'UPLINK_PACKET',
'INVALID_PACKET',
],
],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1514736000000',
],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1514736000000',
],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'LOG_MILLIS',
'enum' => [
'LOG_MILLIS',
],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'string',
'example' => 'http://xxx.xxx.xxx/xxx.csv',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"http://xxx.xxx.xxx/xxx.csv\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n http://xxx.xxx.xxx/xxx.csv\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'GetNodeGroupTransferPacketsDownloadUrl',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetNodeTransferPacket' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-0pp1n8t****',
],
],
[
'name' => 'DevEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '0000000000000001',
],
],
[
'name' => 'Base64EncodedMacPayload',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'SGVsbG8hIQ==',
],
],
[
'name' => 'LogMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1514736000000',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'GwOwnerAliyunId' => [
'description' => '',
'type' => 'string',
'example' => 'XXX',
],
'LogMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'ProcessEvent' => [
'description' => '',
'type' => 'string',
'example' => 'SUCCESS',
],
'Base64EncodedMacPayload' => [
'description' => '',
'type' => 'string',
'example' => 'SGVsbG8hIQ==',
],
'FPort' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '99',
],
'Lsnr' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '-10.5',
],
'FreqBandPlanGroupId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '101',
],
'HasData' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'ClassMode' => [
'description' => '',
'type' => 'string',
'example' => 'C',
],
'MacPayloadSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
'MessageType' => [
'description' => '',
'type' => 'string',
'example' => 'JOIN_REQUEST',
],
'Datr' => [
'description' => '',
'type' => 'string',
'example' => 'SF12BW125',
],
'DevAddr' => [
'description' => '',
'type' => 'string',
'example' => '00000000',
],
'DevEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000001',
],
'GwEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'Rssi' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '-110',
],
'HasMacCommand' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Freq' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '470.3',
],
'MacCommandCIDs' => [
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'example' => '["0x01","0x02"]',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"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":""}]',
'title' => 'GetNodeTransferPacket',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetNodeTransferPacketsDownloadUrl' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0000000000000001',
],
],
[
'name' => 'DevEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '0000000000000001',
],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DOWNLINK_PACKET',
'enum' => [
'DOWNLINK_PACKET',
'UPLINK_PACKET',
'INVALID_PACKET',
],
],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1514736000000',
],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1514736000000',
],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'LOG_MILLIS',
'enum' => [
'LOG_MILLIS',
],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'string',
'example' => 'http://xxx.xxx.xxx/xxx.csv',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 ',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"http://xxx.xxx.xxx/xxx.csv\\",\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\t\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue\\nhttp://xxx.xxx.xxx/xxx.csv","errorExample":""}]',
'title' => 'GetNodeTransferPacketsDownloadUrl',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetNodeTupleOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1234',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 ',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'RequiredCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'CreatedMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'IsKpm' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'AcceptedMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514822400000',
],
'OrderId' => [
'description' => '',
'type' => 'string',
'example' => '1234',
],
'OrderState' => [
'description' => '',
'type' => 'string',
'example' => 'ACCEPTED',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\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":""}]',
'title' => 'GetNodeTupleOrder',
'requestParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetNodeTuplesDownloadUrl' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 ',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"http://xxx.xxx/xxx.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":""}]',
'title' => 'GetNodeTuplesDownloadUrl',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetNotification' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'NotificationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'NoticeMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'Category' => [
'description' => '',
'type' => 'string',
'example' => 'GATEWAY_OFFLINE',
],
'HandleState' => [
'description' => '',
'type' => 'string',
'example' => 'UNHANDLED',
],
'NotificationId' => [
'description' => '',
'type' => 'string',
'example' => '123',
],
'HandledMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000001',
],
'GatewayOfflineInfo' => [
'description' => '',
'type' => 'object',
'properties' => [
'GwEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'OfflineMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
],
],
'JoinPermissionAuthInfo' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanceledMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'ApplyingMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'JoinEui' => [
'description' => '',
'type' => 'string',
'example' => 'd896e0',
],
'RenterAliyunId' => [
'description' => '',
'type' => 'string',
'example' => 'some-user2',
],
'AcceptedMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'OwnerAliyunId' => [
'description' => '',
'type' => 'string',
'example' => 'some-user1',
],
'RejectedMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'JoinPermissionId' => [
'description' => '',
'type' => 'string',
'example' => '123',
],
'JoinPermissionName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'OrderState' => [
'description' => '',
'type' => 'string',
'example' => '123',
],
'OrderId' => [
'description' => '',
'type' => 'string',
'example' => '123',
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"NoticeMillis\\": 1514736000000,\\n \\"Category\\": \\"GATEWAY_OFFLINE\\",\\n \\"HandleState\\": \\"UNHANDLED\\",\\n \\"NotificationId\\": \\"123\\",\\n \\"HandledMillis\\": 1514736000001,\\n \\"GatewayOfflineInfo\\": {\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"OfflineMillis\\": 1514736000000\\n },\\n \\"JoinPermissionAuthInfo\\": {\\n \\"CanceledMillis\\": 1514736000000,\\n \\"ApplyingMillis\\": 1514736000000,\\n \\"JoinEui\\": \\"d896e0\\",\\n \\"RenterAliyunId\\": \\"some-user2\\",\\n \\"AcceptedMillis\\": 1514736000000,\\n \\"OwnerAliyunId\\": \\"some-user1\\",\\n \\"RejectedMillis\\": 1514736000000,\\n \\"JoinPermissionId\\": \\"123\\",\\n \\"JoinPermissionName\\": \\"凭证1\\",\\n \\"OrderState\\": \\"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":""}]',
'title' => 'GetNotification',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetOwnedJoinPermission' => [
'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' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'RxMonthSum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MulticastNodeCapacity' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1000',
],
'MulticastEnabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'TxMonthSum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'FreqBandPlanGroupId' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '123',
],
'ClassMode' => [
'description' => '',
'type' => 'string',
'example' => 'A',
],
'DataDispatchDestination' => [
'description' => '',
'type' => 'string',
'example' => 'IOT',
],
'MulticastNodeCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RxDailySum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'JoinEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'CreateMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'Enabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RxDelay' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'RenterAliyunId' => [
'description' => '',
'type' => 'string',
'example' => 'some-user',
],
'NodesCnt' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'JoinPermissionName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'AuthState' => [
'description' => '',
'type' => 'string',
'example' => 'NEW',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"RxMonthSum\\": 0,\\n \\"MulticastNodeCapacity\\": 1000,\\n \\"MulticastEnabled\\": false,\\n \\"TxMonthSum\\": 0,\\n \\"FreqBandPlanGroupId\\": 102,\\n \\"TxDailySum\\": 0,\\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":""}]',
'title' => 'GetOwnedJoinPermission',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetRentedJoinPermission' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '',
'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' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '102',
],
'TxDailySum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'DataRate' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'JoinPermissionId' => [
'description' => '',
'type' => 'string',
'example' => '123',
],
'ClassMode' => [
'description' => '',
'type' => 'string',
'example' => 'A',
],
'RxDailySum' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'JoinEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'CreateMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'Enabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RxDelay' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'BoundNodeGroupId' => [
'description' => '',
'type' => 'string',
'example' => '123',
],
'NodesCnt' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'JoinPermissionName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"Type\\": \\"LOCAL\\",\\n \\"RxMonthSum\\": 0,\\n \\"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":""}]',
'title' => 'GetRentedJoinPermission',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'RoamingJoinPermissionCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayTupleCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayTupleSingleChannelCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayFreeLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'NodeTupleFreeLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'NodeFreeLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayTupleHybridLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayTupleStandardCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayTupleFreeLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'NodeTupleRelayLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayTupleLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'LocalJoinPermissionFreeLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'NodeLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'RoamingJoinPermissionLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayTupleSingleChannelLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'LocalJoinPermissionLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'Oui' => [
'description' => '',
'type' => 'string',
'example' => '0000',
],
'RelayLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayTupleHybridCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'LocalJoinPermissionCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'NodeTupleStandardCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'NodeTupleCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayDingTalkLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayProfessionalLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayProfessionalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'RelayCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'NodeTupleStandardLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'RoamingJoinPermissionFreeLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'NodeTupleLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'NodeCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayDingTalkCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayTupleStandardLimit' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'GatewayPrePayCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'NodeTupleRelayCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"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":""}]',
'title' => 'GetUserLicense',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListActivatedFeatures' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'Environment',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'IotInstance',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 ',
],
'Data' => [
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'GATEWAY_TUPLE',
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\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":""}]',
'title' => 'ListActivatedFeatures',
'requestParamsDescription' => ' ',
'extraInfo' => ' ',
],
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ChargeStatus' => [
'description' => '',
'type' => 'string',
'example' => 'NORMAL',
],
'District' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'FreqBandPlanGroupId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
'GisCoordinateSystem' => [
'description' => '',
'type' => 'string',
'example' => 'GCJ-02',
],
'City' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'OnlineState' => [
'description' => '',
'type' => 'string',
'example' => 'ONLINE',
],
'CommunicationMode' => [
'description' => '',
'type' => 'string',
'example' => 'HALF_DUPLEX',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Address' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Longitude' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '123.45678',
],
'Latitude' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '23.45678',
],
'GwEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000123456',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'vmeixme',
],
'AddressCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": [\\n {\\n \\"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":""}]',
'title' => 'ListActiveGateways',
'description' => '****',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndFrequency' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '510',
],
'GroupId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '101',
],
'FrequencyType' => [
'description' => '',
'type' => 'string',
'example' => 'SAME_FREQUENCY',
],
'FrequencyRegionId' => [
'description' => '',
'type' => 'string',
'example' => 'CN',
],
'BeginFrequency' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '470',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": [\\n {\\n \\"EndFrequency\\": 510,\\n \\"GroupId\\": 101,\\n \\"FrequencyType\\": \\"SAME_FREQUENCY\\",\\n \\"FrequencyRegionId\\": \\"CN\\",\\n \\"BeginFrequency\\": 470\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n \\r\\n 470\\r\\n 510\\r\\n CN\\r\\n 101\\r\\n SAME_FREQUENCY\\r\\n \\r\\n \\r\\n 470\\r\\n 510\\r\\n CN\\r\\n 102\\r\\n DIFF_FREQUENCY\\r\\n \\r\\n \\r\\n 923\\r\\n 925\\r\\n CN\\r\\n 201\\r\\n SAME_FREQUENCY\\r\\n \\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListFreqBandPlanGroups',
],
'ListGatewayOnlineRecords' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'GwEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0000000000000000',
],
],
[
'name' => 'OffSet',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '0',
],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '5',
],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'STATE_CHANGED_MILLIS',
'enum' => [
'STATE_CHANGED_MILLIS',
],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '25',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StateChangedMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514737000000',
],
'OnlineState' => [
'description' => '',
'type' => 'string',
'example' => 'ONLINE',
],
'GwEui' => [
'description' => '',
'type' => 'string',
'example' => '000000000000',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 25,\\n \\"List\\": [\\n {\\n \\"StateChangedMillis\\": 1514737000000,\\n \\"OnlineState\\": \\"ONLINE\\",\\n \\"GwEui\\": \\"000000000000\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n 25\\r\\n \\r\\n \\r\\n 1514737000000\\r\\n ONLINE\\r\\n \\r\\n \\r\\n 1514737000000\\r\\n ONLINE\\r\\n \\r\\n
\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListGatewayOnlineRecords',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'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' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0000000000000000',
],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1514736000000',
],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1514737000000',
],
],
[
'name' => 'TimeIntervalUnit',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'INTERVAL_IN_HOURS',
'enum' => [
'INTERVAL_IN_HOURS',
'INTERVAL_IN_DAYS',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DownlinkCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'StatMillis' => [
'description' => '',
'type' => 'string',
'example' => '1514736000000',
],
'UplinkCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": [\\n {\\n \\"DownlinkCount\\": 10,\\n \\"StatMillis\\": \\"1514736000000\\",\\n \\"UplinkCount\\": 10\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n \\r\\n 10\\r\\n 10\\r\\n 1514736000000\\r\\n \\r\\n \\r\\n 10\\r\\n 10\\r\\n 1514736000000\\r\\n \\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListGatewayTransferFlowStats',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListGatewayTransferPackets' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iotx-oxssh****',
],
],
[
'name' => 'GwEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '0000000000000000',
],
],
[
'name' => 'DevEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0000000000000001',
],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DOWNLINK_PACKET',
'enum' => [
'DOWNLINK_PACKET',
'UPLINK_PACKET',
'INVALID_PACKET',
],
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'minimum' => '1',
'example' => '2',
],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1514736000000',
],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1514736000000',
],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'LOG_MILLIS',
'enum' => [
'LOG_MILLIS',
],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LogMillis' => [
'description' => '',
'type' => 'string',
'example' => '1514736000000',
],
'ProcessEvent' => [
'description' => '',
'type' => 'string',
'example' => 'SUCCESS',
],
'Base64EncodedMacPayload' => [
'description' => '',
'type' => 'string',
'example' => 'xxx',
],
'FPort' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '99',
],
'Lsnr' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '-10.5',
],
'HasData' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'ClassMode' => [
'description' => '',
'type' => 'string',
'example' => 'C',
],
'MacPayloadSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '15',
],
'MessageType' => [
'description' => '',
'type' => 'string',
'example' => 'JOIN_REQUEST',
],
'Datr' => [
'description' => '',
'type' => 'string',
'example' => 'SF12BW125',
],
'DevAddr' => [
'description' => '',
'type' => 'string',
'example' => '00000000',
],
'DevEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000001',
],
'NodeOwnerAliyunId' => [
'description' => '',
'type' => 'string',
'example' => '23546',
],
'GwEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'Rssi' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '-110',
],
'HasMacCommand' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Freq' => [
'description' => '',
'type' => 'string',
'example' => '470.3',
],
'MacCommandCIDs' => [
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'example' => '["0x01","0x02"]',
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"LogMillis\\": \\"1514736000000\\",\\n \\"ProcessEvent\\": \\"SUCCESS\\",\\n \\"Base64EncodedMacPayload\\": \\"xxx\\",\\n \\"FPort\\": 99,\\n \\"Lsnr\\": -10.5,\\n \\"HasData\\": true,\\n \\"ClassMode\\": \\"C\\",\\n \\"MacPayloadSize\\": 15,\\n \\"MessageType\\": \\"JOIN_REQUEST\\",\\n \\"Datr\\": \\"SF12BW125\\",\\n \\"DevAddr\\": \\"00000000\\",\\n \\"DevEui\\": \\"0000000000000001\\",\\n \\"NodeOwnerAliyunId\\": \\"23546\\",\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"Rssi\\": -110,\\n \\"HasMacCommand\\": true,\\n \\"Freq\\": \\"470.3\\",\\n \\"MacCommandCIDs\\": [\\n [\\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":""}]',
'title' => 'ListGatewayTransferPackets',
'description' => '****',
],
'ListGatewayTupleOrders' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'State',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'APPLYING',
],
'required' => false,
'example' => 'APPLYING',
'maxItems' => 100,
],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '0',
],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '10',
],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => [
'CREATED_MILLIS',
'ACCEPTED_MILLIS',
],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '42',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RequiredCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'CreatedMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'TupleType' => [
'description' => '',
'type' => 'string',
'example' => 'standard',
],
'AcceptedMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514822400000',
],
'OrderId' => [
'description' => '',
'type' => 'string',
'example' => '1234',
],
'OrderState' => [
'description' => '',
'type' => 'string',
'example' => 'ACCEPTED',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 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":""}]',
'title' => 'ListGatewayTupleOrders',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListGatewaysGisInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-***-v6***',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ChargeStatus' => [
'description' => '',
'type' => 'string',
'example' => 'NORMAL',
],
'GisSourceType' => [
'description' => '',
'type' => 'string',
'example' => 'HARDWARE',
],
'FreqBandPlanGroupId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '102',
],
'Enabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'GisCoordinateSystem' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => 'OFFLINE',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'GwEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'AuthTypes' => [
'description' => '',
'type' => 'string',
'example' => 'STANDARD',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": [\\n {\\n \\"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":""}]',
'title' => 'ListGatewaysGisInfo',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'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' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1514736000000',
],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1514737000000',
],
],
[
'name' => 'TimeIntervalUnit',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'INTERVAL_IN_HOURS',
'enum' => [
'INTERVAL_IN_HOURS',
'INTERVAL_IN_DAYS',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DownlinkCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1010',
],
'StatMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'UplinkCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": [\\n {\\n \\"DownlinkCount\\": 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":""}]',
'title' => 'ListNodeGroupTransferFlowStats',
],
'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' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
[
'name' => 'DevEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0000000000000001',
],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'UPLINK_PACKET',
'enum' => [
'DOWNLINK_PACKET',
'UPLINK_PACKET',
'INVALID_PACKET',
],
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '300',
'minimum' => '0',
'example' => '2',
],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1514736000000',
],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1514736000000',
],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'LOG_MILLIS',
'enum' => [
'LOG_MILLIS',
],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LogMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'GwOwnerAliyunId' => [
'description' => '',
'type' => 'string',
'example' => 'XXX',
],
'ProcessEvent' => [
'description' => '',
'type' => 'string',
'example' => 'DEVADDR_ILLEGAL',
],
'Base64EncodedMacPayload' => [
'description' => '',
'type' => 'string',
'example' => 'XXX',
],
'FPort' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '99',
],
'Lsnr' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '-10.5',
],
'FreqBandPlanGroupId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '101',
],
'HasData' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'FcntUp' => [
'type' => 'integer',
'format' => 'int64',
],
'ClassMode' => [
'description' => '',
'type' => 'string',
'example' => 'C',
],
'MacPayloadSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '15',
],
'MessageType' => [
'description' => '',
'type' => 'string',
'example' => 'CONFIRMED_DATA_UP',
],
'Datr' => [
'description' => '',
'type' => 'string',
'example' => 'SF12BW125',
],
'DevAddr' => [
'description' => '',
'type' => 'string',
'example' => '00000000',
],
'DevEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000001',
],
'FcntDown' => [
'type' => 'integer',
'format' => 'int64',
],
'MacCommandCIDs' => [
'type' => 'string',
'items' => [
'description' => '',
'type' => 'string',
'example' => '"0x01","0x02"',
'index' => 200,
],
],
'GwEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'Rssi' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '-110',
],
'HasMacCommand' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Freq' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '470.3',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 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 \\"ClassMode\\": \\"C\\",\\n \\"MacPayloadSize\\": 15,\\n \\"MessageType\\": \\"CONFIRMED_DATA_UP\\",\\n \\"Datr\\": \\"SF12BW125\\",\\n \\"DevAddr\\": \\"00000000\\",\\n \\"DevEui\\": \\"0000000000000001\\",\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"Rssi\\": -110,\\n \\"HasMacCommand\\": true,\\n \\"Freq\\": 470.3,\\n \\"MacCommandCIDs\\": [\\n \\"\\\\\\"0x01\\\\\\",\\\\\\"0x02\\\\\\"\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n 10\\r\\n \\r\\n \\r\\n C\\r\\n xxx\\r\\n true\\r\\n 00000000\\r\\n 15\\r\\n 99\\r\\n true\\r\\n 1514736000000\\r\\n CONFIRMED_DATA_UP\\r\\n SF12BW125\\r\\n DEVADDR_ILLEGAL\\r\\n 0000000000000001\\r\\n -10.5\\r\\n 0000000000000000\\r\\n -110\\r\\n 470.3\\r\\n xxx\\r\\n \\r\\n 0x01\\r\\n 0x02\\r\\n \\r\\n 101\\r\\n \\r\\n \\r\\n C\\r\\n xxx\\r\\n true\\r\\n 00000000\\r\\n 15\\r\\n 99\\r\\n true\\r\\n 1514736000000\\r\\n CONFIRMED_DATA_UP\\r\\n SF12BW125\\r\\n DEVADDR_ILLEGAL\\r\\n 0000000000000001\\r\\n -10.5\\r\\n 0000000000000000\\r\\n -110\\r\\n 470.3\\r\\n xxx\\r\\n \\r\\n 0x01\\r\\n 0x02\\r\\n \\r\\n 101\\r\\n \\r\\n
\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListNodeGroupTransferPackets',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'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' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0000000000000001',
],
],
[
'name' => 'Base64EncodedMacPayload',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'xxx',
],
],
[
'name' => 'LogMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '14643600000',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '300',
'minimum' => '1',
'example' => '2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BestPath' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'DevEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000001',
],
'GwEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'Lsnr' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '-10.5',
],
'Rssi' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '-110',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"BestPath\\": false,\\n \\"DevEui\\": \\"0000000000000001\\",\\n \\"GwEui\\": \\"0000000000000000\\",\\n \\"Lsnr\\": -10.5,\\n \\"Rssi\\": -110\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n 10\\r\\n \\r\\n \\r\\n 0000000000000000\\r\\n -110\\r\\n false\\r\\n 0000000000000001\\r\\n -10.5\\r\\n \\r\\n \\r\\n 0000000000000000\\r\\n -110\\r\\n false\\r\\n 0000000000000001\\r\\n -10.5\\r\\n \\r\\n
\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListNodeTransferPacketPaths',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListNodeTransferPackets' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '0000000000000001',
],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DOWNLINK_PACKET',
'enum' => [
'DOWNLINK_PACKET',
'UPLINK_PACKET',
'INVALID_PACKET',
],
],
],
[
'name' => 'GwEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0000000000000001',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '300',
'minimum' => '0',
'example' => '2',
],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1514736000000',
],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1514736000000',
],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'LOG_MILLIS',
'enum' => [
'LOG_MILLIS',
],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097 ',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LogMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'Datr' => [
'description' => '',
'type' => 'string',
'example' => 'SF12BW125',
],
'Snr' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '-10.5',
],
'DevEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000001',
],
'GwEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'ClassMode' => [
'description' => '',
'type' => 'string',
'example' => 'C',
],
'Rssi' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '-110',
],
'Freq' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'example' => '470.3',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\\\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":""}]',
'title' => 'ListNodeTransferPackets',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListNodeTupleOrders' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'State',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'APPLYING',
],
'required' => false,
'example' => 'APPLYING',
'maxItems' => 10,
],
],
[
'name' => 'IsKpm',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'minimum' => '0',
'example' => '0',
],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'minimum' => '1',
'example' => '10',
],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => [
'CREATED_MILLIS',
'ACCEPTED_MILLIS',
],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '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' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'IsKpm' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'TupleType' => [
'description' => '',
'type' => 'string',
'example' => 'noncontractual',
],
'AcceptedMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514822400000',
],
'SuccessCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'LoraVersion' => [
'description' => '',
'type' => 'string',
'example' => '1.0.2',
],
'OrderState' => [
'description' => '',
'type' => 'string',
'example' => 'ACCEPTED',
],
'OrderId' => [
'description' => '',
'type' => 'string',
'example' => '1234',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 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":""}]',
'title' => 'ListNodeTupleOrders',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'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' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
[
'name' => 'FuzzyDevEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'd896e0',
],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'minimum' => '0',
'example' => '0',
],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '200',
'minimum' => '0',
'example' => '2',
],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => [
'CREATED_MILLIS',
'LAST_JOIN_MILLIS',
],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LastJoinMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'DevAddr' => [
'description' => '',
'type' => 'string',
'example' => '12345678',
],
'MulticastGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'xxxx',
],
'DevEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'NodeType' => [
'type' => 'string',
],
'JoinEui' => [
'type' => 'string',
],
'BoundMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'ClassMode' => [
'description' => '',
'type' => 'string',
'example' => 'A',
],
'AuthTypes' => [
'type' => 'string',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'STANDARD',
'index' => 200,
],
],
'Appkey' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"DevAddr\\": \\"12345678\\",\\n \\"LastJoinMillis\\": 1514736000000,\\n \\"DevEui\\": \\"0000000000000000\\",\\n \\"MulticastGroupId\\": \\"xxxx\\",\\n \\"BoundMillis\\": 1514736000000,\\n \\"ClassMode\\": \\"A\\",\\n \\"AuthTypes\\": [\\n \\"STANDARD\\"\\n ]\\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":""}]',
'title' => 'ListNodesByNodeGroupId',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'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' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
[
'name' => 'FuzzyDevEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'd896e0',
],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'minimum' => '0',
'example' => '0',
],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '200',
'minimum' => '0',
'example' => '2',
],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => [
'CREATED_MILLIS',
'LAST_JOIN_MILLIS',
],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LastJoinMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'DevAddr' => [
'description' => '',
'type' => 'string',
'example' => '12345678',
],
'DevEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'BoundMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'ClassMode' => [
'description' => '',
'type' => 'string',
'example' => 'A',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"LastJoinMillis\\": 1514736000000,\\n \\"DevAddr\\": \\"12345678\\",\\n \\"DevEui\\": \\"0000000000000000\\",\\n \\"BoundMillis\\": 1514736000000,\\n \\"ClassMode\\": \\"A\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n 10\\r\\n \\r\\n \\r\\n A\\r\\n 1514736000000\\r\\n 1514736000000\\r\\n 0000000000000000\\r\\n 12345678\\r\\n \\r\\n \\r\\n A\\r\\n 1514736000001\\r\\n 1514736000000\\r\\n 0000000000000001\\r\\n 12345678\\r\\n \\r\\n
\\r\\n \\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ListNodesByOwnedJoinPermissionId',
],
'ListNotifications' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'Category',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'GATEWAY_OFFLINE',
],
'required' => false,
'example' => 'GATEWAY_OFFLINE',
'maxItems' => 100,
],
],
[
'name' => 'HandleState',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'HANDLED',
'enum' => [
'HANDLED',
'UNHANDLED',
],
],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'minimum' => '0',
'example' => '0',
],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'maximum' => '200',
'minimum' => '0',
'example' => '2',
],
],
[
'name' => 'BeginMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1514736000000',
],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1514736000000',
],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'NOTICE_MILLIS',
'enum' => [
'NOTICE_MILLIS',
],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'NoticeMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'Category' => [
'description' => '',
'type' => 'string',
'example' => 'GATEWAY_OFFLINE',
],
'HandleState' => [
'description' => '',
'type' => 'string',
'example' => 'HANDLED',
],
'NotificationId' => [
'description' => '',
'type' => 'string',
'example' => '123',
],
'HandledMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000001',
],
'GatewayOfflineInfo' => [
'description' => '',
'type' => 'object',
'properties' => [
'GwEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'OfflineMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
],
],
'JoinPermissionAuthInfo' => [
'description' => '',
'type' => 'object',
'properties' => [
'CanceledMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'ApplyingMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'JoinEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000001',
],
'RenterAliyunId' => [
'description' => '',
'type' => 'string',
'example' => 'some-user',
],
'AcceptedMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'OwnerAliyunId' => [
'description' => '',
'type' => 'string',
'example' => 'some-user1',
],
'RejectedMillis' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514736000000',
],
'JoinPermissionId' => [
'description' => '',
'type' => 'string',
'example' => '126',
],
'JoinPermissionName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'OrderState' => [
'description' => '',
'type' => 'string',
'example' => 'ACCEPTED',
],
'OrderId' => [
'description' => '',
'type' => 'string',
'example' => '123',
],
],
],
'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',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'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":""}]',
'title' => 'ListNotifications',
],
'ListOwnedJoinPermissions' => [
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'some-user',
],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'minimum' => '0',
'example' => '0',
],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '200',
'minimum' => '0',
'example' => '2',
],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => [
'CREATED_MILLIS',
],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'JoinEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'FreqBandPlanGroupId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '102',
],
'Enabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RxDelay' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'RenterAliyunId' => [
'description' => '',
'type' => 'string',
'example' => 'some-user1',
],
'DataRate' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '4',
],
'JoinPermissionId' => [
'description' => '',
'type' => 'string',
'example' => '102',
],
'JoinPermissionName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'ClassMode' => [
'description' => '',
'type' => 'string',
'example' => 'A',
],
'AuthState' => [
'description' => '',
'type' => 'string',
'example' => 'NEW',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"JoinEui\\": \\"0000000000000000\\",\\n \\"FreqBandPlanGroupId\\": 102,\\n \\"Enabled\\": true,\\n \\"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":""}]',
'title' => 'ListOwnedJoinPermissions',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListRentedJoinPermissions' => [
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'some-user',
],
],
[
'name' => 'FuzzyJoinEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'd896e0',
],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'BoundNodeGroup',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'LOCAL',
'enum' => [
'LOCAL',
'ROAMING',
],
],
],
[
'name' => 'FuzzyJoinPermissionName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'minimum' => '0',
'example' => '0',
],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'maximum' => '200',
'minimum' => '0',
'example' => '2',
],
],
[
'name' => 'SortingField',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CREATED_MILLIS',
'enum' => [
'CREATED_MILLIS',
],
],
],
[
'name' => 'Ascending',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => '',
'type' => 'string',
'example' => 'LOCAL',
],
'BoundNodeGroupName' => [
'description' => '',
'type' => 'string',
'example' => '123',
],
'FreqBandPlanGroupId' => [
'description' => '',
'type' => 'string',
'example' => '102',
],
'DataRate' => [
'description' => '',
'type' => 'string',
'example' => '4',
],
'JoinPermissionId' => [
'description' => '',
'type' => 'string',
'example' => '123',
],
'ClassMode' => [
'description' => '',
'type' => 'string',
'example' => 'A',
],
'JoinEui' => [
'description' => '',
'type' => 'string',
'example' => '0000000000000000',
],
'Enabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'BoundNodeGroup' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'RxDelay' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'BoundNodeGroupId' => [
'description' => '',
'type' => 'string',
'example' => '123',
],
'OwnerAliyunId' => [
'description' => '',
'type' => 'string',
'example' => 'some-user1',
],
'JoinPermissionName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'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',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"Type\\": \\"LOCAL\\",\\n \\"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 }\\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":""}]',
'title' => 'ListRentedJoinPermissions',
'description' => '****',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RejectJoinPermissionAuthOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
[
'errorCode' => 'IllegalOrderStateTransition',
'errorMessage' => 'The order status conversion is invalid.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'RejectJoinPermissionAuthOrder',
],
'RemoveNodeFromGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DevEui',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0000000000000000',
],
],
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'ResourceLocked',
'errorMessage' => 'The specified resource has been locked by another product.',
],
[
'errorCode' => 'NodeGroupDoesNotExist',
'errorMessage' => 'The specified node group does not exist.',
],
[
'errorCode' => 'NodeDoesNotExist',
'errorMessage' => 'The specified node does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'RemoveNodeFromGroup',
],
'ReturnJoinPermission' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'JoinPermissionAlreadyBoundNodeGroup',
'errorMessage' => 'The specified join permission has already been bound to another node group.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'ReturnJoinPermission',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SendUnicastCommand' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '0',
'example' => '0',
'default' => '0',
],
],
[
'name' => 'CleanUp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'Content',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'xxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'Abandoned',
'errorMessage' => 'An error occurred while processing this request, because the API has been abandoned.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'SendUnicastCommand',
],
'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' => '',
'type' => 'string',
'required' => true,
'example' => 'noncontractual',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'string',
'example' => '12345',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'ExceedGatewayTupleLimit',
'errorMessage' => 'The maximum number of gateway tuples is exceeded.',
],
],
],
'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":""}]',
'title' => 'SubmitGatewayTupleOrder',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SubmitJoinPermissionAuthOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
[
'name' => 'RenterAliyunId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'some_user',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1234',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'TooManyRenterNonExistentFailures',
'errorMessage' => 'You have entered invalid renter usernames for several times. Try again later.',
],
[
'errorCode' => 'JoinPermissionAlreadyAuthorized',
'errorMessage' => 'The specified join permission has already been granted to another renter.',
],
[
'errorCode' => 'RenterDoesNotExist',
'errorMessage' => 'The specified renter does not exist.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 1234,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1234\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'SubmitJoinPermissionAuthOrder',
],
'SubmitNodeTupleOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'LoraVersion',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'required' => true,
'example' => 'standard',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'string',
'example' => '12345',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
],
],
'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":""}]',
'title' => 'SubmitNodeTupleOrder',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UnbindJoinPermissionFromNodeGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123456',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'ResourceLocked',
'errorMessage' => 'The specified resource has been locked by another product.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UnbindJoinPermissionFromNodeGroup',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateDataDispatchConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
[
'name' => 'DataDispatchDestination',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'IOT',
'enum' => [
'IOT',
'MQ',
],
],
],
[
'name' => 'ProductType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'IOT_SUITE',
'enum' => [
'IOT_SUITE',
'IOT_SUITE_SENIOR',
],
],
],
[
'name' => 'ProductName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'xxxxxxxx',
],
],
[
'name' => 'DebugSwitch',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'UplinkRegionName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-beijing',
],
],
[
'name' => 'UplinkTopic',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-shanghai',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'ResourceLocked',
'errorMessage' => 'The specified resource has been locked by another product.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateDataDispatchConfig',
'requestParamsDescription' => "\n",
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateDataDispatchEnablingState' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'NodeGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
[
'name' => 'DataDispatchEnabled',
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'ResourceLocked',
'errorMessage' => 'The specified resource has been locked by another product.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateDataDispatchEnablingState',
],
'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' => '',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateGatewayEnablingState',
],
'UpdateNotificationsHandleState' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'NotificationId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
'required' => true,
'example' => '1',
'maxItems' => 100,
],
],
[
'name' => 'TargetHandleState',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateNotificationsHandleState',
],
'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' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
[
'name' => 'FreqBandPlanGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '201',
],
],
[
'name' => 'ClassMode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'A',
'enum' => [
'A',
'B',
'C',
],
],
],
[
'name' => 'JoinPermissionName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'RxDelay',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'JoinPermissionAlreadyAuthorized',
'errorMessage' => 'The specified join permission has already been granted to another renter.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
[
'errorCode' => 'JoinPermissionNameDuplicated',
'errorMessage' => 'The specified join permission name already exists.',
],
[
'errorCode' => 'InvalidName',
'errorMessage' => 'The specified name is invalid.',
],
[
'errorCode' => 'InvalidFreqBandPlan',
'errorMessage' => 'The frequency band plan is invalid.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateOwnedLocalJoinPermission',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateOwnedLocalJoinPermissionEnablingState' => [
'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' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123',
],
],
[
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 89EF6CAA-958F-F32C-BE45-FE003C6DE097\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateOwnedLocalJoinPermissionEnablingState',
],
'UpdateRoamingJoinPermission' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '123',
],
],
[
'name' => 'JoinPermissionName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'RxDelay',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'JoinPermissionAlreadyBoundNodeGroup',
'errorMessage' => 'The specified join permission has already been bound to another node group.',
],
[
'errorCode' => 'JoinPermissionNameDuplicated',
'errorMessage' => 'The specified join permission name already exists.',
],
[
'errorCode' => 'InvalidName',
'errorMessage' => 'The specified name is invalid.',
],
],
],
'responseDemo' => '[{"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":""}]',
'title' => 'UpdateRoamingJoinPermission',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateRoamingJoinPermissionEnablingState' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'JoinPermissionId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '89EF6CAA-958F-F32C-BE45-FE003C6DE097',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ForbiddenByRam',
'errorMessage' => 'User not authorized to operate on the specified resource, or this API does not support RAM.',
],
[
'errorCode' => 'ForbiddenByRiskControl',
'errorMessage' => 'This operation cannot be performed because of security risks.',
],
[
'errorCode' => 'NonExistent',
'errorMessage' => 'The specified resource does not exist.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
],
[
'errorCode' => 'CloudProductNotActivated',
'errorMessage' => 'The Link WAN service has not been activated.',
],
[
'errorCode' => 'FeatureNotActivated',
'errorMessage' => 'The feature has not been activated.',
],
[
'errorCode' => 'NotResourceOwner',
'errorMessage' => 'You are not authorized to use this resource.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\"\\n}","errorExample":""},{"type":"xml","example":"89EF6CAA-958F-F32C-BE45-FE003C6DE097\\ntrue","errorExample":""}]',
'title' => 'UpdateRoamingJoinPermissionEnablingState',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
],
'endpoints' => [
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'linkwan.cn-hangzhou.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'linkwan.cn-shanghai.aliyuncs.com',
],
],
];