Help Center> IoT Device Access> SDK Reference> Old SDKs> Application Python SDK API Reference> Subscription Management> Querying Subscriptions in Batches
View PDF

Querying Subscriptions in Batches

Typical Scenario

An application can subscribe to different types of device change notifications on the platform. The application can call this API to query all subscription configurations of the current application or of a specified subscription type.

API Function

This API is used to query all subscription information of the current application or of a specified subscription type.

API Description

1
 
def queryBatchSubscriptions(self, qbsInDTO, accessToken)

Parameter Description

Parameter

Mandatory or Optional

Type

Location

Description

qbsInDTO

Mandatory

QueryBatchSubInDTO

query

For details, see QueryBatchSubInDTO structure.

accessToken

Mandatory

String

header

This parameter is set to the value of the accessToken obtained by calling the Authentication API.

QueryBatchSubInDTO structure

Parameter

Mandatory or Optional

Type

Location

Description

appId

Optional

String(256)

query

Identifies the application of the entity that subscribes to a device or rule.

notifyType

Optional

String(256)

query

Indicates the notification type based on which an application can process messages.

  • bindDevice: device bound
  • deviceAdded: device added
  • deviceInfoChanged: device information changed
  • deviceDataChanged: device data changed
  • deviceDatasChanged: batch device data changed
  • deviceCapabilitiesChanged: device service capability changed
  • deviceCapabilitiesAdded: device service capability added
  • deviceCapabilitiesDeleted: device service capability deleted
  • deviceDeleted: device deleted
  • messageConfirm: message confirmed
  • commandRsp: command response
  • deviceDesiredPropertiesModifyStatusChanged: device shadow modification status changed
  • swUpgradeStateChangeNotify: software upgrade status changed
  • swUpgradeResultNotify: software upgrade result
  • fwUpgradeStateChangeNotify: firmware upgrade status changed
  • fwUpgradeResultNotify: firmware upgrade result

pageNo

Optional

Integer

query

Indicates the page number.

  • If the value is null, pagination query is not performed.
  • If the value is an integer greater than or equal to 0, pagination query is performed.
  • If the value is 0, the first page is queried.

pageSize

Optional

Integer

query

Indicates the page size. The value is an integer greater than or equal to 1. The default value is 10.

Response Parameters

QueryBatchSubOutDTO

Parameter

Type

Description

totalCount

long

Indicates the total number of records.

pageNo

long

Indicates the page number.

pageSize

long

Indicates the number of records on each page.

subscriptions

List<SubscriptionDTO>

Indicates the subscription information list. For details, see SubscriptionDTO structure.

SubscriptionDTO structure

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

400

100224

The number of resources exceeds 1000. Narrow down the filter criteria.

The number of resources exceeds 1000.

Recommended handling: Narrow down the filter criteria.

403

100217

The application has not been authorized.

The application has not been authorized.

Recommended handling: In scenarios where applications are not authorized, ensure that request parameter appId is null.

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.
Parent topic: Subscription Management