调用接口UnsubscribeTopic为指定设备取消已订阅的指定Topic。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为50。
说明 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | UnsubscribeTopic | 系统规定参数。取值:UnsubscribeTopic。 |
DeviceName | String | 是 | device1 | 设备的名称。 |
ProductKey | String | 是 | a1BwAGV**** | 设备所属产品的ProductKey。 |
Topic.N | RepeatList | 是 | /a1BwAGV****/device1/user/get | 要取消订阅的Topic列表。 |
IotInstanceId | String | 否 | iot-cn-n6w1y59**** | 实例ID。您可在物联网平台控制台的实例概览页签,查看当前实例的ID。 重要
实例的更多信息,请参见实例概述。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 |
类型 |
示例值 |
描述 |
Code | String | 400 | 调用结果状态码:
|
ErrorMessage | String | The unsub topic list is empty. | 调用失败时,返回的出错信息。 |
FailureTopics | List | /a1BwAGV****/device1/user/get | 取消订阅失败的Topic列表。 |
RequestId | String | E55***B7-4***-4***-8***-D3******F565 | 阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true | 表示是否调用成功。
|
示例
请求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=UnsubscribeTopic
&DeviceName=device1
&ProductKey=a1BwAGV****
&Topic.1=/a1BwAGV****/device1/user/get
&IotInstanceId=iot-cn-n6w1y59****
&<公共请求参数>
正常返回示例
XML
格式
<UnsubscribeTopicResponse>
<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>
<FailureTopics>
<topic>/a1BwAGV****/device1/user/get</topic>
</FailureTopics>
<Code></Code>
<Success>true</Success>
</UnsubscribeTopicResponse>
JSON
格式
{
"RequestId": "E55***B7-4***-4***-8***-D3******F565",
"FailureTopics": [{
"topic":"/a1BwAGV****/device1/user/get"
}],
"Code":"",
"Success": true
}
该文章对您有帮助吗?