Compartilhar via


Jobs - Get

Obter um trabalho por ID
Obtenha detalhes sobre um trabalho em execução ou concluído por ID do trabalho.

GET https://{subdomain}.{baseDomain}/api/jobs/{jobId}?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.

jobId
path True

string

A ID exclusiva do trabalho.

Padrão Regex: ^[a-zA-Z0-9_-]*$

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

Job

Êxito

Other Status Codes

Error

Uma resposta de erro recebida do Serviço do IoT Central.

Cabeçalhos

x-ms-error-code: string

Segurança

azure_auth

Fluxo do 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 a job by ID

Solicitação de exemplo

GET https://appsubdomain.azureiotcentral.com/api/jobs/myJobId?api-version=2022-07-31

Resposta de exemplo

{
  "id": "myJobId",
  "displayName": "My Job",
  "group": "475cad48-b7ff-4a09-b51e-1a9021385453",
  "data": [
    {
      "type": "property",
      "target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
      "path": "componentName.propertyName",
      "value": "updated value"
    }
  ],
  "status": "running"
}

Definições

Nome Description
CloudPropertyJobData

Os dados do trabalho de propriedade de nuvem.

CommandJobData

A definição de dados do trabalho de comando.

DeviceTemplateMigrationJobData

A definição de dados do trabalho de migração do modelo de dispositivo.

Error

A definição de erro de resposta.

ErrorDetails

As informações detalhadas do erro.

Job

A definição do trabalho.

JobBatch

A definição do lote de trabalho.

JobBatchType

Se o envio em lote é feito em um número especificado de dispositivos ou em uma porcentagem do total de dispositivos.

JobCancellationThreshold

A definição do limite de cancelamento do trabalho.

JobCancellationThresholdType

Se o limite de cancelamento é por um número especificado de dispositivos ou uma porcentagem do total de dispositivos.

JobProgress

resumo de progresso de um trabalho agendado.

PropertyJobData

A definição de dados do trabalho de propriedade.

CloudPropertyJobData

Os dados do trabalho de propriedade de nuvem.

Nome Tipo Description
path

string

O caminho para a funcionalidade de destino dentro do modelo de dispositivo.

target

string

O modelo de dispositivo que define a funcionalidade de destino para o trabalho.

type string:

cloudProperty

Tipo dos dados do trabalho.

value

AnyValue

O valor usado para atualizar a funcionalidade de destino, se houver.

CommandJobData

A definição de dados do trabalho de comando.

Nome Tipo Description
path

string

O caminho para a funcionalidade de destino dentro do modelo de dispositivo.

target

string

O modelo de dispositivo que define a funcionalidade de destino para o trabalho.

type string:

command

Tipo dos dados do trabalho.

value

AnyValue

O valor usado para atualizar a funcionalidade de destino, se houver.

DeviceTemplateMigrationJobData

A definição de dados do trabalho de migração do modelo de dispositivo.

Nome Tipo Description
template

string

O modelo de dispositivo de destino para o qual os dispositivos serão migrados.

type string:

deviceTemplateMigration

Tipo dos dados do trabalho.

Error

A definição de erro de resposta.

Nome Tipo Description
error

ErrorDetails

Detalhes do erro da solicitação atual.

ErrorDetails

As informações detalhadas do erro.

Nome Tipo Description
code

string

Código do erro.

message

string

Detalhes da mensagem de erro.

requestId

string

ID de correlação da solicitação atual.

time

string

A hora em que a solicitação de erro falhou.

Job

A definição do trabalho.

Nome Tipo Description
batch

JobBatch

A configuração de envio em lote para o trabalho.

cancellationThreshold

JobCancellationThreshold

O limite de cancelamento para o trabalho.

data JobData[]:

Os recursos que estão sendo atualizados pelo trabalho e os valores com os quais estão sendo atualizados.

description

string

Descrição detalhada do trabalho.

displayName

string

Nome de exibição do trabalho.

end

string

A hora de término do trabalho

group

string

A ID do grupo de dispositivos no qual executar o trabalho.

id

string

A ID exclusiva do trabalho.

organizations

string[]

Lista de organizações do trabalho, apenas uma organização tem suporte hoje, várias organizações terão suporte em breve.

progress

JobProgress

As estatísticas de progresso do trabalho.

scheduledJobId

string

ID da definição de trabalho agendada que criou esse trabalho.

start

string

A hora de início do trabalho

status

string

Indica se o trabalho está sendo iniciado, em execução etc.

JobBatch

A definição do lote de trabalho.

Nome Tipo Description
type

JobBatchType

Se o envio em lote é feito em um número especificado de dispositivos ou em uma porcentagem do total de dispositivos.

value

number

O número ou percentual de dispositivos nos quais o envio em lote é feito.

JobBatchType

Se o envio em lote é feito em um número especificado de dispositivos ou em uma porcentagem do total de dispositivos.

Nome Tipo Description
number

string

Envio em lote de trabalhos com base no número de dispositivos.

percentage

string

Porcentagem baseada em envio em lote de trabalhos do total de dispositivos aplicados.

JobCancellationThreshold

A definição do limite de cancelamento do trabalho.

Nome Tipo Description
batch

boolean

Se o limite de cancelamento se aplica por lote ou ao trabalho geral.

type

JobCancellationThresholdType

Se o limite de cancelamento é por um número especificado de dispositivos ou uma porcentagem do total de dispositivos.

value

number

O número ou percentual de dispositivos nos quais o limite de cancelamento é aplicado.

JobCancellationThresholdType

Se o limite de cancelamento é por um número especificado de dispositivos ou uma porcentagem do total de dispositivos.

Nome Tipo Description
number

string

Limite de cancelamento de trabalho com base no número especificado de dispositivos.

percentage

string

Limite de cancelamento de trabalho com base no percentual do total de dispositivos.

JobProgress

resumo de progresso de um trabalho agendado.

Nome Tipo Description
completed

integer

O número de entidades para as quais o trabalho foi concluído.

failed

integer

O número de entidades para as quais o trabalho falhou.

pending

integer

O número de entidades para as quais o trabalho ainda não está em execução.

total

integer

O número total de entidades direcionadas pelo trabalho.

PropertyJobData

A definição de dados do trabalho de propriedade.

Nome Tipo Description
path

string

O caminho para a funcionalidade de destino dentro do modelo de dispositivo.

target

string

O modelo de dispositivo que define a funcionalidade de destino para o trabalho.

type string:

property

Tipo dos dados do trabalho.

value

AnyValue

O valor usado para atualizar a funcionalidade de destino, se houver.