QuerySubscribeRelation - IoT Platform: Central de Documentação do Alibaba Cloud

Consulta uma assinatura do lado do servidor do Message Service (MNS) ou AMQP.

Limites

Cada conta Alibaba Cloud pode executar no máximo 5 consultas por segundo (QPS).

Nota

Os usuários RAM de uma conta Alibaba Cloud compartilham a cota da conta.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	QuerySubscribeRelation	A operação a ser executada. Defina o valor como QuerySubscribeRelation.
ProductKey	String	Sim	a1fyXVF****	O ProductKey do produto especificado na assinatura.
Type	String	Sim	AMQP	O tipo da assinatura. Valores válidos: MNS AMQP
IotInstanceId	String	Não	iot-cn-0pp1n8t****	O ID da instância. Visualize o ID da instância na página Overview no console do IoT Platform. Importante Se a instância possuir um ID, configure este parâmetro. Caso contrário, a chamada falhará. Se a instância não tiver uma página Overview ou ID, não é necessário definir este parâmetro. Para mais informações, consulte Visão geral.

Além dos parâmetros específicos da operação mencionados anteriormente, especifique os parâmetros de solicitação comuns ao chamar esta API. Para mais informações, consulte Parâmetros de solicitação comuns.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	iot.system.SystemException	O código de erro retornado se a chamada falhar. Para mais informações, consulte Códigos de erro.
ErrorMessage	String	A system exception occurred.	A mensagem de erro retornada se a chamada falhar.
DeviceDataFlag	Boolean	true	Indica se as mensagens upstream do dispositivo foram enviadas. true: sim. false: não.
DeviceStatusChangeFlag	Boolean	true	Indica se as mensagens sobre alterações de status do dispositivo foram enviadas. true: sim. false: não.
FoundDeviceListFlag	Boolean	true	Indica se as mensagens foram enviadas quando um gateway detectou novos subdispositivos. true: sim. O valor true é retornado apenas ao consultar um produto de gateway. false: não.
DeviceTopoLifeCycleFlag	Boolean	true	Indica se as mensagens sobre alterações de relacionamento topológico dos dispositivos foram enviadas. true: sim. O valor true é retornado apenas ao consultar um produto de gateway. false: não.
DeviceLifeCycleFlag	Boolean	true	Indica se as mensagens sobre alterações no ciclo de vida do dispositivo foram enviadas. true: sim. false: não.
ThingHistoryFlag	Boolean	true	Indica se os dados históricos upstream da Thing Specification Language (TSL) foram enviados. true: sim. false: não.
OtaEventFlag	Boolean	true	Indica se as notificações sobre o status dos lotes de atualização OTA foram enviadas. true: sim. false: não.
DeviceTagFlag	Boolean	true	Indica se as mensagens sobre alterações de tag do dispositivo foram enviadas. Valores válidos: true: sim. Este parâmetro entra em vigor apenas se o parâmetro Type estiver definido como AMQP. false: não. Valor padrão: false.
OtaVersionFlag	Boolean	true	Indica se as mensagens sobre os números de versão dos módulos OTA foram enviadas. Valores válidos: true: sim. Este parâmetro entra em vigor apenas se o parâmetro Type estiver definido como AMQP. false: não. Valor padrão: false.
OtaJobFlag	Boolean	true	Indica se as notificações sobre atualizações em lote OTA foram enviadas. Valores válidos: true: sim. Este parâmetro entra em vigor apenas se o parâmetro Type estiver definido como AMQP. false: não. Valor padrão: false.
ProductKey	String	a1fyXVF****	O ProductKey do produto especificado na assinatura.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. true: A chamada foi bem-sucedida. false: A chamada falhou.
ConsumerGroupIds	List	[DEFAULT_GROUP,br45A6A1amoRFGN7x1zP00****]	Os IDs dos grupos de consumidores criados na assinatura AMQP. Este parâmetro é retornado se o parâmetro Type estiver definido como AMQP.
Type	String	AMQP	O tipo da assinatura. Valores válidos: MNS AMQP
RequestId	String	21D327AF-A7DE-4E59-B5D1-ACAC8C024555	O ID da solicitação.
MnsConfiguration	String	{ "queueName": "mns-test-topic1", "regionName": "cn-shanghai", "role": { "roleArn": "acs:ram::5645***:role/aliyuniotaccessingmnsrole", "roleName": "AliyunIOTAccessingMNSRole" } }	As configurações da fila MNS. Este parâmetro é retornado se o parâmetro Type estiver definido como MNS. Para mais informações, consulte a seção "Definição do parâmetro MnsConfiguration".

Definição do parâmetro MnsConfiguration

Comando	Descrição
queueName	O nome do tópico MNS usado para receber dados.
regionName	O código da região onde o MNS está implantado. Exemplo: cn-shanghai.
role	As informações sobre a função RAM. Para conceder ao IoT Platform acesso ao MNS, atribua uma função RAM ao IoT Platform. O script a seguir mostra a sintaxe de uma função RAM: `{"roleArn":"acs:ram::5645*:role/aliyuniotaccessingmnsrole","roleName": "AliyunIOTAccessingMNSRole"}` Substitua `6541*` pelo seu ID da Alibaba Cloud. Faça login no Console de Gerenciamento da Alibaba Cloud e visualize o ID da conta na página Security Settings. `AliyunIOTAccessingMNSRole` é uma função de serviço especificada no console RAM. Esta função concede ao IoT Platform acesso ao MNS. Acesse a página RAM Roles no console RAM para gerenciar as funções RAM.

Exemplo de resposta


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

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

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 erro

Para obter uma lista de códigos de erro, acesse o API Error Center.