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

请求参数

名称 类型 是否必需 描述
Action String 要执行的操作,取值:QueryProductTopic
ProductKey String 要查询Topic类的产品Key。
IotInstanceId String 共享实例不传此参数;仅独享实例需传入实例ID。
公共请求参数 - 请参见公共参数

返回参数

名称 类型 描述
RequestId String 阿里云为该请求生成的唯一标识符。
Success Boolean 表示是否调用成功。true表示调用成功,false表示调用失败。
ErrorMessage String 调用失败时,返回的出错信息。
Code String 调用失败时,返回的错误码。错误码详情,请参见错误码
Data ProductTopicInfo 调用成功时,返回的Topic类信息列表。详情参见下表ProductTopicInfo。
表 1. ProductTopicInfo
名称 类型 描述
ProductKey String 产品Key。
Id String Topic类的 ID。
TopicShortName String Topic类中除productKeydeviceName以外的类目。
Operation String

设备对该Topic类的操作权限,取值:

0:发布

1:订阅

2:发布和订阅

Desc String Topic类的描述信息。

示例

请求示例

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

返回示例

  • JSON格式
    {
        "Data": [{
            "Id": "10000",
            "Operation": "0",
            "ProductKey": "HMyB***",
            "TopicShortName": "/HMyB***/${deviceName}/update"
        },
        {
            "Id": "10001",
            "Operation": "2",
            "ProductKey": "HMyB***",
            "TopicShortName": "/HMyB***/${deviceName}/update/error"
        },
        {
            "Id": "10002",
            "Operation": "1",
            "ProductKey": "HMyB***",
            "TopicShortName": "/HMyB***/${deviceName}/get"
        }],
        "RequestId": "B953EAFF-CFF6-4FF8-BC94-8B89F018E4DD",
        "Success": true
    }
  • XML格式
    <?xml version="1.0" encoding="UTF-8" ?>
    <QueryProductTopicResponse>
        <Data>
            <Id>10000</Id>
            <Operation>0</Operation>
            <ProductKey>HMyB***</ProductKey>
            <TopicShortName>/HMyB***/${deviceName}/update</TopicShortName>
        </Data>
        <Data>
            <Id>10001</Id>
            <Operation>2</Operation>
            <ProductKey>HMyB***</ProductKey>
            <TopicShortName>/HMyB***/${deviceName}/update/error</TopicShortName>
        </Data>
        <Data>
            <Id>10002</Id>
            <Operation>1</Operation>
            <ProductKey>HMyB***</ProductKey>
            <TopicShortName>/HMyB***/${deviceName}/get</TopicShortName>
        </Data>
        <RequestId>B953EAFF-CFF6-4FF8-BC94-8B89F018E4DD</RequestId>
        <Success>true</Success>
    </QueryProductTopicResponse>