Skip to main content
IBM Quantum Platform
Esta API de REST está disponível apenas para membros do On-Prem Plan que a ativaram em seu ambiente.

Tarefas

Execute uma tarefa

Invocar uma primitiva Qiskit Runtime.

Autorização

Para chamar esse método, deve-se ter sido designado a uma ou mais funções de acesso do IAM que incluam as ações a seguir. É possível verificar seu acesso indo para Users > User > Access

  • quantum-computing.direct-access-job.create

Auditoria

A chamada desse método gera os seguintes eventos de auditoria.

  • quantum-computing.direct-access-job.create

Entrada

Parâmetros do corpo
Nome, Tipo
Descrição
backend
Necessário
string

Nome do backend

Exemplo: "ibm_rensselaer"
id
Necessário
string

Identificador da tarefa. Recomendado para ser UUID

log_level
string

Nível de registro do programa

Valores possíveis: infodebugwarningerrorcritical
Valor Padrão: warning
program_id
Necessário
string

ID do programa

Exemplo: "sampler"
storage
Necessário
object
timeout_secs
Necessário
integer

Tempo (em segundos) após o qual a tarefa deve expirar e ser cancelada. Baseia-se no tempo de execução do sistema (não no tempo do relógio). O tempo de execução do sistema é o tempo que o sistema dedica ao processamento do seu trabalho.

Amostras de código
POST
/v1/jobs
curl -X POST \
  '<YOUR_QSA_URL>/v1/jobs' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{"id":"example","program_id":"sampler","backend":"ibm_rensselaer","timeout_secs":1,"storage":{}}'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
204Retornado quando o trabalho foi enviado com sucesso.
400Retornado quando uma entrada inválida é recebida.
401Retornado quando a autenticação falhou.
404Retornado quando o backend não foi encontrado
408Retornado quando a solicitação demorou muito para ser lida.
409Retornado quando um trabalho duplicado com o mesmo ID de trabalho foi enviado.
413Retornado quando o corpo da solicitação é muito grande.
422Retornado quando a validação da solicitação falhou. A mensagem de erro contém detalhes sobre o erro de validação específico.
423O backend solicitado está reservado e os trabalhos fora da reserva não podem ser executados.
429Retornado quando o limite de tarefas simultâneas por backend foi atingido. Tente novamente mais tarde, quando os trabalhos existentes forem concluídos, e exclua os trabalhos concluídos para enviar mais.
Respostas
Retornado quando o trabalho foi enviado com sucesso.

Obter Tarefas

Busca uma lista de todos os trabalhos enviados pelo cliente autenticado atual, ordenados por data de criação em ordem crescente.

Autorização

Para chamar esse método, deve-se ter sido designado a uma ou mais funções de acesso do IAM que incluam as ações a seguir. É possível verificar seu acesso indo para Users > User > Access

  • quantum-computing.direct-access-job.list

Auditoria

A chamada desse método gera os seguintes eventos de auditoria.

  • quantum-computing.direct-access-job.list

Entrada

Informação
Este endpoint não aceita nenhuma entrada.
Amostras de código
GET
/v1/jobs
curl -X GET \
  '<YOUR_QSA_URL>/v1/jobs' \
  -H 'Accept: application/json'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
200Retornado quando os trabalhos foram recuperados com sucesso.
401Retornado quando a autenticação falhou.
Respostas
{
  "jobs": [
    {
      "backend": "ibm_rensselaer",
      "created_time": "example",
      "end_time": "example",
      "id": "example",
      "log_level": "info",
      "metrics": {
        "circuits_execution_time_ns": 1,
        "timestamps": {
          "created": "example",
          "finished": "example"
        }
      },
      "program_id": "sampler",
      "reason_code": 1,
      "reason_message": "example",
      "reason_solution": "example",
      "status": "Running",
      "storage": {
        "input": {
          "bucket_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket",
          "object_name": "example",
          "presigned_url": "example",
          "region": "us-east",
          "region_type": "regional",
          "runtime_instance_crn": "crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::",
          "type": "s3_compatible"
        },
        "logs": {
          "bucket_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket",
          "object_name": "example",
          "presigned_url": "example",
          "region": "us-east",
          "region_type": "regional",
          "runtime_instance_crn": "crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::",
          "type": "s3_compatible"
        },
        "results": {
          "bucket_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket",
          "object_name": "example",
          "presigned_url": "example",
          "region": "us-east",
          "region_type": "regional",
          "runtime_instance_crn": "crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::",
          "type": "s3_compatible"
        }
      },
      "timeout_secs": 1,
      "usage": {
        "quantum_nanoseconds": 1
      }
    }
  ]
}

Obter emprego por ID

Busca uma única tarefa pelo seu identificador exclusivo para o cliente autenticado atual.

Autorização

Para chamar esse método, deve-se ter sido designado a uma ou mais funções de acesso do IAM que incluam as ações a seguir. É possível verificar seu acesso indo para Users > User > Access

  • quantum-computing.direct-access-job.read

Auditoria

A chamada desse método gera os seguintes eventos de auditoria.

  • quantum-computing.direct-access-job.read

Entrada

Parâmetros de caminho
Nome, Tipo
Descrição
job-id
Necessário
string
Amostras de código
GET
/v1/jobs/{job-id}
curl -X GET \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}' \
  -H 'Accept: application/json'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
200Trabalho recuperado com sucesso.
401Retornado quando a autenticação falhou.
404Nenhum trabalho encontrado para o ID fornecido pertencente ao cliente autenticado.
Respostas
{
  "backend": "ibm_rensselaer",
  "created_time": "example",
  "end_time": "example",
  "id": "example",
  "log_level": "info",
  "metrics": {
    "circuits_execution_time_ns": 1,
    "timestamps": {
      "created": "example",
      "finished": "example"
    }
  },
  "program_id": "sampler",
  "reason_code": 1,
  "reason_message": "example",
  "reason_solution": "example",
  "status": "Running",
  "storage": {
    "input": {
      "bucket_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket",
      "object_name": "example",
      "presigned_url": "example",
      "region": "us-east",
      "region_type": "regional",
      "runtime_instance_crn": "crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::",
      "type": "s3_compatible"
    },
    "logs": {
      "bucket_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket",
      "object_name": "example",
      "presigned_url": "example",
      "region": "us-east",
      "region_type": "regional",
      "runtime_instance_crn": "crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::",
      "type": "s3_compatible"
    },
    "results": {
      "bucket_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket",
      "object_name": "example",
      "presigned_url": "example",
      "region": "us-east",
      "region_type": "regional",
      "runtime_instance_crn": "crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::",
      "type": "s3_compatible"
    }
  },
  "timeout_secs": 1,
  "usage": {
    "quantum_nanoseconds": 1
  }
}

Exclua uma tarefa

Exclui um trabalho se ele tiver sido encerrado.

Autorização

Para chamar esse método, deve-se ter sido designado a uma ou mais funções de acesso do IAM que incluam as ações a seguir. É possível verificar seu acesso indo para Users > User > Access

  • quantum-computing.direct-access-job.delete

Auditoria

A chamada desse método gera os seguintes eventos de auditoria.

  • quantum-computing.direct-access-job.delete

Entrada

Parâmetros de caminho
Nome, Tipo
Descrição
job-id
Necessário
string
Amostras de código
DELETE
/v1/jobs/{job-id}
curl -X DELETE \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}' \
  -H 'Accept: application/json'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
204Retornado quando o trabalho foi excluído com sucesso.
401Retornado quando a autenticação falhou.
404Retornado quando o trabalho não é encontrado.
409Retornado quando uma tarefa ainda não foi concluída e precisa ser cancelada antes de poder ser excluída.
Respostas
Retornado quando o trabalho foi excluído com sucesso.

Cancelar uma Tarefa

Cancela um trabalho se ele ainda não tiver sido concluído.

Autorização

Para chamar esse método, deve-se ter sido designado a uma ou mais funções de acesso do IAM que incluam as ações a seguir. É possível verificar seu acesso indo para Users > User > Access

  • quantum-computing.direct-access-job.cancel

Auditoria

A chamada desse método gera os seguintes eventos de auditoria.

  • quantum-computing.direct-access-job.cancel

Entrada

Parâmetros de caminho
Nome, Tipo
Descrição
job-id
Necessário
string
Amostras de código
POST
/v1/jobs/{job-id}/cancel
curl -X POST \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}/cancel' \
  -H 'Accept: application/json'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
204Retornado quando a solicitação de cancelamento da tarefa foi enviada com sucesso.
401Retornado quando a autenticação falhou.
404Retornado quando o trabalho não é encontrado.
409Retornado quando uma tarefa já foi encerrada e não pode ser cancelada.
500Retornado quando ocorre um erro interno do servidor.
Respostas
Retornado quando a solicitação de cancelamento da tarefa foi enviada com sucesso.
Esta página foi útil?
Relate um bug, erro de digitação ou solicite conteúdo no GitHub.