Skip to main content
IBM Quantum Platform

Instâncias


Obter detalhes da instância atual

Retorna os detalhes da instância atual conectada, usando o CRN do cabeçalho da solicitaçã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.instance.read

Auditoria

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

  • quantum-computing.instance.read

Entrada

Informação
Este endpoint não aceita nenhuma entrada.
Amostras de código
GET
/v1/instance

Se sua instância estiver na região eu-de, use este link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/instance

curl -X GET \
  'https://quantum.cloud.ibm.com/api/v1/instance' \
  -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
403Proibido
404Não encontrado
Respostas
{
  "backends": [
    "ibm_backend"
  ],
  "instance_limit": 60.7,
  "instance_limit_seconds": "61",
  "plan_id": "flex-plan-id-1",
  "usage_allocation_seconds": "200"
}

Obter a configuração da instância

Retorna a configuração da instância especificada, por exemplo, o limite da instância em segundos, usando o CRN do cabeçalho da solicitaçã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.instance.configuration.read

Auditoria

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

  • quantum-computing.instance.configuration.read

Entrada

Informação
Este endpoint não aceita nenhuma entrada.
Amostras de código
GET
/v1/instances/configuration

Se sua instância estiver na região eu-de, use este link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/instances/configuration

curl -X GET \
  'https://quantum.cloud.ibm.com/api/v1/instances/configuration' \
  -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
403Proibido
404Não encontrado
Respostas
{
  "instance_limit": 123456
}

Atualizar a configuração da instância

Atualiza a configuração da instância especificada, por exemplo, o limite da instância em segundos, usando o CRN dos parâmetros de contexto da solicitaçã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.instance.configuration.update

Auditoria

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

  • quantum-computing.instance.configuration.update

Entrada

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

Esse campo pode ser nulo ou um número inteiro. Use null para redefinir/remover o limite da instância.

Valor mínimo: 1
Valor máximo: 2147483647
Amostras de código
PUT
/v1/instances/configuration

Se sua instância estiver na região eu-de, use este link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/instances/configuration

curl -X PUT \
  'https://quantum.cloud.ibm.com/api/v1/instances/configuration' \
  -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
204Ok
400Solicitação inválida
401Desautorizado
403Proibido
404Não encontrado
409O uso excede o limite da instância
Respostas
Ok

Obter o uso da instância

Obter o uso da instância

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.instance-usage.read

Auditoria

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

  • quantum-computing.instance-usage.read

Entrada

Informação
Este endpoint não aceita nenhuma entrada.
Amostras de código
GET
/v1/instances/usage

Se sua instância estiver na região eu-de, use este link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/instances/usage

curl -X GET \
  'https://quantum.cloud.ibm.com/api/v1/instances/usage' \
  -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
200
401Desautorizado
Respostas
{
  "instance_id": "example",
  "plan_id": "example",
  "usage_period": {
    "start_time": "example",
    "end_time": "example"
  },
  "usage_consumed_seconds": 12,
  "usage_limit_seconds": 60,
  "usage_allocation_seconds": 120,
  "usage_limit_reached": true,
  "time_available_at": "2024-01-01T00:00:00.000Z"
}
Esta página foi útil?
Relate um bug, erro de digitação ou solicite conteúdo no GitHub.