Querying a Subscription
Typical Scenario
An application can subscribe to different types of device change notifications on the platform. The application can call this API to query configuration information about a subscription.
API Function
This API is used by an application to query the configuration information about a subscription by subscription ID on the platform.
API Description
1 | SubscriptionDTO querySingleSubscription(String subscriptionId, String appId, String accessToken) throws NorthApiException
|
Parameter Description
| Parameter | Mandatory or Optional | Type | Location | Description |
|---|---|---|---|---|
| subscriptionId | Mandatory | String | path | Identifies a subscription, which is obtained by calling or querying the subscription API. |
| appId | Mandatory | String | query | Identifies the application of the entity that subscribes to a device or rule. |
| accessToken | Mandatory | String | header | If the Periodically Refreshing a Token API is called, set this parameter to null. Otherwise, set this parameter to the accessToken obtained by the Authentication API. |
Response Parameters
SubscriptionDTO
| Parameter | Type | Description |
|---|---|---|
| subscriptionId | String | Identifies a subscription. |
| notifyType | String | Indicates the notification type. |
| callbackUrl | String | Indicates the callback URL of the subscription. |
Error Codes
| HTTP Status Code | Error Code | Error Description | Remarks |
|---|---|---|---|
| 403 | 1010009 | The application calls the API at a frequency that exceeds the flow control threshold. | The application calls the API at a frequency that exceeds the flow control threshold (100 calls per minute by default). Recommended handling: Contact IoT platform maintenance personnel to adjust the flow control threshold or control the API call frequency. |
| 403 | 1010005 | Invalid access token or application ID. | The access token is invalid. Recommended handling: Check whether accessToken carried in the API request is correct. |
Last Article: Subscribing to Device Management Data
Next Article: Querying Subscriptions in Batches
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.