IoTIoT

Compute
Elastic Cloud Server
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
Domain Name Service
VPC Endpoint
Cloud Connect
Enterprise Switch
Security & Compliance
Anti-DDoS
Web Application Firewall
Host Security Service
Data Encryption Workshop
Database Security Service
Advanced Anti-DDoS
Data Security Center
Container Guard Service
Situation Awareness
Managed Threat Detection
Compass
Cloud Certificate Manager
Anti-DDoS Service
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GaussDB NoSQL
GaussDB(for MySQL)
Distributed Database Middleware
GaussDB(for openGauss)
Developer Services
ServiceStage
Distributed Cache Service
Simple Message Notification
Application Performance Management
Application Operations Management
Blockchain Service
API Gateway
Cloud Performance Test Service
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
DevCloud
ProjectMan
CodeHub
CloudRelease
CloudPipeline
CloudBuild
CloudDeploy
Cloud Communications
Message & SMS
Cloud Ecosystem
Marketplace
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP License Service
Support Plans
Customer Operation Capabilities
Partner Support Plans
Professional Services
enterprise-collaboration
Meeting
IoT
IoT
Intelligent EdgeFabric
DeveloperTools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Updated at: Feb 24, 2022 GMT+08:00

Deleting Subscriptions in Batches

Typical Scenario

If an NA does not need to receive subscription notification messages pushed by the IoT platform or a specified type of subscription notification messages, the NA can call this API to delete subscription configurations in batches and cancel the subscriptions.

API Function

This API is used to delete all subscriptions, subscriptions of a specified subscription type, or subscriptions of a specified callback URL in batches.

API Description

1
public function deleteBatchSubscriptions($dbsInDTO, $accessToken)

Parameter Description

Parameter

Mandatory or Optional

Location

Description

$dbsInDTO

Mandatory

body

For details, see DeleteBatchSubInDTO structure.

$accessToken

Mandatory

header

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

DeleteBatchSubInDTO

Parameter

Mandatory or Optional

Location

Description

$appId

Optional

query

Uniquely identifies an NA. This parameter is used to identify an NA that can call open APIs provided by the IoT platform. The value of this parameter is obtained when the NA is created on the SP portal of the IoT platform. Set this parameter to the value of appId of the authorized application.

$notifyType

Optional

query

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

  • bindDevice: device binding
  • deviceAdded: device addition
  • deviceInfoChanged: device information change
  • deviceDataChanged: device data change
  • deviceDatasChanged: batch device data change
  • deviceDeleted: device deletion
  • messageConfirm: message confirmation
  • commandRsp: command response
  • deviceEvent: device event
  • serviceInfoChanged: service information change
  • deviceModelAdded: device model addition
  • deviceModelDeleted: device model deletion
  • deviceDesiredPropertiesModifyStatusChanged: device shadow modification status change
  • swUpgradeStateChangeNotify: software upgrade status change notification
  • swUpgradeResultNotify: software upgrade result notification
  • fwUpgradeStateChangeNotify: firmware upgrade status change notification
  • fwUpgradeResultNotify: firmware upgrade result notification

$callbackUrl

Optional

query

Indicates the callback URL of the subscription.

$channel

Optional

query

Indicates the transmission channel.

  • If the value of this parameter is empty, the IoT platform deletes subscriptions with channel set to MQTTS or HTTP.
  • If this parameter is set to MQTTS, the IoT platform deletes only subscriptions with channel set to MQTTS.
  • If this parameter is set to HTTP, the IoT platform deletes only subscriptions with channel set to HTTP.
  • If this parameter is set to other values, subscriptions are not deleted.

Response Parameters

Status Code: 204 No Content

Error Codes

HTTP Status Code

Error Code

Error Description

Remarks

403

100217

The application hasn't 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

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.

404

100225

The resource is not found

The resource does not exist.

Recommended handling: Check whether notifyType is correct.

Did you find this page helpful?

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel