Skip to main content
IBM Quantum Platform
Esta API REST solo está disponible para los miembros del Plan On-Prem que la hayan activado en su entorno.

Trabajos

Ejecución de un trabajo

Invocar una primitiva « Qiskit Runtime ».

Autorización

Para llamar a este método, debe tener asignados uno o varios roles de acceso IAM que incluyan las siguientes acciones. Para comprobar su acceso, vaya a Users > User > Access

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

Auditoría

La invocación de este método genera los siguientes eventos de auditoría.

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

Entrada

Parámetros del cuerpo
Nombre, Tipo
Descripción
backend
Obligatorio
string

Nombre del backend

Ejemplo: "ibm_rensselaer"
id
Obligatorio
string

Identificador del trabajo. Se recomienda utilizar UUID

log_level
string

Nivel de registro del programa

Valores posibles: infodebugwarningerrorcritical
Valor predeterminado: warning
program_id
Obligatorio
string

ID del programa

Ejemplo: "sampler"
storage
Obligatorio
object
timeout_secs
Obligatorio
integer

Tiempo (en segundos) tras el cual el trabajo debe agotarse y cancelarse. Se basa en el tiempo de ejecución del sistema (no en el tiempo real). El tiempo de ejecución del sistema es el tiempo que el sistema dedica a procesar su trabajo.

Ejemplos 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":{}}'

Resultado

Códigos de estado de la respuesta de HTTP
Código de estado
Descripción
204Devuelto cuando el trabajo se envió correctamente.
400Se devuelve cuando se recibe una entrada no válida.
401Devuelto cuando falló la autenticación.
404Devuelto cuando no se encontró el backend
408Devuelto cuando la solicitud tardó demasiado en leerse.
409Devuelto cuando se envió un trabajo duplicado con el mismo ID de trabajo.
413Se devuelve cuando el cuerpo de la solicitud es demasiado grande.
422Devuelto cuando falla la validación de la solicitud. El mensaje de error contiene detalles sobre el error de validación específico.
423El backend solicitado está reservado y no se pueden ejecutar trabajos fuera de la reserva.
429Se devuelve cuando se alcanza el límite de trabajos simultáneos por backend. Vuelve a intentarlo más tarde, una vez que finalicen los trabajos existentes, y elimina los trabajos finalizados para enviar más.
Respuestas
Devuelto cuando el trabajo se envió correctamente.

Obtener trabajos

Obtiene una lista de todos los trabajos enviados por el cliente autenticado actual, ordenados por fecha de creación en orden ascendente.

Autorización

Para llamar a este método, debe tener asignados uno o varios roles de acceso IAM que incluyan las siguientes acciones. Para comprobar su acceso, vaya a Users > User > Access

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

Auditoría

La invocación de este método genera los siguientes eventos de auditoría.

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

Entrada

Información
Este punto final no acepta entradas.
Ejemplos de código
GET
/v1/jobs
curl -X GET \
  '<YOUR_QSA_URL>/v1/jobs' \
  -H 'Accept: application/json'

Resultado

Códigos de estado de la respuesta de HTTP
Código de estado
Descripción
200Devuelto cuando los trabajos se recuperaron correctamente.
401Devuelto cuando falló la autenticación.
Respuestas
{
  "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
      }
    }
  ]
}

Buscar trabajo por ID

Recupera un único trabajo por su identificador único para el cliente autenticado actual.

Autorización

Para llamar a este método, debe tener asignados uno o varios roles de acceso IAM que incluyan las siguientes acciones. Para comprobar su acceso, vaya a Users > User > Access

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

Auditoría

La invocación de este método genera los siguientes eventos de auditoría.

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

Entrada

Parámetros de vía de acceso
Nombre, Tipo
Descripción
job-id
Obligatorio
string
Ejemplos de código
GET
/v1/jobs/{job-id}
curl -X GET \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}' \
  -H 'Accept: application/json'

Resultado

Códigos de estado de la respuesta de HTTP
Código de estado
Descripción
200Trabajo recuperado correctamente.
401Devuelto cuando falló la autenticación.
404No se ha encontrado ningún trabajo para el ID proporcionado que pertenece al cliente autenticado.
Respuestas
{
  "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
  }
}

Suprimir un trabajo

Elimina un trabajo si ha finalizado.

Autorización

Para llamar a este método, debe tener asignados uno o varios roles de acceso IAM que incluyan las siguientes acciones. Para comprobar su acceso, vaya a Users > User > Access

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

Auditoría

La invocación de este método genera los siguientes eventos de auditoría.

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

Entrada

Parámetros de vía de acceso
Nombre, Tipo
Descripción
job-id
Obligatorio
string
Ejemplos de código
DELETE
/v1/jobs/{job-id}
curl -X DELETE \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}' \
  -H 'Accept: application/json'

Resultado

Códigos de estado de la respuesta de HTTP
Código de estado
Descripción
204Devuelto cuando el trabajo se eliminó correctamente.
401Devuelto cuando falló la autenticación.
404Se devuelve cuando no se encuentra el trabajo.
409Se devuelve cuando un trabajo aún no ha finalizado y debe cancelarse antes de poder eliminarse.
Respuestas
Devuelto cuando el trabajo se eliminó correctamente.

Cancele un trabajo

Cancela un trabajo si aún no ha finalizado.

Autorización

Para llamar a este método, debe tener asignados uno o varios roles de acceso IAM que incluyan las siguientes acciones. Para comprobar su acceso, vaya a Users > User > Access

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

Auditoría

La invocación de este método genera los siguientes eventos de auditoría.

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

Entrada

Parámetros de vía de acceso
Nombre, Tipo
Descripción
job-id
Obligatorio
string
Ejemplos de código
POST
/v1/jobs/{job-id}/cancel
curl -X POST \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}/cancel' \
  -H 'Accept: application/json'

Resultado

Códigos de estado de la respuesta de HTTP
Código de estado
Descripción
204Devuelto cuando la solicitud de cancelación del trabajo se envió correctamente.
401Devuelto cuando falló la autenticación.
404Se devuelve cuando no se encuentra el trabajo.
409Se devuelve cuando un trabajo ya ha finalizado y no se puede cancelar.
500Se devuelve cuando se produce un error interno del servidor.
Respuestas
Devuelto cuando la solicitud de cancelación del trabajo se envió correctamente.
¿Le ha resultado útil esta página?
Informe de un error, de una errata o solicite contenido en GitHub.