UpdateSubscribeRelation - IoT Platform - Centro de documentación de Alibaba Cloud

Modifica una suscripción del lado del servidor de Message Service (MNS) o AMQP.

Límites

Cada cuenta de Alibaba Cloud admite un máximo de 5 consultas por segundo (QPS).

Nota

Los usuarios de RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que ejecute esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	UpdateSubscribeRelation	La operación que desea ejecutar. Establezca el valor en UpdateSubscribeRelation.
ProductKey	String	Sí	a1fyXVF****	El ProductKey del producto especificado para la suscripción.
Type	String	Sí	AMQP	El tipo de suscripción. Valores válidos: MNS AMQP
IotInstanceId	String	No	iot-cn-0pp1n8t****	El ID de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, configure este parámetro. De lo contrario, la llamada fallará. Si su instancia no tiene página de Overview ni ID, omita este parámetro. Para obtener más información, consulte Descripción general.
DeviceDataFlag	Boolean	No	true	Especifica si se deben enviar mensajes ascendentes del dispositivo. Valores válidos: true: sí. false: no. Valor predeterminado: false.
DeviceStatusChangeFlag	Boolean	No	true	Especifica si se deben enviar mensajes sobre cambios en el estado del dispositivo. Valores válidos: true: sí. false: no. Valor predeterminado: false.
FoundDeviceListFlag	Boolean	No	true	Especifica si se deben enviar mensajes cuando una puerta de enlace detecta nuevos subdispositivos. Valores válidos: true: sí. Este parámetro solo es válido para productos de puerta de enlace. false: no. Valor predeterminado: false.
DeviceTopoLifeCycleFlag	Boolean	No	true	Especifica si se deben enviar mensajes sobre cambios en las relaciones topológicas de los dispositivos. Valores válidos: true: sí. Este parámetro solo es válido para productos de puerta de enlace. false: no. Valor predeterminado: false.
DeviceLifeCycleFlag	Boolean	No	true	Especifica si se deben enviar mensajes sobre cambios en el ciclo de vida del dispositivo. Valores válidos: true: sí. false: no. Valor predeterminado: false.
ThingHistoryFlag	Boolean	No	true	Especifica si se deben enviar datos históricos ascendentes de Thing Specification Language (TSL). Valores válidos: true: sí. false: no. Valor predeterminado: false.
OtaEventFlag	Boolean	No	true	Especifica si se deben enviar notificaciones sobre el estado de los lotes de actualización OTA. Valores válidos: true: sí. false: no. Valor predeterminado: false.
DeviceTagFlag	Boolean	No	true	Especifica si se deben enviar mensajes sobre cambios en las etiquetas de los dispositivos. Valores válidos: true: sí. Este parámetro solo surte efecto si el parámetro Type está establecido en AMQP. false: no. Valor predeterminado: false.
OtaVersionFlag	Boolean	No	true	Especifica si se deben enviar mensajes sobre los números de versión de los módulos OTA. Valores válidos: true: sí. Este parámetro solo surte efecto si el parámetro Type está establecido en AMQP. false: no. Valor predeterminado: false.
OtaJobFlag	Boolean	No	true	Especifica si se deben enviar notificaciones sobre los estados de los lotes de actualización OTA. Valores válidos: true: sí. Este parámetro solo surte efecto si el parámetro Type está establecido en AMQP. false: no. Valor predeterminado: false.
MnsConfiguration	String	No	{ "queueName": "mns-test-topic1", "regionName": "cn-shanghai", "role": { "roleArn": "acs:ram::5645***:role/aliyuniotaccessingmnsrole", "roleName": "AliyunIOTAccessingMNSRole" } }	La configuración de la cola de MNS. Este parámetro es obligatorio si el parámetro Type está establecido en AMQP. Para obtener más información, consulte la sección "Definición del parámetro MnsConfiguration".
ConsumerGroupIds.N	RepeatList	No	nJRaJPn5U1JITGfjBO9l00****	Los ID de los grupos de consumidores creados en la suscripción AMQP. Este parámetro es obligatorio si el parámetro Type está establecido en AMQP. Después de ejecutar la operación CreateConsumerGroup para crear un grupo de consumidores, se devuelve el ID del grupo. Ejecute la operación QueryConsumerGroupList para consultar el ID del grupo de consumidores por nombre de grupo. También puede ir a la consola de IoT Platform,y elegir Rules > Server-side Subscription > Consumer Groups para consultar el ID del grupo de consumidores.

Nota

Debe establecer como mínimo un parámetro relacionado con Flag en

true

Definición del parámetro MnsConfiguration

Parámetro	Descripción
queueName	El nombre de la cola de MNS que se utiliza para recibir datos. Cree una cola en la consola de MNS y obtenga el nombre de la cola. Para obtener más información, consulte Crear una cola.
regionName	El código de la región donde se despliega MNS. Ejemplo: cn-shanghai.
role	La información sobre el rol de RAM. Para otorgar a IoT Platform acceso a MNS, asigne un rol de RAM a IoT Platform. El siguiente script muestra la sintaxis de un rol de RAM: `{"roleArn":"acs:ram::5645*:role/aliyuniotaccessingmnsrole","roleName": "AliyunIOTAccessingMNSRole"}` Reemplace `6541*` con su ID de Alibaba Cloud. Inicie sesión en la consola de administración de Alibaba Cloud y consulte el ID de la cuenta en la página Security Settings. `AliyunIOTAccessingMNSRole` es un rol de servicio especificado en la consola de RAM. Este rol se utiliza para otorgar a IoT Platform acceso a MNS. Vaya a la página RAM Roles de la consola de RAM para gestionar los roles de RAM.

Ejemplo del parámetro MnsConfiguration

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

Además de los parámetros de solicitud específicos de la operación anteriores, debe especificar parámetros de solicitud comunes al ejecutar esta operación. Para obtener más información, consulte Parámetros de solicitud comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	21D327AF-A7DE-4E59-B5D1-ACAC8C024555	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateSubscribeRelation
&OtaEventFlag=true
&ProductKey=a1Zkii7****
&Type=AMQP
&ConsumerGroupIds.1=Xs95KifeaSKbi8tKkcoD00****
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<UpdateSubscribeRelationResponse>
        <RequestId>C21DA94F-07D7-482F-8A0C-5BB0E3CC1A82</RequestId>
        <Success>true</Success>
</UpdateSubscribeRelationResponse>

Formato JSON

{
    "RequestId": "C21DA94F-07D7-482F-8A0C-5BB0E3CC1A82",
    "Success": true
}

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.