Devices - Get Component Command History

Serviço:

IoT Central

Versão da API:

2022-07-31

Obter histórico de comandos do componente

GET https://{subdomain}.{baseDomain}/api/devices/{deviceId}/components/{componentName}/commands/{commandName}?api-version=2022-07-31

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
baseDomain	path	True	string	O domínio base para todas as solicitações de serviço do Azure IoT Central.
commandName	path	True	string	Nome deste comando do dispositivo.
componentName	path	True	string	Nome do componente do dispositivo.
deviceId	path	True	string	ID exclusiva do dispositivo.
subdomain	path	True	string	O subdomínio do aplicativo.
api-version	query	True	string	A versão da API que está sendo chamada.

Respostas

Nome	Tipo	Description
200 OK	DeviceCommandCollection	Êxito
Other Status Codes	Error	Uma resposta de erro recebida do Serviço Central do IoT. Cabeçalhos x-ms-error-code: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get command history

Solicitação de exemplo

HTTP

GET https://appsubdomain.azureiotcentral.com/api/devices/mx1/components/Thermostat_1o/commands/CoolDown?api-version=2022-07-31

Resposta de exemplo

Código de status:

200

{
  "value": [
    {
      "request": 20,
      "id": "4e17dd2e-7bf2-458d-8466-19bc6fc9b642",
      "response": 58.795679629034694,
      "responseCode": 200
    }
  ]
}

Definições

Nome	Description
DeviceCommand	A definição de comando do dispositivo.
DeviceCommandCollection	Os resultados paginado das execuções de comando do dispositivo.
Error	A definição de erro de resposta.
ErrorDetails	As informações detalhadas do erro.

DeviceCommand

Objeto

A definição de comando do dispositivo.

Nome	Tipo	Description
connectionTimeout	integer (int32) minimum: 0 maximum: 30	Tempo limite da conexão em segundos para aguardar que um dispositivo desconectado entre online. O padrão é de 0 segundos.
id	string	A ID de solicitação da execução do comando do dispositivo.
request		O conteúdo do comando do dispositivo dá suporte a qualquer tipo primitivo ou objeto.
response		O conteúdo da resposta de comando do dispositivo dá suporte a qualquer tipo primitivo ou objeto.
responseCode	integer (int32)	O código de status da resposta de comando do dispositivo.
responseTimeout	integer (int32) minimum: 5 maximum: 30	Tempo limite de resposta em segundos para aguardar a conclusão de um comando em um dispositivo. O padrão é 30 segundos.

DeviceCommandCollection

Objeto

Os resultados paginado das execuções de comando do dispositivo.

Nome	Tipo	Description
nextLink	string	URL para obter a próxima página de execuções de comando do dispositivo.
value	DeviceCommand[]	A coleção de execuções de comando do dispositivo.

Error

Objeto

A definição de erro de resposta.

Nome	Tipo	Description
error	ErrorDetails	Detalhes do erro da solicitação atual.

ErrorDetails

Objeto

As informações detalhadas do erro.

Nome	Tipo	Description
code	string	Código de erro.
message	string	Detalhes da mensagem de erro.
requestId	string	ID de correlação para a solicitação atual.
time	string (date-time-rfc1123)	A hora em que a solicitação de erro falhou.