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

Limites de QPS

É possível chamar esta API até três vezes por segundo por conta.

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 usar o OpenAPI Explorer para chamar esta operação. A ferramenta também gera dinamicamente códigos de exemplo para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	QueryProductTopic	Operação a ser executada. Defina o valor como QueryProductTopic.
ProductKey	String	Sim	HMyB*******	ProductKey do produto.
IotInstanceId	String	Não	iot_instc_pu***_c-v64********	ID da instância. Obtenha o ID da instância na página Overview do console IoT Platform. Importante Se a instância tiver um ID, configure este parâmetro. Caso contrário, a chamada falhará. Se a instância não tiver um ID, não configure este parâmetro. Para mais informações, consulte Visão geral da instância.

Além dos parâmetros específicos desta operação, especifique os parâmetros comuns ao chamá-la. Para mais informações, consulte Parâmetros comuns.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	iot.system.SystemException	Código de erro retornado se a chamada falhar. Para mais informações, consulte Códigos de erro.
Data	Array of ProductTopicInfo		Categorias de tópicos personalizados retornadas em caso de sucesso. Para mais informações, consulte ProductTopicInfo.
ProductTopicInfo
Codec	String	compress	Indica se a compactação ou descompactação de dados está ativada para a categoria de tópico personalizado. Valores válidos: compress: Compactação de dados ativada. decompress: Descompactação de dados ativada. Para mais informações, consulte Compactação de dados.
Desc	String	topicDesc	Descrição da categoria de tópico personalizado.
EnableProxySubscribe	Boolean	false	Indica se a assinatura delegada está ativada. Valores válidos: true: Assinatura delegada ativada. false: Assinatura delegada desativada. Ao ativar a assinatura delegada para um tópico, o IoT Platform obtém seus detalhes e auxilia o dispositivo a se inscrever durante a conexão.
Id	String	821****	ID da categoria de tópico personalizado.
Operation	String	1	Permissões concedidas ao dispositivo na categoria de tópico personalizado. Valores válidos: 0: Publicar. 1: Assinar. 2: Publicar e assinar.
ProductKey	String	HMyB***	ProductKey do produto.
TopicShortName	String	/HMyB***/${deviceName}/user/get	Nome da categoria de tópico personalizado.
ErrorMessage	String	A system exception occurred.	Mensagem de erro retornada se a chamada falhar.
RequestId	String	B953EAFF-CFF6-4FF8-BC94-8B89F018E4DD	ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. Valores válidos: true: Chamada bem-sucedida. false: Falha na chamada.

Exemplos

Exemplos de solicitações

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProductTopic
&ProductKey=HMyB*******
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<QueryProductTopicResponse>
  <RequestId>310E4A1E-B614-5607-B7DB-55530CAE074A</RequestId>
  <Data>
        <ProductTopicInfo>
              <TopicShortName>/g18******F/${deviceName}/user/get</TopicShortName>
              <EnableProxySubscribe>false</EnableProxySubscribe>
              <Operation>1</Operation>
              <Id>3679****</Id>
              <ProductKey>g18******F</ProductKey>
        </ProductTopicInfo>
        <ProductTopicInfo>
              <TopicShortName>/g18******F/${deviceName}/user/update</TopicShortName>
              <EnableProxySubscribe>false</EnableProxySubscribe>
              <Operation>0</Operation>
              <Id>3679****</Id>
              <ProductKey>g18******F</ProductKey>
        </ProductTopicInfo>
        <ProductTopicInfo>
              <TopicShortName>/g18******F/${deviceName}/user/update/error</TopicShortName>
              <EnableProxySubscribe>false</EnableProxySubscribe>
              <Operation>0</Operation>
              <Id>3679****</Id>
              <ProductKey>g18******F</ProductKey>
        </ProductTopicInfo>
  </Data>
  <Success>true</Success>
</QueryProductTopicResponse>

Formato JSON

{
    "RequestId": "310E4A1E-B614-5607-B7DB-55530CAE074A",
    "Data": {
        "ProductTopicInfo": [
            {
                "TopicShortName": "/g18******F/${deviceName}/user/get",
                "EnableProxySubscribe": false,
                "Operation": "1",
                "Id": "3679****",
                "ProductKey": "g18******F"
            },
            {
                "TopicShortName": "/g18******F/${deviceName}/user/update",
                "EnableProxySubscribe": false,
                "Operation": "0",
                "Id": "3679****",
                "ProductKey": "g18******F"
            },
            {
                "TopicShortName": "/g18******F/${deviceName}/user/update/error",
                "EnableProxySubscribe": false,
                "Operation": "0",
                "Id": "3679****",
                "ProductKey": "g18******F"
            }
        ]
    },
    "Success": true
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.