API list

更新时间:
复制 MD 格式

This topic lists the APIs for Alibaba Cloud Link WAN.

APIDescription
GetUserLicenseQueries user contract information.
ListFreqBandPlanGroupsQueries a list of supported frequency band plan groups.
GetFreqBandPlanGroupRetrieve details of a spectrum schedule group

Gateway management APIs

APIDescription
CreateGatewayAdd Gateway
DeleteGatewayDeletes a gateway.
UpdateGatewayUpdates gateway information.
UpdateGatewayEnablingStateUpdates the enabled state of a gateway.
GetGatewayQueries gateway information.
ListGatewaysQueries a list of gateways.
CountGatewaysQueries the number of gateways that meet the specified conditions.
ListGatewaysGisInfoQueries the geographic location information of all gateways.

Network management APIs

APIDescription
CreateLocalJoinPermissionCreates a dedicated join permission.
DeleteLocalJoinPermissionDeletes a dedicated join permission.
UpdateOwnedLocalJoinPermissionUpdates information about an owned dedicated join permission.
UpdateOwnedLocalJoinPermissionEnablingStateUpdates the enabled state of an owned dedicated join permission.
GetOwnedJoinPermissionRetrieve basic information about a network onboarding credential
ListOwnedJoinPermissionsQueries a list of owned join permissions that meet the specified conditions.
CountOwnedJoinPermissionsQueries the number of owned join permissions that meet the specified conditions.
GetRentedJoinPermissionQueries basic information about a rented join permission.
ListRentedJoinPermissionsQueries a list of rented join permissions that meet the specified conditions.
CountRentedJoinPermissionsQueries the number of rented join permissions that meet the specified conditions.
ReturnJoinPermissionCertificate of Network Access Termination
SubmitJoinPermissionAuthOrderSubmits an authorization order for a join permission.
CancelJoinPermissionAuthOrderFlow for revoking enrollment credential authorization
AcceptJoinPermissionAuthOrderAccepts a join permission grant.
RejectJoinPermissionAuthOrderRejects a join permission grant.
GetJoinPermissionAuthOrderQueries the details of a join permission authorization order.

Node management APIs

APIDescription
CreateNodeGroupCreates a node group.
DeleteNodeGroupDeletes a node group.
UpdateNodeGroupUpdates information about a node group.
GetNodeGroupQueries the details of a node group.
ListNodeGroupsQueries a list of node groups that meet the specified conditions.
CountNodeGroupsQueries the number of node groups that meet the specified conditions.
BindJoinPermissionToNodeGroupAssigns a join permission to a node group.
UnbindJoinPermissionFromNodeGroupUnbinds a join permission from a node group.
UpdateDataDispatchConfigUpdates the data forwarding configuration.
UpdateDataDispatchEnablingStateEnables or disables a data forwarding destination.
AddNodeToGroupAdds a node to a node group.
RemoveNodeFromGroupRemoves a node from a node group.
GetNodeQueries node information.
ListNodesByOwnedJoinPermissionIdRetrieve the list of nodes for dedicated credentials
ListNodesByNodeGroupIdQueries a list of nodes in a node group.
CountNodesByOwnedJoinPermissionIdQueries the number of nodes that meet the specified join permission conditions.
CountNodesByNodeGroupIdQueries the number of nodes that meet the specified group conditions.

Metering and statistics APIs

APIDescription
ListGatewayTransferPacketsQueries uplink and downlink data packets of a gateway.
GetGatewayTransferPacketsDownloadUrlObtains the download URL for a CSV file that contains the uplink and downlink data of a gateway.
ListNodeGroupTransferPacketsQueries uplink and downlink data packets of a node group.
GetNodeGroupTransferPacketsDownloadUrlExport the uplink and downlink data for a node group as a CSV file.
ListNodeTransferPacketPathsQueries the details of uplink paths for a node.
GetNodeTransferPacketQueries the historical details of a data packet.
ListGatewayTransferFlowStatsQueries the traffic statistics of a gateway.
ListNodeGroupTransferFlowStatsQueries the traffic statistics of a node group.
ListGatewayOnlineRecordsQueries the online and offline records of a gateway.
ListActiveGatewaysRetrieve today's active gateways
GetGatewayStatusStatQueries the status of a gateway.
GetGatewayPacketStatQueries the number of valid data packets for a gateway.

Event notification APIs

APIDescription
GetNotificationQueries notification information.
CountNotificationsQueries the number of notifications that meet the specified conditions.
ListNotificationsQueries a list of notifications.
UpdateNotificationsHandleStateUpdate a notification's processing status

Uplink and downlink data APIs

APIDescription
SendUnicastCommandSends downlink data