# Alibaba Cloud Alibaba Cloud Link WAN API

> Alibaba Cloud Alibaba Cloud Link WAN API on Apizie: 80 endpoints (Accepts an authorization ticket for a dedicated join permission, Adds a new node to a node group, Applies for a roaming join permission, Calls BindJoinPermissionToNodeGroup to associate a join permission with a node group, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-linkwan`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/linkwan
- Page: https://zieapi.vercel.app/api/cloud/aliyun-linkwan
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-linkwan/openapi.json

Alibaba Cloud OpenAPI for Alibaba Cloud Link WAN (linkwan, version 2019-03-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Accepts an authorization ticket for a dedicated join permission
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/accept-join-permission-auth-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| OrderId | string | yes | The ID of the authorization ticket to accept |

### Adds a new node to a node group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/add-node-to-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| DevEui | string | yes | The DevEUI of the node |
| PinCode | string | yes | The PIN Code of the node |
| NodeGroupId | string | yes | The node group ID |

### Applies for a roaming join permission
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/apply-roaming-join-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| FreqBandPlanGroupId | integer | yes | The frequency band ID used by the roaming join permission. Valid values: 102: CN470 different frequency. 101: CN470 same frequency. 201:… |
| ClassMode | string | yes | The LoRaWAN Class mode used by the roaming join permission. Valid values: A, B, C |
| JoinPermissionName | string | yes | The name of the roaming join permission. The name can contain Chinese characters, letters, digits, and underscores (_). The name must be 4… |
| RxDelay | integer | no | The receive window delay for Class A. Valid values: 1s to 15s |
| DataRate | integer | no | The expected downlink data rate when ClassMode is set to B. Valid values: 0 to 5 |

### Calls BindJoinPermissionToNodeGroup to associate a join permission with a node group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/bind-join-permission-to-node-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| NodeGroupId | string | yes | The ID of the node group to associate |
| JoinPermissionId | string | yes | The ID of the join permission to associate |

### Cancels an authorization ticket for a dedicated join permission by calling CancelJoinPermissionAuthOrder
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/cancel-join-permission-auth-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| OrderId | string | yes | The ID of the authorization ticket to cancel |

### Checks the activation status of the Alibaba Cloud Link WAN service for the current user account. This…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/check-cloud-product-open-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| ServiceCode | string | no | The service code of the cloud service. For Alibaba Cloud Link WAN, this value is always set to "linkwan" |

### Checks the overdue payment status of a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/check-user-charge-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |

### Counts the number of gateway security key tickets submitted by the current user account. You can specify…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/count-gateway-tuple-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| States | string | no | The list of ticket statuses used to filter the count. If you do not specify this parameter, tickets in all statuses are counted. For valid… |

### Counts the number of gateways that match the specified filter conditions under the current user account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/count-gateways` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| OnlineState | string | no | Filters gateways by online or offline status. If this parameter is not specified, gateways are not filtered by online status. Valid… |
| FuzzyGwEui | string | no | Fuzzy match filter for GwEUI |
| FuzzyCity | string | no | Fuzzy match filter for city name |
| FuzzyName | string | no | Fuzzy match filter for gateway name |
| FreqBandPlanGroupId | integer | no | Filters gateways by frequency band plan group ID |
| IsEnabled | string | no | Filters gateways by enabled or disabled status. If this parameter is not specified, gateways are not filtered by enabled or disabled status |

### Counts the total number of node groups that match the specified filter conditions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/count-node-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value… |
| FuzzyName | string | no | The node group name for fuzzy matching |
| FuzzyJoinEui | string | no | The JoinEUI used by nodes in the node group for fuzzy matching |
| FuzzyDevEui | string | no | The DevEUI of nodes in the node group for fuzzy matching |

### Queries the number of node security tuple tickets submitted by the current user account. You can specify the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/count-node-tuple-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| States | string | no | The list of ticket statuses used for filtering. If you do not specify this parameter, tickets in all statuses are counted. For valid… |
| IsKpm | string | no | Specifies whether the ticket is initiated by KPM or by the security product line |

### Counts the number of nodes in a specified node group that match the filter conditions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/count-nodes-by-node-group-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| NodeGroupId | string | yes | The node group ID |
| FuzzyDevEui | string | no | The DevEUI used for fuzzy match of nodes |

### Counts the number of nodes that use a specific join permission and meet the specified filter conditions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/count-nodes-by-owned-join-permission-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| JoinPermissionId | string | yes | The join permission ID |
| FuzzyDevEui | string | no | The DevEUI used for fuzzy match of nodes |

### Counts the number of notifications that match the specified filter conditions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/count-notifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| Category | string | no | The list of notification types. Set this parameter to null to skip type filtering. Valid values: GATEWAY_OFFLINE: gateway offline… |
| HandleState | string | no | Filters notifications by processing status. Set this parameter to null to skip status filtering |
| BeginMillis | integer | no | The beginning of the time range to query. This value is a UNIX timestamp in milliseconds |
| EndMillis | integer | no | The end of the time range to query. This value is a UNIX timestamp in milliseconds |

### Counts the number of join permissions owned by the current user account that match the specified filter…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/count-owned-join-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| FuzzyRenterAliyunId | string | no | The Alibaba Cloud account ID of the join permission tenant for fuzzy matching |
| FuzzyJoinEui | string | no | The JoinEUI used by the join permission for fuzzy matching |
| Enabled | string | no | Filters join permissions by enabled or disabled status. A value of true indicates enabled. A value of false indicates disabled |
| FuzzyJoinPermissionName | string | no | The name of the join permission for fuzzy matching |

### Counts the join permissions that are rented by the current user account and match the specified filter…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/count-rented-join-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| FuzzyOwnerAliyunId | string | no | Fuzzy match of the Alibaba Cloud account ID of the join permission owner |
| FuzzyJoinEui | string | no | Fuzzy match of the JoinEUI of the join permission |
| Enabled | string | no | Filters join permissions by enabled or disabled status |
| BoundNodeGroup | string | no | Filters join permissions by whether they are associated with a node group. A value of true indicates associated. A value of false… |
| Type | string | no | Filters join permissions by type. Valid values: LOCAL: dedicated join permission ROAMING: roaming join permission |
| FuzzyJoinPermissionName | string | no | Fuzzy match of the name of the join permission |

### Registers a gateway by calling CreateGateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/create-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value… |
| GwEui | string | yes | The unique identifier of the gateway |
| PinCode | string | yes | The PinCode of the gateway, which is used to verify that the registrant owns the gateway |
| Name | string | yes | The custom gateway name. Only Chinese characters, letters, digits, and underscores (_) are supported. The name must start with a Chinese… |
| Description | string | no | The custom description of the gateway. The description can be up to 100 characters in length. A Chinese character counts as one character |
| FreqBandPlanGroupId | integer | yes | The frequency band ID of the gateway |
| CommunicationMode | string | yes | The communication mode of the gateway. Valid values: FULL_DUPLEX: full-duplex. HALF_DUPLEX: half-duplex |
| City | string | yes | The name of the city where the gateway is located |
| District | string | yes | The name of the district where the gateway is located |
| Address | string | yes | The detailed address where the gateway is located |
| GisCoordinateSystem | string | yes | The coordinate system used for the longitude and latitude of the gateway. Valid values: WGS_84 and GCJ_02 |
| Longitude | number | yes | The longitude of the gateway |
| Latitude | number | yes | The latitude of the gateway |
| AddressCode | integer | yes | The ID of the region where the gateway is located, as defined by `http://lbs.amap.com/api/javascript-api/download` |

### Creates a proprietary join permission. The current user account becomes the owner of the credential
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/create-local-join-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| FreqBandPlanGroupId | integer | yes | The frequency band ID of the frequency band used by the proprietary join permission |
| ClassMode | string | yes | The LoRaWAN Class mode used by the proprietary join permission. Valid values: A, B, and C |
| UseDefaultJoinEui | string | yes | Specifies whether the proprietary join permission uses the Alibaba Cloud unified JoinEUI |
| JoinPermissionName | string | yes | The custom name of the proprietary join permission |
| RxDelay | integer | no | The receive window delay for Class A |
| DataRate | integer | no | The data rate |
| JoinEui | string | no | The JoinEui |

### Creates a node group by calling CreateNodeGroup
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/create-node-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| NodeGroupName | string | yes | The name of the node group |
| JoinPermissionId | string | no | The ID of the join permission associated with the node group |

### Calls the DeleteGateway operation to delete a registered gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/delete-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value… |
| GwEui | string | yes | The unique identifier of the gateway |

### Deletes a proprietary join permission owned by the current user account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/delete-local-join-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| JoinPermissionId | string | yes | The ID of the proprietary join permission to delete |

### Deletes a node group by calling DeleteNodeGroup
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/delete-node-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| NodeGroupId | string | yes | The ID of the node group to delete |

### Calls GetFreqBandPlanGroup to retrieve frequency band information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-freq-band-plan-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| GroupId | integer | yes | The frequency band ID |

### Calls GetGateway to retrieve gateway information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value… |
| GwEui | string | yes | The unique identifier of the gateway |

### Call GetGatewayPacketStat to obtain the statistics on valid and invalid packets of a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-gateway-packet-stat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page of the IoT Platform console. If an ID value… |
| GwEui | string | yes | The GwEUI of the gateway to query |
| BeginMillis | integer | yes | The beginning of the time range to query. Unit: milliseconds |
| EndMillis | integer | yes | The end of the time range to query. Unit: milliseconds |

### Queries gateway status statistics, such as CPU and memory usage
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-gateway-status-stat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value… |
| GwEui | string | yes | The GwEUI of the gateway |

### The link points to a CSV file that contains statistics on uplink and downlink data packets of the gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-gateway-transfer-packets-download-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| GwEui | string | yes | The GwEUI of the gateway to query |
| DevEui | string | no | Filters data packets by DevEUI |
| Category | string | yes | The data packet category. Valid values: DOWNLINK_PACKET: downlink packet UPLINK_PACKET: uplink packet INVALID_PACKET: invalid packet |
| BeginMillis | integer | yes | The beginning of the time range to query. The value is a UNIX timestamp in milliseconds |
| EndMillis | integer | yes | The end of the time range to query. The value is a UNIX timestamp in milliseconds |
| SortingField | string | no | The sorting field. Valid values: LOG_MILLIS, which specifies sorting by time |
| Ascending | string | no | Used together with the SortingField parameter. A value of true specifies ascending order, and a value of false specifies descending order |

### Retrieves information about a gateway security key ticket. Specify a ticket ID to obtain the processing…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-gateway-tuple-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| OrderId | string | yes | The ticket ID |

### Retrieves a download link for a gateway security tuple file. After the gateway security tuple ticket is…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-gateway-tuples-download-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| OrderId | string | yes | The ticket ID |

### Retrieves the details of a dedicated join permission authorization order
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-join-permission-auth-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| OrderId | string | yes | The authorization order ID |

### Queries node information by calling GetNode
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| DevEui | string | yes | The DevEUI of the node |

### Queries node group information by calling GetNodeGroup
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-node-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the Alibaba Cloud Link WAN console. If an ID… |
| NodeGroupId | string | yes | The node group ID. You can call the https://help.aliyun.com/document_detail/109944.html operation to query the ID |

### The link points to a CSV file that contains statistics on uplink and downlink data packets for a node group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-node-group-transfer-packets-download-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value… |
| NodeGroupId | string | yes | The node group ID |
| DevEui | string | no | Filters data packets by DevEUI |
| Category | string | yes | The data packet category. Valid values: DOWNLINK_PACKET: downlink packet. UPLINK_PACKET: uplink packet |
| BeginMillis | integer | yes | The query start time. This value is a UNIX timestamp in milliseconds |
| EndMillis | integer | yes | The query end time. This value is a UNIX timestamp in milliseconds |
| SortingField | string | no | The sorting field. Valid values: LOG_MILLIS, which indicates sorting by time |
| Ascending | string | no | This parameter must be used together with the SortingField parameter. true: ascending order. false: descending order |

### Retrieves the uplink and downlink data packets of a specific node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-node-transfer-packet` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the Alibaba Cloud Link WAN console. If an ID… |
| DevEui | string | yes | The DevEUI associated with the data packet. The value is a 16-character hexadecimal string |
| Base64EncodedMacPayload | string | yes | The Base64-encoded MACPayload message. You can call the https://help.aliyun.com/document_detail/109959.html operation to query this value |
| LogMillis | integer | yes | The sending time of the data packet. You can call the https://help.aliyun.com/document_detail/109959.html operation to query this value |

### Returns a link to a CSV file that contains statistics on uplink and downlink data packets of a node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-node-transfer-packets-download-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| GwEui | string | no | Filters data packets by GwEUI |
| DevEui | string | yes | Filters data packets by DevEUI |
| Category | string | yes | The data packet category. Valid values: DOWNLINK_PACKET: downlink packet UPLINK_PACKET: uplink packet INVALID_PACKET: invalid packet |
| BeginMillis | integer | yes | The beginning of the time range to query. This value is a UNIX timestamp in milliseconds |
| EndMillis | integer | yes | The end of the time range to query. This value is a UNIX timestamp in milliseconds |
| SortingField | string | no | The field used for sorting. Valid values: LOG_MILLIS: sorts by time |
| Ascending | string | no | Specifies whether to sort in ascending order. This parameter is used together with the SortingField parameter. Valid values: true:… |

### Retrieves the information about a node security tuple ticket by ticket ID, including the processing status…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-node-tuple-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| OrderId | string | yes | The ticket ID |

### Retrieves a download link for a CSV file that contains the node security tuples issued to the user, after…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-node-tuples-download-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| OrderId | string | yes | The ticket ID |

### Retrieves notification information by calling GetNotification
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-notification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| NotificationId | string | yes | The notification ID |

### Retrieves a join permission owned by the current user account based on the join permission ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-owned-join-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| JoinPermissionId | string | yes | The ID of the join permission to retrieve |

### Retrieves a rented join permission (either a dedicated or roaming join permission) for the current user…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-rented-join-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| JoinPermissionId | string | yes | The join permission ID |

### Queries the contract information and contract execution status of the current user account on Alibaba Cloud…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/get-user-license` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |

### Lists the features available to the current user account on Alibaba Cloud Link WAN
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-activated-features` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| Environment | string | no | The current calling environment. Leave this parameter empty by default to indicate the public instance. If the environment is an IoT… |

### Queries the gateways that are active today
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-active-gateways` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |

### Calls ListFreqBandPlanGroups to retrieve the list of frequency bands
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-freq-band-plan-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |

### Queries the online and offline records of a gateway by calling ListGatewayOnlineRecords
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-gateway-online-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| GwEui | string | yes | The GwEUI of the gateway |
| OffSet | integer | yes | The offset from which the query starts. The value starts from 0 |
| Limit | integer | yes | The maximum number of records to return. The value must be greater than or equal to 1 |
| SortingField | string | no | The sorting field. Valid values: STATE_CHANGED_MILLIS: sorts records by state change time |
| Ascending | string | no | Used together with the SortingField parameter. A value of true indicates ascending order, and a value of false indicates descending order |

### Queries the traffic statistics list of a gateway by calling ListGatewayTransferFlowStats
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-gateway-transfer-flow-stats` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| GwEui | string | yes | The GwEUI of the gateway |
| BeginMillis | integer | yes | The start time of the query. The value is a UNIX timestamp in milliseconds |
| EndMillis | integer | yes | The end time of the query. The value is a UNIX timestamp in milliseconds |
| TimeIntervalUnit | string | yes | The unit of the time interval. Valid values: INTERVAL_IN_HOURS: statistics collected by hour INTERVAL_IN_DAYS: statistics collected by day |

### Invokes ListGatewayTransferPackets to retrieve the statistics information of uplink and downlink packets for…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-gateway-transfer-packets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The ID of the IoT Platform instance. Leave this parameter empty for the public instance |
| GwEui | string | yes | The GwEUI of the gateway to query |
| DevEui | string | no | The DevEUI used to filter packets |
| Category | string | yes | The packet category. Valid values: DOWNLINK_PACKET: downlink packet. UPLINK_PACKET: uplink packet. INVALID_PACKET: invalid packet |
| PageNumber | integer | yes | The page number, starting from 1 |
| PageSize | integer | yes | The page size. The value must be greater than or equal to 1 |
| BeginMillis | integer | yes | The start time of the query. The value is a UNIX timestamp in milliseconds |
| EndMillis | integer | yes | The end time of the query. The value is a UNIX timestamp in milliseconds |
| SortingField | string | no | The sorting field. Set the value to LOG_MILLIS to sort by time |
| Ascending | string | no | Specifies the sort order. Used together with the SortingField parameter. A value of true indicates ascending order. A value of false… |

### Retrieves the list of gateway tuple tickets submitted by the user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-gateway-tuple-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| State | string | no | The list of ticket states used to filter results. If you do not specify this parameter, tickets in all states are queried. Valid values:… |
| Offset | integer | yes | The start position of the query, starting from 0 |
| Limit | integer | yes | The maximum number of tickets to return in this query. The value must be greater than or equal to 1 |
| SortingField | string | no | The field used to sort the query results. Valid values: CREATED_MILLIS: sorts by ticket creation time. ACCEPTED_MILLIS: sorts by ticket… |
| Ascending | string | no | Used together with the SortingField parameter. true: ascending order. false: descending order |

### Queries the list of gateways under the current user account based on a conditional query
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-gateways` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value… |
| OnlineState | string | no | Filters gateways by online or offline status. If this parameter is not specified, no online status filter is applied. Valid values:… |
| FuzzyGwEui | string | no | The fuzzy filter for GwEUI |
| FuzzyCity | string | no | The fuzzy filter for city name |
| FuzzyName | string | no | The fuzzy filter for gateway name |
| FreqBandPlanGroupId | integer | no | The frequency band ID used to filter gateways |
| IsEnabled | string | no | Filters gateways by enabled or disabled status. If this parameter is not specified, no enabled/disabled status filter is applied. Valid… |
| Offset | integer | yes | The start position of this query, starting from 0 |
| Limit | integer | yes | The maximum number of gateways to return in this query. The maximum value is 200 and the minimum value is 1 |
| SortingField | string | no | The sorting field. Set the value to ONLINE_STATE_CHANGED_MILLIS |
| Ascending | string | no | Used together with the SortingField parameter. true: ascending order. false: descending order |

### Queries the geolocation information of all gateways under the current user account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-gateways-gis-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value is… |

### Queries the traffic statistics list of a node group by calling ListNodeGroupTransferFlowStats
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-node-group-transfer-flow-stats` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| NodeGroupId | string | yes | The node group ID |
| BeginMillis | integer | yes | The start time of the query. The value is a UNIX timestamp in milliseconds |
| EndMillis | integer | yes | The end time of the query. The value is a UNIX timestamp in milliseconds |
| TimeIntervalUnit | string | yes | The unit of the time interval. Valid values: INTERVAL_IN_HOURS: statistics collected by hour INTERVAL_IN_DAYS: statistics collected by day |

### Invokes ListNodeGroupTransferPackets to retrieve the statistics information of uplink and downlink packets…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-node-group-transfer-packets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| NodeGroupId | string | yes | The ID of the node group |
| DevEui | string | no | Filters packets by DevEUI |
| Category | string | yes | The packet category. Valid values: DOWNLINK_PACKET: downlink packet UPLINK_PACKET: uplink packet |
| PageNumber | integer | yes | The page number, starting from 1 |
| PageSize | integer | yes | The page size. The value must be greater than or equal to 1 |
| BeginMillis | integer | yes | The start time of the query. The value is a UNIX timestamp in milliseconds |
| EndMillis | integer | yes | The end time of the query. The value is a UNIX timestamp in milliseconds |
| SortingField | string | no | The sorting field. Valid values: LOG_MILLIS, which indicates sorting by time |
| Ascending | string | no | Specifies the sort order. Used together with the SortingField parameter. A value of true indicates ascending order. A value of false… |

### Queries the list of node groups under the current Alibaba Cloud account by calling ListNodeGroups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-node-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value… |
| FuzzyName | string | no | The node group name for fuzzy match |
| FuzzyJoinEui | string | no | The JoinEUI used by the node group for fuzzy match |
| FuzzyDevEui | string | no | The DevEUI of a node in the group for fuzzy match |
| Offset | integer | yes | The start position of this query, starting from 0 |
| Limit | integer | yes | The number of groups to query. Valid values: 0 to 200 |
| SortingField | string | no | The sorting field. Set the value to CREATED_MILLIS, which indicates sorting by creation time |
| Ascending | string | no | The sorting order, used together with the SortingField parameter. Valid values: true: ascending order. false: descending order |

### Retrieves the parallel paths of uplink data packets for a node by calling ListNodeTransferPacketPaths
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-node-transfer-packet-paths` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| DevEui | string | yes | Filters data packets by DevEUI |
| Base64EncodedMacPayload | string | yes | The MacPayload of the data packet. You can obtain this value from the response of the ListNodeGroupTransferPackets operation |
| LogMillis | integer | yes | The time when the data packet was received. You can obtain this value from the response of the ListNodeGroupTransferPackets operation |
| PageNumber | integer | yes | The page number, starting from 1 |
| PageSize | integer | yes | The page size. The value must be greater than or equal to 1 |

### Retrieves the statistics information on uplink and downlink data packets for a node group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-node-transfer-packets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| DevEui | string | yes | Filters data packets by DevEUI |
| Category | string | yes | The data packet category. Valid values: DOWNLINK_PACKET: downlink packet. UPLINK_PACKET: uplink packet. INVALID_PACKET: invalid packet |
| GwEui | string | no | Filters data packets by GwEUI |
| PageNumber | integer | yes | The page number. Pages start from page 1 |
| PageSize | integer | yes | The number of entries per page. The value must be greater than or equal to 1 |
| BeginMillis | integer | yes | The beginning of the time range to query. The value is a UNIX timestamp in milliseconds |
| EndMillis | integer | yes | The end of the time range to query. The value is a UNIX timestamp in milliseconds |
| SortingField | string | no | The sorting field. Set this parameter to LOG_MILLIS to sort by time |
| Ascending | string | no | Specifies the sort order. This parameter must be used together with the SortingField parameter. true: ascending order. false: descending… |

### Gets the list of node tuple orders submitted by the user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-node-tuple-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| State | string | no | Filters by order status. If this parameter is not specified, orders in all statuses are returned. For valid order status values, see the… |
| IsKpm | string | no | Specifies whether the order was initiated by KPM |
| Offset | integer | yes | The starting position of the query, starting from 0 |
| Limit | integer | yes | The maximum number of orders to return in this query. The value must be greater than or equal to 1 |
| SortingField | string | no | The field used to sort query results. Valid values: CREATED_MILLIS: Sorts by order creation time. ACCEPTED_MILLIS: Sorts by order approval… |
| Ascending | string | no | This parameter must be used together with the SortingField parameter. true: Sorts in ascending order. false: Sorts in descending order |

### Queries the list of nodes in a specified node group based on filter conditions by calling…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-nodes-by-node-group-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| NodeGroupId | string | yes | The ID of the node group |
| FuzzyDevEui | string | no | The DevEUI of the node for fuzzy matching |
| Offset | integer | yes | The start position of this query, starting from 0 |
| Limit | integer | yes | The maximum number of nodes to return in this query. The value must be greater than or equal to 1 |
| SortingField | string | no | The sorting field. Valid value: CREATED_MILLIS, which indicates sorting by creation time |
| Ascending | string | no | Used together with the SortingField parameter. A value of true indicates ascending order, and a value of false indicates descending order |

### Queries the list of nodes that use a specific join permission based on filter conditions by calling…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-nodes-by-owned-join-permission-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| JoinPermissionId | string | yes | The join permission ID |
| FuzzyDevEui | string | no | The DevEUI used to fuzzy match nodes |
| Offset | integer | yes | The offset of the query, starting from 0 |
| Limit | integer | yes | The maximum number of nodes to return in this query. The value must be greater than or equal to 1 |
| SortingField | string | no | The sorting field. Set the value to CREATED_MILLIS to sort by creation time |
| Ascending | string | no | Specifies the sort order. Used together with the SortingField parameter. Valid values: true: ascending order. false: descending order |

### Queries a list of notifications by calling ListNotifications
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-notifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| Category | string | no | The list of notification types. Set this parameter to null to return notifications of all types (JSON-encoded) |
| HandleState | string | no | Filters notifications by handling status. Set this parameter to null to return notifications of all handling statuses. HANDLED: handled.… |
| Offset | integer | yes | The start position of the query. The value must start from 0 |
| Limit | integer | yes | The maximum number of notifications to query. The value must be greater than or equal to 1 |
| BeginMillis | integer | no | The beginning of the time range to query. The value is a UNIX timestamp in milliseconds |
| EndMillis | integer | no | The end of the time range to query. The value is a UNIX timestamp in milliseconds |
| SortingField | string | no | The sorting field. Valid values: NOTICE_MILLIS (sorts by notification time) |
| Ascending | string | no | Used together with the SortingField parameter. true: ascending order. false: descending order |

### Queries the list of join permissions owned by the current user account based on filter conditions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-owned-join-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| FuzzyRenterAliyunId | string | no | The Alibaba Cloud account ID of the join permission tenant for fuzzy match |
| FuzzyJoinEui | string | no | The JoinEUI used by the join permission for fuzzy match |
| Enabled | string | no | Filters join permissions by their enabled or disabled status |
| FuzzyJoinPermissionName | string | no | The name of the join permission for fuzzy match |
| Offset | integer | yes | The start position of this query, starting from 0 |
| Limit | integer | yes | The maximum number of join permissions to return in this query. The value must be greater than or equal to 1 |
| SortingField | string | no | Specifies the sorting field. Valid values: CREATED_MILLIS: sorts by creation time |
| Ascending | string | no | Used together with the SortingField parameter. A value of true indicates ascending order, and a value of false indicates descending order |

### Queries the list of join permissions rented by the current user account. The join permissions can be…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/list-rented-join-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| FuzzyOwnerAliyunId | string | no | The Alibaba Cloud account ID of the join permission owner for fuzzy match |
| FuzzyJoinEui | string | no | The JoinEUI used by the join permission for fuzzy match |
| Enabled | string | no | Filters join permissions by enabled or disabled status. A value of true indicates enabled. A value of false indicates disabled |
| BoundNodeGroup | string | no | Filters join permissions by whether they are associated with a node group. A value of true indicates associated. A value of false… |
| Type | string | no | Filters join permissions by type. Valid values: LOCAL: dedicated join permission ROAMING: roaming join permission |
| FuzzyJoinPermissionName | string | no | The name of the join permission for fuzzy match |
| Offset | integer | yes | The offset of the query, starting from 0 |
| Limit | integer | yes | The maximum number of join permissions to return. The value must be greater than or equal to 1 |
| SortingField | string | no | The sorting field. Set the value to CREATED_MILLIS to sort by creation time |
| Ascending | string | no | Specifies the sort order when used with the SortingField parameter. A value of true indicates ascending order. A value of false indicates… |

### Rejects an authorization ticket for a dedicated join permission
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/reject-join-permission-auth-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| OrderId | string | yes | The ID of the authorization ticket to reject |

### Removes a node from a node group by calling RemoveNodeFromGroup
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/remove-node-from-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| DevEui | string | yes | The DevEUI of the node to be removed |
| NodeGroupId | string | yes | The node group ID |

### Returns a rented join permission (either a dedicated join permission or a ubiquitous join permission)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/return-join-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| JoinPermissionId | string | yes | The ID of the join permission to return |
| JoinPermissionType | string | yes | The type of the join permission to return |

### Sends a unicast command by calling SendUnicastCommand
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/send-unicast-command` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The ID of the IoT Platform instance. An empty value indicates the public instance |
| DevEui | string | yes | The target node |
| MaxRetries | integer | no | The maximum number of retries. Default value: 0 |
| CleanUp | string | no | Specifies whether to clear the queued instructions for the node and send this instruction. Default value: false |
| FPort | integer | yes | The fPort |
| Confirmed | string | no | Specifies whether the instruction is a confirmed instruction. Default value: false |
| Content | string | yes | The content to send. The value is a hexadecimal string with a maximum length of 51 bytes (102 hexadecimal characters) |

### Submits a ticket to apply for gateway keys
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/submit-gateway-tuple-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| RequiredCount | integer | yes | The number of gateway security keys to apply for |
| TupleType | string | yes | The gateway key type. Valid values: singlechannel: low-speed edition (single-channel). standard: Standard Edition. hybrid: high-speed… |

### Submits an authorization order for a dedicated join permission by calling SubmitJoinPermissionAuthOrder
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/submit-join-permission-auth-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| JoinPermissionId | string | yes | The ID of the dedicated join permission to authorize |
| RenterAliyunId | string | yes | The Alibaba Cloud account ID of the developer to authorize |

### Submits a ticket to apply for node keys
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/submit-node-tuple-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| LoraVersion | string | yes | The LoRaWAN protocol version |
| RequiredCount | integer | yes | The number of node keys to apply for |
| TupleType | string | yes | The type of key to apply for. Valid values: noncontractual: professional edition key standard: standard edition key relay: relay key |

### Dissociates a join permission from a node group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/unbind-join-permission-from-node-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| NodeGroupId | string | yes | The ID of the node group to dissociate |
| JoinPermissionId | string | yes | The ID of the join permission involved in the association |

### Updates the data forwarding configuration of a node group by calling UpdateDataDispatchConfig
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/update-data-dispatch-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| NodeGroupId | string | yes | The ID of the node group to update |
| DataDispatchDestination | string | yes | The data forwarding destination. Valid values: IOT: forwards data to an IoT product. ONS: forwards data to an MQ topic |
| ProductType | string | no | The IoT product type when the data stream destination is IoT. Valid values: IOT_SUITE: forwards data to IoT Suite Basic Edition.… |
| ProductName | string | no | The name of the IoT product when the data stream destination is IoT. This request parameter is required when the data stream destination… |
| ProductKey | string | no | The product key of the IoT product when the data stream destination is IoT. This request parameter is required when the data stream… |
| DebugSwitch | string | no | The debug switch when the data forwarding destination is IoT. The debug switch applies to custom topics on the IoT platform. Do not modify… |
| UplinkRegionName | string | no | The uplink region ID when the data forwarding destination is MQ |
| UplinkTopic | string | no | The uplink topic when the data forwarding destination is MQ |

### Enables or disables data forwarding for a node group by calling UpdateDataDispatchEnablingState
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/update-data-dispatch-enabling-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| NodeGroupId | string | yes | The node group ID |
| DataDispatchEnabled | string | yes | true: Enables data forwarding. false: Disables data forwarding |

### Updates gateway information by calling UpdateGateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/update-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| GwEui | string | yes | The unique identifier of the gateway |
| Name | string | no | The custom name of the gateway |
| Description | string | no | The custom description of the gateway |
| FreqBandPlanGroupId | integer | no | The frequency band ID of the gateway |
| CommunicationMode | string | no | The communication mode of the gateway. Valid values: FULL_DUPLEX: full-duplex. HALF_DUPLEX: half-duplex |
| AddressCode | integer | no | The ID of the region where the gateway resides, as defined by `http://lbs.amap.com/api/javascript-api/download` |
| City | string | no | The name of the city where the gateway resides |
| District | string | no | The name of the district where the gateway resides |
| Address | string | no | The detailed address where the gateway resides |
| GisCoordinateSystem | string | no | The coordinate system used for the longitude and latitude of the gateway. Valid values: WGS_84 and GCJ_02 |
| Longitude | number | no | The longitude of the gateway |
| Latitude | number | no | The latitude of the gateway |

### Calls UpdateGatewayEnablingState to start or shut down a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/update-gateway-enabling-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| GwEui | string | yes | The unique identifier of the gateway |
| Enabled | string | yes | Specifies whether to enable the gateway. Valid values: true: Enables the gateway. false: Disables the gateway |

### Updates a node group by calling UpdateNodeGroup
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/update-node-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| NodeGroupId | string | yes | The ID of the node group |
| NodeGroupName | string | no | The name of the node group |

### Updates the handling status of notifications by calling UpdateNotificationsHandleState
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/update-notifications-handle-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| NotificationId | string | yes | The list of notification IDs (JSON-encoded) |
| TargetHandleState | string | yes | The handling status to set. Valid values: HANDLED: handled. UNHANDLED: not handled |

### Updates a proprietary join permission owned by the current user account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/update-owned-local-join-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| JoinPermissionId | string | yes | The ID of the proprietary join permission to update |
| FreqBandPlanGroupId | integer | no | The ID of the frequency band used by the proprietary join permission. This parameter is used to update the existing frequency band |
| ClassMode | string | no | The LoRaWAN Class mode used by the proprietary join permission. This parameter is used to update the existing Class mode. Valid values: A,… |
| JoinPermissionName | string | no | The custom name of the join permission. This parameter is used to update the existing name |
| RxDelay | string | no | The receive window delay for Class A |
| DataRate | string | no | The data rate |
| JoinEui | string | no | The JoinEui |

### Enables or disables a dedicated join permission owned by the current user account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/update-owned-local-join-permission-enabling-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| IotInstanceId | string | no | The IotInstanceId |
| JoinPermissionId | string | yes | The ID of the dedicated join permission to operate on |
| Enabled | string | yes | Specifies whether to enable the dedicated join permission. Valid values: true: Enable the dedicated join permission. false: Disable the… |

### Updates the ubiquitous network access credential applied for by the current user account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/update-roaming-join-permission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| JoinPermissionId | string | yes | The ID of the ubiquitous network access credential to update |
| JoinPermissionName | string | no | The custom name of the network access credential, used to replace the old name |
| RxDelay | string | no | The receive window delay for Class A, in ms |
| DataRate | string | no | The data rate |

### Updates the enabling status of a ubiquitous credential
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/update-roaming-join-permission-enabling-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |
| JoinPermissionId | string | yes | The ID of the ubiquitous credential |
| Enabled | string | yes | The enabling status of the ubiquitous credential |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkwan.cn-hangzhou.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/accept-join-permission-auth-order" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Alibaba Cloud Link WAN API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-linkwan/accept-join-permission-auth-order with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Alibaba Cloud Link WAN API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Alibaba Cloud Link WAN itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Alibaba Cloud Link WAN API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-linkwan.

### What is the status of the Alibaba Cloud Alibaba Cloud Link WAN API?
Needs your own provider key (bring your own key)