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

Consulta 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í	QuerySubscribeRelation	La operación que desea ejecutar. Establezca el valor en QuerySubscribeRelation.
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.

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.
DeviceDataFlag	Boolean	true	Indica si se enviaron mensajes ascendentes del dispositivo. true: sí. false: no.
DeviceStatusChangeFlag	Boolean	true	Indica si se enviaron mensajes sobre cambios en el estado del dispositivo. true: sí. false: no.
FoundDeviceListFlag	Boolean	true	Indica si se enviaron mensajes cuando una puerta de enlace detectó nuevos subdispositivos. true: sí. El valor true se devuelve solo cuando consulta un producto de puerta de enlace. false: no.
DeviceTopoLifeCycleFlag	Boolean	true	Indica si se enviaron mensajes sobre cambios en las relaciones topológicas de los dispositivos. true: sí. El valor true se devuelve solo cuando consulta un producto de puerta de enlace. false: no.
DeviceLifeCycleFlag	Boolean	true	Indica si se enviaron mensajes sobre cambios en el ciclo de vida del dispositivo. true: sí. false: no.
ThingHistoryFlag	Boolean	true	Indica si se enviaron datos históricos ascendentes de Thing Specification Language (TSL). true: sí. false: no.
OtaEventFlag	Boolean	true	Indica si se enviaron notificaciones sobre el estado de los lotes de actualización OTA. true: sí. false: no.
DeviceTagFlag	Boolean	true	Indica si se enviaron mensajes sobre cambios en las etiquetas del dispositivo. 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	true	Indica si se enviaron 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	true	Indica si se enviaron notificaciones sobre actualizaciones por lotes 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.
ProductKey	String	a1fyXVF****	El ProductKey del producto especificado para la suscripción.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.
ConsumerGroupIds	List	[DEFAULT_GROUP,br45A6A1amoRFGN7x1zP00****]	Los ID de los grupos de consumidores creados en la suscripción AMQP. Este parámetro se devuelve si el parámetro Type está establecido en AMQP.
Type	String	AMQP	El tipo de suscripción. Valores válidos: MNS AMQP
RequestId	String	21D327AF-A7DE-4E59-B5D1-ACAC8C024555	El ID de la solicitud.
MnsConfiguration	String	{ "queueName": "mns-test-topic1", "regionName": "cn-shanghai", "role": { "roleArn": "acs:ram::5645***:role/aliyuniotaccessingmnsrole", "roleName": "AliyunIOTAccessingMNSRole" } }	La configuración de la cola MNS. Este parámetro se devuelve si el parámetro Type está establecido en MNS. Para obtener más información, consulte la sección "Definición del parámetro MnsConfiguration".

Definición del parámetro MnsConfiguration

Comando	Descripción
queueName	El nombre del tema MNS que se utiliza para recibir datos.
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 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.

Respuesta de ejemplo

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

Ejemplos

Solicitudes de ejemplo

https://iot.cn-shanghai.aliyuncs.com/?Action=QuerySubscribeRelation
&ProductKey=a1Zkii7****
&Type=AMQP
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<QuerySubscribeRelationResponse>
       <ConsumerGroupIds>
              <e>Xs95KifeaSKbi8tKkcoD00****</e>
       </ConsumerGroupIds>
       <DeviceDataFlag>false</DeviceDataFlag>
       <DeviceLifeCycleFlag>false</DeviceLifeCycleFlag>
       <DeviceStatusChangeFlag>false</DeviceStatusChangeFlag>
       <DeviceTopoLifeCycleFlag>false</DeviceTopoLifeCycleFlag>
       <FoundDeviceListFlag>false</FoundDeviceListFlag>
       <OtaEventFlag>true</OtaEventFlag>
       <ProductKey>a1Zkii7****</ProductKey>
       <RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
       <Success>true</Success>
       <ThingHistoryFlag>false</ThingHistoryFlag>
       <Type>AMQP</Type>
</QuerySubscribeRelationResponse>

Formato JSON

{
  "DeviceLifeCycleFlag": false,
  "RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
  "DeviceDataFlag": false,
  "DeviceTopoLifeCycleFlag": false,
  "DeviceStatusChangeFlag": false,
  "ConsumerGroupIds": [
    "Xs95KifeaSKbi8tKkcoD00****"
  ],
  "Success": true,
  "ThingHistoryFlag": false,
  "Type": "AMQP",
  "FoundDeviceListFlag": false,
  "OtaEventFlag": true,
  "ProductKey": "a1Zkii7****"
}

Códigos de error

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