Skip to main content
IBM Quantum Platform

Sessões

Criar uma sessão

Criar uma sessão

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.session.create

Auditoria

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

  • quantum-computing.session.create

Entrada

Parâmetros do corpo
Nome, Tipo
Descrição
max_ttl
integer

O tempo máximo (em segundos) para a execução da sessão, sujeito aos limites do plano.

Valor Padrão: 28800
Valor mínimo: 1
Valor máximo: 2147483647
mode
string

Modo de execução para executar a sessão

Valores possíveis: batchdedicated
backend
string

Nome do backend

backend_name
string

Nome do backend (fallback)

Amostras de código
POST
/v1/sessions

Se sua instância estiver na região eu-de, use este link: 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'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
200OK
400Solicitação inválida
401Desautorizado
500Erro interno
Respostas
{
  "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
}

Obter uma sessão

Obter uma sessão

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.session.read

Auditoria

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

  • quantum-computing.session.read

Entrada

Parâmetros de caminho
Nome, Tipo
Descrição
id
Necessário
string

ID da sessão de trabalho

Amostras de código
GET
/v1/sessions/{id}

Se sua instância estiver na região eu-de, use este link: 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'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
200Ok
401Desautorizado
404Não encontrado
500Erro interno
Respostas
{
  "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
}

Atualizar uma sessão

Atualizar uma sessão

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.session.update

Auditoria

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

  • quantum-computing.session.update

Entrada

Parâmetros de caminho
Nome, Tipo
Descrição
id
Necessário
string

ID da sessão de trabalho

Parâmetros do corpo
Nome, Tipo
Descrição
accepting_jobs
Necessário
boolean

Se verdadeiro, a sessão está aceitando ativamente novos trabalhos para serem enfileirados. Se for falso, os trabalhos serão rejeitados na criação e a sessão será imediatamente fechada quando não houver mais trabalhos a serem executados na sessão.

Amostras de código
PATCH
/v1/sessions/{id}

Se sua instância estiver na região eu-de, use este link: 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}'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
204Sessão atualizada com sucesso
401Desautorizado
404Não encontrado
500Erro interno
Respostas
Sessão atualizada com sucesso

Fechar sessão de trabalho

Fecha a sessão de tempo de execução. A sessão para de aceitar novos trabalhos e os trabalhos em fila não serão executados. Os trabalhos em execução existentes serão executados até a conclusão. Isso é análogo à função cancel() no Qiskit.

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.session.update

Auditoria

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

  • quantum-computing.session.update

Entrada

Parâmetros de caminho
Nome, Tipo
Descrição
id
Necessário
string

ID de sessão

Amostras de código
DELETE
/v1/sessions/{id}/close

Se sua instância estiver na região eu-de, use este link: 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'

Saída

Códigos de status de resposta HTTP
Código de status
Descrição
204Sessão de tempo de execução encerrada com sucesso
Respostas
Sessão de tempo de execução encerrada com sucesso
Esta página foi útil?
Relate um bug, erro de digitação ou solicite conteúdo no GitHub.