Inscreve um dispositivo especificado em um ou mais tópicos.
Observações de uso
O dispositivo deve estar conectado ao IoT Platform e online.
Cada chamada inscreve tópicos de um único dispositivo. Especifique até 10 tópicos por chamada.
Limites de QPS
Cada conta Alibaba Cloud pode chamar esta operação até 10 vezes por segundo (QPS).
Usuários RAM compartilham a cota da conta Alibaba Cloud.
Depuração
Parâmetros da solicitação
| Parameter | Type | Required | Example | Description |
| Action | String | Yes | SubscribeTopic |
Operação a ser executada. Defina o valor como SubscribeTopic. |
| DeviceName | String | Yes | device1 |
O DeviceName do dispositivo ao qual o tópico pertence. |
| ProductKey | String | Yes | a1Q5XoY*** |
A ProductKey do produto ao qual o dispositivo pertence. |
| Topic.N | RepeatList | Yes | /a1Q5XoY***/device1/user/get |
Tópicos para inscrição. Especifique até 10 tópicos. Os tópicos devem ter as permissões Subscribe ou Publish and Subscribe. |
| IotInstanceId | String | No | iot-06*** |
ID da instância. Visualize o ID na página Overview do console IoT Platform. Importante
Para obter mais informações, consulte Visão geral. |
Além dos parâmetros específicos listados acima, especifique também os parâmetros de solicitação comuns. Para obter mais informações, consulte Parâmetros de solicitação comuns.
Parâmetros de resposta
| Parameter | Type | Example | Description |
| Code | String | iot.system.SystemException |
Código de erro. Para obter mais informações, consulte Códigos de erro. |
| ErrorMessage | String | A system exception occurred. |
Mensagem de erro retornada caso a chamada falhe. |
| RequestId | String | BB71E443-4447-4024-A000-EDE09922891E |
ID da solicitação. |
| Success | Boolean | true |
Indica se a chamada foi bem-sucedida.
|
Exemplos
Exemplos de solicitações
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=SubscribeTopic
&DeviceName=device1
&ProductKey=a1Q5XoY***
&Topic.1=/a1Q5XoY***/device1/user/get
&Topic.2=/a1Q5XoY***/device1/user/add
&<Common request parameters>Exemplos de respostas de sucesso
Formato XML
<SubscribeTopicResponse>
<RequestId>32B9828A-25DD-48E2-8E26-D1664B341940</RequestId>
<Success>true</Success>
</SubscribeTopicResponse>Formato JSON
{
"RequestId": "32B9828A-25DD-48E2-8E26-D1664B341940",
"Success": true
}Códigos de erro
|
HttpCode |
Error code |
Error message |
Description |
|
500 |
Iot.MessageBroker.BatchSubTopicFailed |
An error occurred while batch subscribing to the topic. |
Mensagem de erro retornada quando a inscrição em lote falha. |
|
400 |
Iot.System.BillIsOverDue |
Your account has overdue payments. Go to the expense center and add funds to your account. |
Mensagem de erro retornada devido a pagamentos pendentes. Acesse o centro de contas e adicione fundos. |
|
400 |
Iot.MessageBroker.EmptySubTopicList |
The subscription topic list is empty. |
Mensagem de erro retornada porque a lista de tópicos está vazia. |
|
400 |
Iot.Device.NotExistedDevice |
The device does not exist. |
Mensagem de erro retornada porque o dispositivo não existe ou não está ativado. |
|
403 |
Iot.Device.NotDeviceOwner |
You are not the device owner. |
Mensagem de erro retornada porque o operador atual não é o proprietário do dispositivo. |
|
400 |
Iot.MessageBroker.TopicTemplateIsNotFound |
The topic template does not exist. |
Mensagem de erro retornada porque o modelo especificado não existe. |
|
400 |
iot.prod.NotExistedProduct |
The specified product does not exist. |
Mensagem de erro retornada porque o produto especificado não existe. |
|
400 |
iot.device.InactiveDevice |
The device is inactive. |
Mensagem de erro retornada porque o dispositivo não está ativado. Isso indica que ele nunca se conectou ao IoT Platform. |
Para obter uma lista de códigos de erro, visite o API Error Center.