UpdateSubscribeRelation
调用该接口修改MNS或AMQP服务端订阅
服务地址：
华东2（上海）
输入参数
只看必填
DeviceStatusChangeFlag推送消息类型是否选择设备状态变化通知
请选择布尔值
IotInstanceId实例ID
ThingHistoryFlag推送消息类型是否选择物模型历史数据上报
请选择布尔值
ProductKey该订阅中的产品的ProductKey
Type订阅类型：
DeviceDataFlag推送消息类型是否选择设备上报消息
请选择布尔值
DeviceTopoLifeCycleFlag推送消息类型是否选择设备拓扑关系变更
请选择布尔值
FoundDeviceListFlag推送消息类型是否选择网关子设备发现上报
请选择布尔值
OtaEventFlag推送消息类型是否选择OTA升级状态通知
请选择布尔值
DeviceLifeCycleFlag推送消息类型是否选择设备生命周期变更
请选择布尔值
MnsConfigurationMNS队列的配置信息
DeviceTagFlag推送消息类型是否选择设备标签变更
请选择布尔值
OtaVersionFlag推送消息类型是否选择OTA模块版本号上报
请选择布尔值
OtaJobFlag推送消息类型是否选择OTA升级批次状态通知
请选择布尔值
SubscribeFlags标识当前订阅产品的其他类型消息
ConsumerGroupIds创建的AMQP订阅中的消费组ID
0
添加
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

QPS 限制

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

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

请求参数

字段名称字段详情
DeviceStatusChangeFlagboolean

推送消息类型是否选择设备状态变化通知。可选值：展开详情

示例值:true
IotInstanceIdstring

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

示例值:iot-cn-0pp1n8t****
ThingHistoryFlagboolean

推送消息类型是否选择物模型历史数据上报。可选值：展开详情

示例值:true
ProductKeystring

该订阅中的产品的 ProductKey。

示例值:a1fyXVF****参考取值来源:
    CreateProduct
    QueryProductList
    ReleaseProduct
    ListProductByTags
    BindLicenseProduct
    BatchBindProductsIntoProject
Typestring

订阅类型：展开详情

示例值:AMQP
DeviceDataFlagboolean

推送消息类型是否选择设备上报消息。可选值：展开详情

示例值:true
DeviceTopoLifeCycleFlagboolean

推送消息类型是否选择设备拓扑关系变更。可选值：展开详情

示例值:true
FoundDeviceListFlagboolean

推送消息类型是否选择网关子设备发现上报。可选值：展开详情

示例值:true
OtaEventFlagboolean

推送消息类型是否选择 OTA 升级状态通知。可选值：展开详情

示例值:true
DeviceLifeCycleFlagboolean

推送消息类型是否选择设备生命周期变更。可选值：展开详情

示例值:true
MnsConfigurationstring

MNS 队列的配置信息，Type 为 MNS 时必填。展开详情

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

推送消息类型是否选择设备标签变更。可选值：展开详情

示例值:true
OtaVersionFlagboolean

推送消息类型是否选择 OTA 模块版本号上报。可选值：展开详情

示例值:true
OtaJobFlagboolean

推送消息类型是否选择 OTA 升级批次状态通知。可选值：展开详情

示例值:true
SubscribeFlagsstring

标识当前订阅产品的其他类型消息。展开详情

示例值:{ "jt808DeviceDataFlag": true }参考取值来源:
    QuerySubscribeRelation
ConsumerGroupIdsarray<string>

创建的 AMQP 订阅中的消费组 ID，Type 为 AMQP 时必填。展开详情

示例值:nJRaJPn5U1JITGfjBO9l00****子级条数 <= 50

请求说明

说明 请求参数中的 Flag 不能全部为 false 或不传入，至少传入一个为 true 的 Flag。

MnsConfiguration 定义

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

MnsConfiguration 示例：

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

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

返回参数

字段名称字段详情
Codestring

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

示例值:iot.system.SystemException
ErrorMessagestring

调用失败时，返回的出错信息。

示例值:系统异常
RequestIdstring

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

示例值:21D327AF-A7DE-4E59-B5D1-ACAC8C024555
Successboolean

是否调用成功。展开详情

示例值:true
变更历史
暂无变更历史