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

Observações de uso

Os recursos da TSL incluem propriedades, serviços e eventos.

Se o modelo TSL de um produto tiver módulos personalizados adicionados, deixe o parâmetro FunctionBlockId vazio para recuperar os recursos da TSL de todos os módulos personalizados ou especifique-o para obter os recursos de um módulo personalizado específico.

Para mais informações sobre o formato de dados do parâmetro de resposta ThingModelJson, consulte Estrutura de dados do ThingModelJson.

Limites de QPS

É possível chamar esta operação até 10 vezes por segundo por conta.

Nota

Usuários RAM de uma conta Alibaba Cloud compartilham a cota dessa conta.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parameter	Type	Required	Example	Description
Action	String	Yes	QueryThingModel	A operação a ser executada. Defina o valor como QueryThingModel.
IotInstanceId	String	No	iot_instc_pu*_c-v64	O ID da instância. Visualize o ID da instância na aba Overview do console IoT Platform. Importante Se a instância tiver um ID, será obrigatório especificar este parâmetro. Caso contrário, a solicitação falhará. Se a aba Overview ou o ID da instância não aparecerem no console IoT Platform, não será necessário especificar este parâmetro. Para mais detalhes sobre instâncias, consulte Visão geral.
ResourceGroupId	String	No	rg-acfm4l5tcwd****	O ID do grupo de recursos. Importante O IoT Platform oferece suporte ao gerenciamento de grupos de recursos apenas por instância. O parâmetro ResourceGroupId é inválido. Não é necessário especificar este parâmetro.
ProductKey	String	No	a1BwAGV****	O ProductKey do produto.
ModelVersion	String	No	v1.0.0	O número da versão do modelo TSL. Chame a operação ListThingModelVersion para visualizar os números de versão do modelo TSL de um produto. Se você não especificar este parâmetro, o rascunho do modelo TSL será consultado. Se você especificar este parâmetro, o sistema consultará o modelo TSL da versão indicada.
FunctionBlockId	String	No	BatteryModule	O identificador do módulo TSL personalizado. Cada identificador é único dentro de um produto. Se você não especificar este parâmetro, o módulo padrão será consultado.

Além dos parâmetros específicos da operação, também é necessário especificar parâmetros de solicitação comuns. Para mais informações, consulte Parâmetros comuns.

Parâmetros de resposta

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	O código de erro retornado se a solicitação falhar. Para mais informações, consulte Códigos de erro.
Data	Struct		Os dados retornados se a solicitação for bem-sucedida.
ThingModelJson	String	{ "productKey":"a1Jw4id***", "_ppk":{ "version":"1.1", "description":"xxx" }, "properties":[ { "identifier": "SimCardType", "dataSpecs": { "max": "1", "dataType": "INT", "unit": "mmHg", "min": "0", "step": "1" }, "std": false, "custom": true, "dataType": "INT", "rwFlag": "READ_ONLY", "productKey": "a1Jw4idFWHX", "required": false, "customFlag": true, "name": "SIM card type" } ], "services":[], "events":[] }	Os recursos do modelo TSL. O formato dos dados difere entre o módulo padrão e os módulos personalizados. Para mais detalhes sobre o formato de dados do parâmetro ThingModelJson, consulte Estrutura de dados do ThingModelJson.
ErrorMessage	String	A system exception occurred.	A mensagem de erro retornada se a solicitação falhar.
ProductKey	String	a1BwAGV****	O ProductKey do produto.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	O ID da solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. true false

Exemplos

Exemplos de solicitações

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryThingModel
&ProductKey=a1bPo9p****
&ModelVersion=v1.0.0
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<QueryThingModelResponse>
    <RequestId>1F9041A2-ED5B-4A5A-9C44-598E28C0B434</RequestId>
    <Data>
        <ThingModelJson>{"_ppk":{"version":"1594253010934"},"events":[],"productKey":"a114xeJ****","properties":[{"configCode":"8C03F0EEC63D4897BF2637F89AE36B011594227294067","custom":true,"customFlag":true,"dataSpecs":{"custom":true,"dataType":"INT","max":"1","min":"0","step":"1","unit":"ppb"},"dataType":"INT","description":"1","extendConfig":"{\"originalDataType\":{\"specs\":{\"registerCount\":1,\"reverseRegister\":0,\"swap16\":0},\"type\":\"bool\"},\"identifier\":\"WakeUpData\",\"registerAddress\":\"0x04\",\"scaling\":1,\"writeFunctionCode\":0,\"operateType\":\"inputStatus\",\"pollingTime\":1000,\"trigger\":1}","identifier":"WakeUpData","name":"Wakeup_Data","productKey":"a114xeJGj2p","required":false,"rwFlag":"READ_ONLY","std":false}],"services":[]}</ThingModelJson>
    </Data>
    <Success>true</Success>
</QueryThingModelResponse>

Formato JSON

{
   "RequestId": "1F9041A2-ED5B-4A5A-9C44-598E28C0B434",
   "Data": {
      "ThingModelJson": "{\"_ppk\":{\"version\":\"1594253010934\"},\"events\":[],\"productKey\":\"a114xeJ****\",\"properties\":[{\"configCode\":\"8C03F0EEC63D4897BF2637F89AE36B011594227294067\",\"custom\":true,\"customFlag\":true,\"dataSpecs\":{\"custom\":true,\"dataType\":\"INT\",\"max\":\"1\",\"min\":\"0\",\"step\":\"1\",\"unit\":\"ppb\"},\"dataType\":\"INT\",\"description\":\"1\",\"extendConfig\":\"{\\\"originalDataType\\\":{\\\"specs\\\":{\\\"registerCount\\\":1,\\\"reverseRegister\\\":0,\\\"swap16\\\":0},\\\"type\\\":\\\"bool\\\"},\\\"identifier\\\":\\\"WakeUpData\\\",\\\"registerAddress\\\":\\\"0x04\\\",\\\"scaling\\\":1,\\\"writeFunctionCode\\\":0,\\\"operateType\\\":\\\"inputStatus\\\",\\\"pollingTime\\\":1000,\\\"trigger\\\":1}\",\"identifier\":\"WakeUpData\",\"name\":\"Wakeup_Data\",\"productKey\":\"a114xeJGj2p\",\"required\":false,\"rwFlag\":\"READ_ONLY\",\"std\":false}],\"services\":[]}"
   },
   "Code": "",
   "Success": true
}

Códigos de erro

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