Importa um modelo de Thing Specification Language (TSL) para um produto.
Observações de uso
Se o produto alvo da operação ImportThingModelTsl já estiver publicado, chame a operação CancelReleaseProduct para cancelar a publicação antes de executar o ImportThingModelTsl.
Limites de QPS
É possível chamar esta operação até cinco vezes por segundo por conta.
Os usuários do Resource Access Management (RAM) de uma conta Alibaba Cloud compartilham a cota dessa conta.
Depuração
Parâmetros da solicitação
Parâmetro | Tipo | Obrigatório | Exemplo | Descrição |
Action | String | Sim | ImportThingModelTsl | A operação a ser executada. Defina o valor como ImportThingModelTsl. |
ProductKey | String | Sim | a1BwAGV**** | O ProductKey do produto. Visualize o ProductKey na página Products do console IoT Platform ou chame a operação QueryProductList para consultá-lo. |
IotInstanceId | String | Não | iot_instc_pu**_c-v64* | O ID da instância. Visualize o ID da instância na aba Overview do console IoT Platform. Importante
Para mais informações sobre instâncias, consulte Overview. |
ResourceGroupId | String | Não | rg-acfm4l5tcwd**** | O ID do grupo de recursos. Importante O IoT Platform oferece suporte apenas ao gerenciamento de recursos por instância. O parâmetro ResourceGroupId foi descontinuado. Não é necessário especificar este parâmetro. |
TslStr | String | Não | {"schema":"https://iotx-tsl.oss-ap-southeast-1.aliyuncs.com/schema.json","profile":{"productKey":"a14TeW****"},"properties":[]} | O modelo TSL a importar. O valor é uma string JSON que define as propriedades, os serviços e os eventos do produto. O valor de TslStr deve estar em conformidade com o formato de dados TSL padrão. Para mais informações, consulte What is a TSL model? Nota Para importar um modelo TSL, especifique o parâmetro TslStr. |
TslUrl | String | Não | https://iotx-pop-dsl.oss-cn-shanghai.aliyuncs.com/thing/a14TeWI****/model.json?Expires=1581947119... | A URI do arquivo de modelo TSL armazenado no Object Storage Service (OSS). Nota Este parâmetro não tem efeito. Para importar um modelo TSL, especifique o parâmetro TslStr. |
FunctionBlockId | String | Não | BatteryModule | O identificador do módulo TSL personalizado. Cada identificador é único dentro de um produto. Deve ter de 1 a 30 caracteres e pode conter letras, dígitos e sublinhados (_). Use este parâmetro em conjunto com FunctionBlockName. Se omitido, o sistema importará o módulo padrão. |
FunctionBlockName | String | Não | BatteryModule | O nome do módulo TSL personalizado. Deve ter de 4 a 30 caracteres e pode conter letras, dígitos e sublinhados (_). Use este parâmetro em conjunto com FunctionBlockId. Se omitido, o sistema importará o módulo padrão. |
Além dos parâmetros específicos listados acima, especifique os parâmetros de solicitação comuns ao chamar esta operação. Para mais informações, consulte Common parameters.
Parâmetros de resposta
Parâmetro | Tipo | Exemplo | Descrição |
Code | String | iot.system.SystemException | O código de erro retornado caso a solicitação falhe. Para mais informações, consulte Error codes. |
ErrorMessage | String | A system exception occurred. | A mensagem de erro retornada caso a solicitação falhe. |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | O ID da solicitação. |
Success | Boolean | true | Indica se a solicitação foi bem-sucedida. Valores válidos:
|
Exemplos
Exemplos de solicitações
https://iot.cn-shanghai.aliyuncs.com/?Action=ImportThingModelTsl
&ProductKey=a1lWSUw****
&TslStr={\"profile\":{\"productKey\": \"a1bPo9p****\"},\"services\":[],\"properties\":[],\"events\":[]}
&<Common request parameters>Exemplos de respostas de sucesso
Formato XML
<ImportThingModelTslResponse>
<RequestId>9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E</RequestId>
<Success>true</Success>
</ImportThingModelTslResponse>Formato JSON
{
"RequestId": "9E76053E-26ED-4AB4-AE58-8AFC3F1E7E8E",
"Success": true
}Códigos de erro
Para obter uma lista de códigos de erro, consulte Service error codes.