调用该接口查询指定产品的自定义Topic类。

QPS限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为3。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 QueryProductTopic

系统规定参数。取值：QueryProductTopic。
ProductKey String 是 HMyB*******

要查询Topic类的产品ProductKey。

IotInstanceId String 否 iot_instc_pu****_c*-v64********

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

注意
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无实例概览页面或ID值，则无需传入。

实例的更多信息，请参见实例概述。

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时，返回的错误码。更多信息，请参见错误码。

Data Array of ProductTopicInfo

调用成功时，返回的Topic类信息列表。详情参见以下ProductTopicInfo。

ProductTopicInfo
Desc String topicDesc

Topic类的描述信息。
Id String 821****

Topic类的ID。
Operation String 1

设备对该Topic类的操作权限，取值：

  • 0：发布
  • 1：订阅
  • 2：发布和订阅
ProductKey String HMyB***

产品Key。
TopicShortName String /HMyB***/${deviceName}/user/get

Topic类中除_productKey_和_deviceName_以外的类目。
ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String B953EAFF-CFF6-4FF8-BC94-8B89F018E4DD

阿里云为该请求生成的唯一标识符。
Success Boolean true

是否调用成功。

  • true：调用成功。
  • false：调用失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProductTopic
&ProductKey=HMyB*******
&<公共请求参数>

正常返回示例

XML格式 

<QueryProductTopicResponse>
  <RequestId>22C22D81-11EA-419F-81F1-08207DD9D0E5</RequestId>
  <Data>
        <ProductTopicInfo>
              <TopicShortName>/g18***/${deviceName}/user/update</TopicShortName>
              <Operation>0</Operation>
              <Id>12362218</Id>
              <ProductKey>g18***</ProductKey>
        </ProductTopicInfo>
        <ProductTopicInfo>
              <TopicShortName>/g18***/${deviceName}/user/update/error</TopicShortName>
              <Operation>0</Operation>
              <Id>12362219</Id>
              <ProductKey>g18***</ProductKey>
        </ProductTopicInfo>
        <ProductTopicInfo>
              <TopicShortName>/g18***/${deviceName}/user/get</TopicShortName>
              <Operation>1</Operation>
              <Id>12362220</Id>
              <ProductKey>g18***</ProductKey>
        </ProductTopicInfo>
  </Data>
  <Success>true</Success>
</QueryProductTopicResponse>

JSON格式 

{
	"RequestId": "22C22D81-11EA-419F-81F1-08207DD9D0E5",
	"Data": {
		"ProductTopicInfo": [
			{
				"TopicShortName": "/g18***/${deviceName}/user/update",
				"Operation": "0",
				"Id": "12362218",
				"ProductKey": "g18***"
			},
			{
				"TopicShortName": "/g18***/${deviceName}/user/update/error",
				"Operation": "0",
				"Id": "12362219",
				"ProductKey": "g18***"
			},
			{
				"TopicShortName": "/g18***/${deviceName}/user/get",
				"Operation": "1",
				"Id": "12362220",
				"ProductKey": "g18***"
			}
		]
	},
	"Success": true
}

错误码

访问错误中心查看更多错误码。