Help Center/ IoT/ API Reference/ Northbound API Reference/ Subscription Management/ Querying a Subscription
Updated on 2022-02-24 GMT+08:00
View PDF
Share

Querying a Subscription

Typical Scenario

An NA can subscribe to different types of device change notifications on the IoT platform. The NA can call this API to query configuration information about a subscription.

API Function

This API is used by an NA to query the configuration information about a subscription by subscription ID on the IoT platform.

API Prototype

Method

GET

URL

https://server:port/iocm/app/sub/v1.2.0/subscriptions/{subscriptionId}?appId={appId}

Transport Protocol

HTTPS

Request Parameters

Parameter

Mandatory or Optional

Type

Location

Description

app_key

Mandatory

String

header

Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform.

Authorization

Mandatory

String

header

Indicates the authentication information for accessing the IoT platform. The value is Bearer {accessToken}, in which {accessToken} indicates the access token returned by the Authentication API.

subscriptionId

Mandatory

String(256)

path

Uniquely identifies a subscription. The value of this parameter is allocated by the IoT platform during subscription creation.

appId

Optional

String(256)

query

Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform. Set this parameter to the value of appId of the authorized application.

Response Parameters

Status Code: 200 OK

Parameter

Type

Description

subscriptionId

String

Uniquely identifies a subscription. The value of this parameter is allocated by the IoT platform during subscription creation.

notifyType

String

Indicates the notification type.

callbackUrl

String

Indicates the callback URL of the subscription.

Request Example

Method: GET
request: https://server:port/iocm/app/sub/v1.2.0/subscriptions/{subscriptionId}?appId={appId}
Header:
app_key: ******
Authorization: Bearer *****
Content-Type: application/json

Response Example

Response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
  "subscriptionId": "*******",
  "notifyType": "*******",
  "callbackUrl": "*******"
}

Error Codes

HTTP Status Code

Error Code

Error Description

Remarks

403

1010009

app throttle exceed.

The NA 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

App_key or access_token is invalid.

The access token is invalid.

Recommended handling: Check whether accessToken carried in the API request is correct.
Parent topic: Subscription Management