QuerySubscribeRelation_物联网平台_API文档-阿里云OpenAPI开发者门户

接口说明

QPS 限制

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

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

iot:QuerySubscribeRelation	Get	全部资源 *	无	无

请求参数

字段名称	字段详情
IotInstanceIdstring	实例 ID。您可在物联网平台控制台的实例概览页面，查看当前实例的 ID。展开详情示例值:iot-cn-0pp1n8t****
ProductKeystring	该订阅中的产品的 ProductKey。示例值:a1fyXVF****参考取值来源: CreateProduct QueryProductList ReleaseProduct ListProductByTags BindLicenseProduct BatchBindProductsIntoProject
Typestring	订阅类型：展开详情示例值:AMQP

请求说明

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

返回参数

字段名称	字段详情
Typestring	订阅类型。返回值：展开详情示例值:AMQP
ErrorMessagestring	调用失败时，返回的出错信息。示例值:系统异常
DeviceTagFlagboolean	推送消息类型是否选择设备标签变更。可选值：展开详情示例值:true
OtaVersionFlagboolean	推送消息类型是否选择 OTA 模块版本号上报。可选值：展开详情示例值:true
DeviceDataFlagboolean	推送消息类型是否选择设备上报消息。展开详情示例值:true
Successboolean	是否调用成功。展开详情示例值:true
SubscribeFlagsstring	标识当前订阅产品的其他类型消息。展开详情示例值:{ "jt808DeviceDataFlag": true }
OtaEventFlagboolean	推送消息类型是否选择 OTA 升级状态通知。展开详情示例值:true
ThingHistoryFlagboolean	推送消息类型是否选择物模型历史数据上报。展开详情示例值:true
DeviceStatusChangeFlagboolean	推送消息类型是否选择设备状态变化通知。展开详情示例值:true
ProductKeystring	该订阅中的产品的 ProductKey。示例值:a1fyXVF****
RequestIdstring	阿里云为该请求生成的唯一标识符。示例值:21D327AF-A7DE-4E59-B5D1-ACAC8C024555
MnsConfigurationstring	Type 为 MNS 时，返回 MNS 队列的配置信息。展开详情示例值:{ "queueName": "mns-test-topic1", "regionName": "cn-shanghai", "role": { "roleArn": "acs:ram::5645***:role/aliyuniotaccessingmnsrole", "roleName": "AliyunIOTAccessingMNSRole" } }
DeviceTopoLifeCycleFlagboolean	推送消息类型是否选择设备拓扑关系变更。展开详情示例值:true
DeviceLifeCycleFlagboolean	推送消息类型是否选择设备生命周期变更。展开详情示例值:true
Codestring	调用失败时，返回的错误码。更多信息，请参见错误码。示例值:iot.system.SystemException
FoundDeviceListFlagboolean	推送消息类型是否选择网关子设备发现上报。展开详情示例值:true
OtaJobFlagboolean	推送消息类型是否选择 OTA 升级批次状态通知。可选值：展开详情示例值:true
ConsumerGroupIdsarray<string>

返回说明

MnsConfiguration 定义

名称	描述
queueName	消息服务中用来接收信息的队列名称。
regionName	目标消息服务所在的阿里云地域代码，例如 cn-shanghai。
role	授权角色信息。通过授予物联网平台指定的系统服务角色，您可以授权物联网平台访问您的消息服务。授权角色信息如下： `{"roleArn":"acs:ram::5645\:role/aliyuniotaccessingmnsrole","roleName": "AliyunIOTAccessingMNSRole"}` 请将`5645\**`替换成您的阿里云账号 ID。您可以登录控制台，在账号安全设置页面查看您的账号 ID。 `AliyunIOTAccessingMNSRole`是访问控制中定义的服务角色。用于授予物联网平台访问消息服务。关于角色的更多信息，请在访问控制 RAM 控制台的角色管理页面进行角色管理。

示例：

{
    "queueName": "mns-test-topic1",
    "regionName": "cn-shanghai",
    "role": {
        "roleArn": "acs:ram::5645***:role/aliyuniotaccessingmnsrole",
        "roleName": "AliyunIOTAccessingMNSRole"
    }
}

返回示例

变更历史

暂无变更历史