调用ListNodeGroups查询当前用户账号的符合过滤条件的节点分组列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListNodeGroups

系统规定参数。取值:ListNodeGroups

Limit Long 2

本次查询的分组数量上限,大于等于1。

Offset Long 0

本次查询的起始位置,从0开始。

Ascending Boolean true

配合SortingField参数一起使用,true表示升序,false表示降序。

FuzzyDevEui String d896e0

模糊匹配分组中的节点DevEUI。

FuzzyJoinEui String d896e0

模糊匹配节点分组所使用的JoinEUI。

FuzzyName String test

模糊匹配节点分组名称。

SortingField String CREATED_MILLIS

指定排序字段,可取值为CREATED_MILLIS, 表示根据创建时间排序。

返回数据

名称 类型 示例值 描述
Data

返回的结果。

List

满足过滤条件的节点分组列表。

ClassMode String A

节点分组中的节点所采用的LoRaWAN Class模式,与分组所关联的入网凭证中指定的一致。

CreateMillis Long 1514736000000

节点分组的创建时间,格式为UNIX时间戳,以毫秒为单位。

DataDispatchConfig

节点分组的数据流转配置。

Destination String IOT

数据流转目的地。取值:

  • IOT:数据流转到IoT的产品。
  • ONS:数据流转到MQ的Topic。
IotProduct

如果流转目的地是IoT产品,该字段存储产品信息。

ProductKey String xxxxxxxx

产品Product Key。

ProductName String 产品名

产品名。

ProductType String IOT_SUITE

产品类型。

OnsTopics

如果流转目的地是MQ,该字段存储MQ Topic信息。

DownlinkRegionName String cn-beijing

MQ 下行 Region Id。

DownlinkTopic String topic1

MQ 下行 Topic。

UplinkRegionName String cn-shanghai

MQ 上行 Region Id。

UplinkTopic String topic2

MQ 上行 Topic。

DataDispatchEnabled Boolean true

节点分组的数据流转启停状态,true表示启用,false表示停用。

FreqBandPlanGroupId Long 102

节点分组中的节点所采用的频段的频段ID,与分组所关联的入网凭证中指定的一致。

JoinEui String 0000000000000000

节点分组中的节点所使用的JoinEUI,与分组所关联的入网凭证中指定的JoinEUI一致。

JoinPermissionEnabled Boolean true

与节点分组关联的入网凭证的启停状态,true表示启用,false表示停用。

JoinPermissionId String 123456

与节点分组关联的入网凭证的ID。

JoinPermissionOwnerAliyunId String some-user2
  • 如果关联的是专用入网凭证,该字段表示入网凭证的拥有者的阿里云账号ID。
  • 如果关联的是泛在入网凭证,该字段的值恒为AliCloud IoT。
JoinPermissionType String LOCAL

与节点分组关联的入网凭证类型。取值:

  • LOCAL:专用凭证
  • ROAMING:泛在凭证
Locks

节点分组所关联的操作锁列表。

CreateMillis Long 1514736000000

锁的创建时间。

Enabled Boolean true

锁的启停用状态。

LockId String 123

锁ID。

LockType String WRITE

锁的类型。取值:WRITE,所有写操作都加锁,包括编辑、删除等。

NodeGroupId String 123456

节点分组ID。

NodeGroupName String 节点分组名称2

节点分组的名称。

NodesCnt Long 10

节点分组中的节点数量。

RxDailySum Long 0

与节点分组关联的入网凭证的当天上行数据包量。

RxMonthSum Long 0

与节点分组关联的入网凭证的当月上行数据包量。

TxDailySum Long 0

与节点分组关联的入网凭证的当天下行数据包量。

TxMonthSum Long 0

与节点分组关联的入网凭证的当月下行数据包量。

TotalCount Long 10

满足过滤条件的节点分组总数。

RequestId String 89EF6CAA-958F-F32C-BE45-FE003C6DE097

请求ID。

Success Boolean true

是否成功。

示例

请求示例


http(s)://linkwan.cn-shanghai.aliyuncs.com/?Action=ListNodeGroups
&Limit=2
&Offset=0
&<公共请求参数>

正常返回示例

XML 格式

<ListNodeGroupsResponse>
        <Data>
                <TotalCount>10</TotalCount>
                <List>
                        <NodeGroup>
                                <NodesCnt>10</NodesCnt>
                                <JoinEui>0000000000000000</JoinEui>
                                <JoinPermissionOwnerAliyunId>some-user2</JoinPermissionOwnerAliyunId>
                                <RxDailySum>0</RxDailySum>
                                <JoinPermissionType>LOCAL</JoinPermissionType>
                                <ClassMode>A</ClassMode>
                                <NodeGroupId>123456</NodeGroupId>
                                <DataDispatchEnabled>true</DataDispatchEnabled>
                                <Locks>
                                        <Lock>
                                                <LockId>123</LockId>
                                                <CreateMillis>1514736000000</CreateMillis>
                                                <Enabled>true</Enabled>
                                                <LockType>WRITE</LockType>
                                        </Lock>
                                        <Lock>
                                                <LockId>126</LockId>
                                                <CreateMillis>1514736000000</CreateMillis>
                                                <Enabled>true</Enabled>
                                                <LockType>WRITE</LockType>
                                        </Lock>
                                </Locks>
                                <JoinPermissionEnabled>true</JoinPermissionEnabled>
                                <TxDailySum>0</TxDailySum>
                                <TxMonthSum>0</TxMonthSum>
                                <DataDispatchConfig>
                                        <Destination>IOT</Destination>
                                        <IotProduct>
                                                <ProductKey>xxxxxxxx</ProductKey>
                                                <ProductType>IOT_SUITE</ProductType>
                                                <ProductName>产品名</ProductName>
                                        </IotProduct>
                                </DataDispatchConfig>
                                <CreateMillis>1514736000000</CreateMillis>
                                <NodeGroupName>节点分组名称2</NodeGroupName>
                                <RxMonthSum>0</RxMonthSum>
                                <JoinPermissionId>123456</JoinPermissionId>
                                <FreqBandPlanGroupId>102</FreqBandPlanGroupId>
                        </NodeGroup>
                        <NodeGroup>
                                <NodesCnt>10</NodesCnt>
                                <JoinEui>0000000000000001</JoinEui>
                                <JoinPermissionOwnerAliyunId>some-user2</JoinPermissionOwnerAliyunId>
                                <RxDailySum>0</RxDailySum>
                                <JoinPermissionType>LOCAL</JoinPermissionType>
                                <ClassMode>A</ClassMode>
                                <NodeGroupId>1234569</NodeGroupId>
                                <DataDispatchEnabled>true</DataDispatchEnabled>
                                <Locks>
                                        <Lock>
                                                <LockId>123</LockId>
                                                <LockSmithPlatformSource>LP</LockSmithPlatformSource>
                                                <Enabled>true</Enabled>
                                                <LockSmith>nmsUser1</LockSmith>
                                                <CreateMillis>1514736000000</CreateMillis>
                                                <LockType>WRITE</LockType>
                                        </Lock>
                                        <Lock>
                                                <LockId>126</LockId>
                                                <LockSmithPlatformSource>LP</LockSmithPlatformSource>
                                                <Enabled>true</Enabled>
                                                <LockSmith>nmsUser1</LockSmith>
                                                <CreateMillis>1514736000000</CreateMillis>
                                                <LockType>WRITE</LockType>
                                        </Lock>
                                </Locks>
                                <JoinPermissionEnabled>true</JoinPermissionEnabled>
                                <TxDailySum>0</TxDailySum>
                                <TxMonthSum>0</TxMonthSum>
                                <DataDispatchConfig>
                                        <Destination>IOT</Destination>
                                        <IotProduct>
                                                <ProductKey>xxxxxxxx</ProductKey>
                                                <ProductType>IOT_SUITE</ProductType>
                                                <ProductName>产品名</ProductName>
                                        </IotProduct>
                                </DataDispatchConfig>
                                <CreateMillis>1514736000000</CreateMillis>
                                <NodeGroupName>节点分组名称2</NodeGroupName>
                                <RxMonthSum>0</RxMonthSum>
                                <JoinPermissionId>1234569</JoinPermissionId>
                                <FreqBandPlanGroupId>102</FreqBandPlanGroupId>
                        </NodeGroup>
                </List>
        </Data>
        <RequestId>89EF6CAA-958F-F32C-BE45-FE003C6DE097</RequestId>
        <Success>true</Success>
</ListNodeGroupsResponse>

JSON 格式

{
	"Data":{
		"TotalCount":10,
		"List":[
			{
				"DataDispatchConfig":{
					"IotProduct":{
						"ProductKey":"xxxxxxxx",
						"ProductType":"IOT_SUITE",
						"ProductName":"产品名"
					},
					"Destination":"IOT"
				},
				"NodeGroupId":"123456",
				"NodesCnt":10,
				"Locks":[
					{
						"LockId":"123",
						"Enabled":true,
						"CreateMillis":1514736000000,
						"LockType":"WRITE"
					},
					{
						"LockId":"126",
						"Enabled":true,
						"CreateMillis":1514736000000,
						"LockType":"WRITE"
					}
				],
				"RxDailySum":0,
				"JoinEui":"0000000000000000",
				"ClassMode":"A",
				"JoinPermissionEnabled":true,
				"JoinPermissionOwnerAliyunId":"some-user2",
				"JoinPermissionId":"123456",
				"JoinPermissionType":"LOCAL",
				"DataDispatchEnabled":true,
				"FreqBandPlanGroupId":102,
				"NodeGroupName":"节点分组名称2",
				"TxDailySum":0,
				"TxMonthSum":0,
				"CreateMillis":1514736000000,
				"RxMonthSum":0
			},
			{
				"DataDispatchConfig":{
					"IotProduct":{
						"ProductKey":"xxxxxxxx",
						"ProductType":"IOT_SUITE",
						"ProductName":"产品名"
					},
					"Destination":"IOT"
				},
				"NodeGroupId":"1234569",
				"NodesCnt":10,
				"Locks":[
					{
						"LockId":"123",
						"Enabled":true,
						"LockSmithPlatformSource":"LP",
						"LockSmith":"nmsUser1",
						"CreateMillis":1514736000000,
						"LockType":"WRITE"
					},
					{
						"LockId":"126",
						"Enabled":true,
						"LockSmithPlatformSource":"LP",
						"LockSmith":"nmsUser1",
						"CreateMillis":1514736000000,
						"LockType":"WRITE"
					}
				],
				"RxDailySum":0,
				"JoinEui":"0000000000000001",
				"ClassMode":"A",
				"JoinPermissionEnabled":true,
				"JoinPermissionOwnerAliyunId":"some-user2",
				"JoinPermissionId":"1234569",
				"JoinPermissionType":"LOCAL",
				"DataDispatchEnabled":true,
				"FreqBandPlanGroupId":102,
				"NodeGroupName":"节点分组名称2",
				"TxDailySum":0,
				"TxMonthSum":0,
				"CreateMillis":1514736000000,
				"RxMonthSum":0
			}
		]
	},
	"RequestId":"89EF6CAA-958F-F32C-BE45-FE003C6DE097",
	"Success":true
}

错误码

HttpCode 错误码 错误信息 描述
400 ForbiddenByRam User not authorized to operate on the specified resource, or this API does not support RAM. 用户没有执行该操作所需要的RAM权限。
400 ForbiddenByRiskControl This operation cannot be performed because of security risks. 存在安全风险,无法执行该操作
400 InternalError The request processing has failed due to some unknown error, exception or failure. 内部错误。
400 CloudProductNotActivated The Link WAN service has not been activated. 未开通 Link WAN 云产品
400 FeatureNotActivated The feature has not been activated. 功能未开通

访问错误中心查看更多错误码。