Sesiones
Crear una sesión
Crear una sesión
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.session.create
Auditoría
La invocación de este método genera los siguientes eventos de auditoría.
quantum-computing.session.create
Entrada
Parámetros del cuerpo
Nombre, Tipo | Descripción |
|---|---|
max_ttl integer | El tiempo máximo (en segundos) de ejecución de la sesión, sujeto a los límites del plan. Valor predeterminado: 28800Valor mínimo: 1Valor máximo: 2147483647 |
mode string | Modo de ejecución para ejecutar la sesión Valores posibles: batchdedicated |
backend string | Nombre del backend |
backend_name string | Nombre del backend (fallback) |
Ejemplos de código
POST
/v1/sessions Si tu instancia se encuentra en la región «eu-de», utiliza en su lugar este enlace: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/sessions
curl -X POST \
'https://quantum.cloud.ibm.com/api/v1/sessions' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR-TOKEN' \
-H 'Service-CRN: YOUR-SERVICE-CRN' \
-H 'IBM-API-Version: 2026-04-15' Si tu instancia se encuentra en la región «eu-de», utiliza en su lugar este enlace: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/sessions
import requests
response = requests.request(
"POST",
"https://quantum.cloud.ibm.com/api/v1/sessions",
headers={
"Accept": "application/json",
"IBM-API-Version": "2026-04-15",
"Authorization": "Bearer YOUR-TOKEN",
"Service-CRN": "YOUR-SERVICE-CRN"
},
)
print(response.json())Resultado
Código de estado | Descripción |
|---|---|
| 200 | Aceptar |
| 400 | Solicitud errónea |
| 401 | No autorizado |
| 500 | Error interno |
Respuestas
{
"id": "example",
"backend_name": "example",
"started_at": "example",
"activated_at": "example",
"closed_at": "example",
"last_job_started": "example",
"last_job_completed": "example",
"interactive_ttl": 1,
"max_ttl": 1,
"active_ttl": 1,
"state": "open",
"state_reason": "example",
"accepting_jobs": true,
"mode": "batch",
"timestamps": [
{
"status": "open",
"timestamp": "example"
}
],
"user_id": "example",
"elapsed_time": 1.432
}{
"type": "object",
"description": "Sesión de trabajo",
"properties": {
"id": {
"type": "string",
"description": "ID de trabajo"
},
"backend_name": {
"type": "string",
"description": "Nombre del backend. No puede activarse cuando está en estado \"abierto\".",
"nullable": true
},
"started_at": {
"type": "string",
"format": "date-time",
"description": "Hora de inicio de la sesión"
},
"activated_at": {
"type": "string",
"format": "date-time",
"description": "Marca de tiempo de cuando el estado de la sesión fue cambiado a activo"
},
"closed_at": {
"type": "string",
"format": "date-time",
"description": "Hora de cierre de la sesión"
},
"last_job_started": {
"type": "string",
"format": "date-time",
"description": "Fecha de inicio del último trabajo de la sesión"
},
"last_job_completed": {
"type": "string",
"format": "date-time",
"description": "Fecha de finalización del último trabajo de la sesión"
},
"interactive_ttl": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 2147483647,
"description": "El tiempo máximo (en segundos) entre trabajos para mantener la sesión activa"
},
"max_ttl": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 2147483647,
"description": "El tiempo máximo (en segundos) de ejecución de la sesión, sujeto a los límites del plan"
},
"active_ttl": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 2147483647,
"description": "El tiempo restante (en segundos) para que la sesión esté en estado activo mientras se ejecutan trabajos."
},
"state": {
"type": "string",
"enum": [
"open",
"active",
"inactive",
"closed"
],
"description": "El estado de la sesión.\n\n* abierta: La sesión está esperando para ejecutar trabajos.\n* activa: La sesión tiene prioridad para ejecutar trabajos en el backend y está ejecutando trabajos o está esperando a que se ejecuten más trabajos.\n* inactiva: La sesión no tiene prioridad y no está ejecutando ningún trabajo.\n* cerrada: La sesión no está ejecutando ningún trabajo y no aceptará/ejecutará nuevos trabajos."
},
"state_reason": {
"type": "string",
"description": "El motivo del cambio de estado."
},
"accepting_jobs": {
"type": "boolean",
"description": "Si es verdadero, la sesión está aceptando activamente nuevos trabajos para poner en cola. Si es false, los trabajos se rechazarán al crearse y la sesión se cerrará inmediatamente cuando no haya más trabajos que ejecutar en la sesión."
},
"mode": {
"type": "string",
"description": "Modo de ejecución para ejecutar la sesión",
"enum": [
"batch",
"dedicated"
]
},
"timestamps": {
"type": "array",
"items": {
"type": "object",
"description": "Contiene información sobre el momento en que se produjo una transición de estado específica",
"properties": {
"status": {
"type": "string",
"enum": [
"open",
"active",
"inactive",
"closed"
],
"description": "El estado de la sesión.\n\n* abierta: La sesión está esperando para ejecutar trabajos.\n* activa: La sesión tiene prioridad para ejecutar trabajos en el backend y está ejecutando trabajos o está esperando a que se ejecuten más trabajos.\n* inactiva: La sesión no tiene prioridad y no está ejecutando ningún trabajo.\n* cerrada: La sesión no está ejecutando ningún trabajo y no aceptará/ejecutará nuevos trabajos."
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Marca de tiempo de cuando la sesión pasó al estado dado"
}
},
"required": [
"status",
"timestamp"
]
}
},
"user_id": {
"type": "string",
"description": "El id del usuario que creó la sesión."
},
"elapsed_time": {
"type": "number",
"description": "Uso en segundos. Puede ser nulo para sesiones continuas.",
"example": 1.432
}
},
"required": [
"id",
"backend_name",
"mode"
]
}Conseguir una sesión
Conseguir una sesión
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.session.read
Auditoría
La invocación de este método genera los siguientes eventos de auditoría.
quantum-computing.session.read
Entrada
Nombre, Tipo | Descripción |
|---|---|
id Obligatorio string | ID de sesión de trabajo |
Ejemplos de código
GET
/v1/sessions/{id} Si tu instancia se encuentra en la región «eu-de», utiliza en su lugar este enlace: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/sessions/{id}
curl -X GET \
'https://quantum.cloud.ibm.com/api/v1/sessions/{id}' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR-TOKEN' \
-H 'Service-CRN: YOUR-SERVICE-CRN' \
-H 'IBM-API-Version: 2026-04-15' Si tu instancia se encuentra en la región «eu-de», utiliza en su lugar este enlace: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/sessions/{id}
import requests
response = requests.request(
"GET",
"https://quantum.cloud.ibm.com/api/v1/sessions/{id}",
headers={
"Accept": "application/json",
"IBM-API-Version": "2026-04-15",
"Authorization": "Bearer YOUR-TOKEN",
"Service-CRN": "YOUR-SERVICE-CRN"
},
)
print(response.json())Resultado
Código de estado | Descripción |
|---|---|
| 200 | Aceptar |
| 401 | No autorizado |
| 404 | No se ha encontrado |
| 500 | Error interno |
Respuestas
{
"id": "example",
"backend_name": "example",
"started_at": "example",
"activated_at": "example",
"closed_at": "example",
"last_job_started": "example",
"last_job_completed": "example",
"interactive_ttl": 1,
"max_ttl": 1,
"active_ttl": 1,
"state": "open",
"state_reason": "example",
"accepting_jobs": true,
"mode": "batch",
"timestamps": [
{
"status": "open",
"timestamp": "example"
}
],
"user_id": "example",
"elapsed_time": 1.432
}{
"type": "object",
"description": "Sesión de trabajo",
"properties": {
"id": {
"type": "string",
"description": "ID de trabajo"
},
"backend_name": {
"type": "string",
"description": "Nombre del backend. No puede activarse cuando está en estado \"abierto\".",
"nullable": true
},
"started_at": {
"type": "string",
"format": "date-time",
"description": "Hora de inicio de la sesión"
},
"activated_at": {
"type": "string",
"format": "date-time",
"description": "Marca de tiempo de cuando el estado de la sesión fue cambiado a activo"
},
"closed_at": {
"type": "string",
"format": "date-time",
"description": "Hora de cierre de la sesión"
},
"last_job_started": {
"type": "string",
"format": "date-time",
"description": "Fecha de inicio del último trabajo de la sesión"
},
"last_job_completed": {
"type": "string",
"format": "date-time",
"description": "Fecha de finalización del último trabajo de la sesión"
},
"interactive_ttl": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 2147483647,
"description": "El tiempo máximo (en segundos) entre trabajos para mantener la sesión activa"
},
"max_ttl": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 2147483647,
"description": "El tiempo máximo (en segundos) de ejecución de la sesión, sujeto a los límites del plan"
},
"active_ttl": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 2147483647,
"description": "El tiempo restante (en segundos) para que la sesión esté en estado activo mientras se ejecutan trabajos."
},
"state": {
"type": "string",
"enum": [
"open",
"active",
"inactive",
"closed"
],
"description": "El estado de la sesión.\n\n* abierta: La sesión está esperando para ejecutar trabajos.\n* activa: La sesión tiene prioridad para ejecutar trabajos en el backend y está ejecutando trabajos o está esperando a que se ejecuten más trabajos.\n* inactiva: La sesión no tiene prioridad y no está ejecutando ningún trabajo.\n* cerrada: La sesión no está ejecutando ningún trabajo y no aceptará/ejecutará nuevos trabajos."
},
"state_reason": {
"type": "string",
"description": "El motivo del cambio de estado."
},
"accepting_jobs": {
"type": "boolean",
"description": "Si es verdadero, la sesión está aceptando activamente nuevos trabajos para poner en cola. Si es false, los trabajos se rechazarán al crearse y la sesión se cerrará inmediatamente cuando no haya más trabajos que ejecutar en la sesión."
},
"mode": {
"type": "string",
"description": "Modo de ejecución para ejecutar la sesión",
"enum": [
"batch",
"dedicated"
]
},
"timestamps": {
"type": "array",
"items": {
"type": "object",
"description": "Contiene información sobre el momento en que se produjo una transición de estado específica",
"properties": {
"status": {
"type": "string",
"enum": [
"open",
"active",
"inactive",
"closed"
],
"description": "El estado de la sesión.\n\n* abierta: La sesión está esperando para ejecutar trabajos.\n* activa: La sesión tiene prioridad para ejecutar trabajos en el backend y está ejecutando trabajos o está esperando a que se ejecuten más trabajos.\n* inactiva: La sesión no tiene prioridad y no está ejecutando ningún trabajo.\n* cerrada: La sesión no está ejecutando ningún trabajo y no aceptará/ejecutará nuevos trabajos."
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Marca de tiempo de cuando la sesión pasó al estado dado"
}
},
"required": [
"status",
"timestamp"
]
}
},
"user_id": {
"type": "string",
"description": "El id del usuario que creó la sesión."
},
"elapsed_time": {
"type": "number",
"description": "Uso en segundos. Puede ser nulo para sesiones continuas.",
"example": 1.432
}
},
"required": [
"id",
"backend_name",
"mode"
]
}Actualizar una sesión
Actualizar una sesión
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.session.update
Auditoría
La invocación de este método genera los siguientes eventos de auditoría.
quantum-computing.session.update
Entrada
Nombre, Tipo | Descripción |
|---|---|
id Obligatorio string | ID de sesión de trabajo |
Nombre, Tipo | Descripción |
|---|---|
accepting_jobs Obligatorio boolean | Si es verdadero, la sesión está aceptando activamente nuevos trabajos para poner en cola. Si es false, los trabajos se rechazarán al crearse y la sesión se cerrará inmediatamente cuando no haya más trabajos que ejecutar en la sesión. |
Ejemplos de código
PATCH
/v1/sessions/{id} Si tu instancia se encuentra en la región «eu-de», utiliza en su lugar este enlace: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/sessions/{id}
curl -X PATCH \
'https://quantum.cloud.ibm.com/api/v1/sessions/{id}' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR-TOKEN' \
-H 'Service-CRN: YOUR-SERVICE-CRN' \
-H 'IBM-API-Version: 2026-04-15' \
-H 'Content-Type: application/json' \
-d '{"accepting_jobs":true}' Si tu instancia se encuentra en la región «eu-de», utiliza en su lugar este enlace: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/sessions/{id}
import requests
response = requests.request(
"PATCH",
"https://quantum.cloud.ibm.com/api/v1/sessions/{id}",
headers={
"Accept": "application/json",
"IBM-API-Version": "2026-04-15",
"Authorization": "Bearer YOUR-TOKEN",
"Service-CRN": "YOUR-SERVICE-CRN",
"Content-Type": "application/json"
},
data="{\"accepting_jobs\":true}"
)
print(response.json())Resultado
Código de estado | Descripción |
|---|---|
| 204 | Sesión actualizada correctamente |
| 401 | No autorizado |
| 404 | No se ha encontrado |
| 500 | Error interno |
Respuestas
Sesión actualizada correctamente
Sesión actualizada correctamente
Cerrar sesión de trabajo
Cierra la sesión en tiempo de ejecución. La sesión deja de aceptar nuevos trabajos y los trabajos en cola no se ejecutarán.
Los trabajos en curso se ejecutarán hasta su finalización. Es análoga a la función cancel() de Qiskit.
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.session.update
Auditoría
La invocación de este método genera los siguientes eventos de auditoría.
quantum-computing.session.update
Entrada
Nombre, Tipo | Descripción |
|---|---|
id Obligatorio string | ID de sesión |
Ejemplos de código
DELETE
/v1/sessions/{id}/close Si tu instancia se encuentra en la región «eu-de», utiliza en su lugar este enlace: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/sessions/{id}/close
curl -X DELETE \
'https://quantum.cloud.ibm.com/api/v1/sessions/{id}/close' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR-TOKEN' \
-H 'Service-CRN: YOUR-SERVICE-CRN' \
-H 'IBM-API-Version: 2026-04-15' Si tu instancia se encuentra en la región «eu-de», utiliza en su lugar este enlace: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/sessions/{id}/close
import requests
response = requests.request(
"DELETE",
"https://quantum.cloud.ibm.com/api/v1/sessions/{id}/close",
headers={
"Accept": "application/json",
"IBM-API-Version": "2026-04-15",
"Authorization": "Bearer YOUR-TOKEN",
"Service-CRN": "YOUR-SERVICE-CRN"
},
)
print(response.json())Resultado
Código de estado | Descripción |
|---|---|
| 204 | Se ha cerrado correctamente la sesión de ejecución |
Respuestas
Se ha cerrado correctamente la sesión de ejecución
Se ha cerrado correctamente la sesión de ejecución
¿Le ha resultado útil esta página?
Informe de un error, de una errata o solicite contenido en GitHub.