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. |
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' Se sua instância estiver na região eu-de, use este link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/instance
import requests
response = requests.request(
"GET",
"https://quantum.cloud.ibm.com/api/v1/instance",
headers={
"Accept": "application/json",
"IBM-API-Version": "2026-04-15",
"Authorization": "Bearer YOUR-TOKEN",
"Service-CRN": "YOUR-SERVICE-CRN"
},
)
print(response.json())Saída
Código de status | Descrição |
|---|---|
| 200 | Ok |
| 401 | Desautorizado |
| 403 | Proibido |
| 404 | Não encontrado |
{
"backends": [
"ibm_backend"
],
"instance_limit": 60.7,
"instance_limit_seconds": "61",
"plan_id": "flex-plan-id-1",
"usage_allocation_seconds": "200"
}{
"type": "object",
"description": "Instância",
"properties": {
"backends": {
"type": "array",
"description": "Lista de sistemas back-end ou clusters associados à instância de serviço",
"items": {
"type": "string",
"pattern": "^.*$",
"minLength": 1,
"maxLength": 128,
"nullable": false
},
"minItems": 0,
"maxItems": 100
},
"instance_limit": {
"type": "number",
"format": "double",
"description": "Representa os limites da instância em segundos; será substituído por instance\\_limit\\_seconds",
"deprecated": true
},
"instance_limit_seconds": {
"type": "string",
"description": "Especifica o número máximo de tempo de recursos que podem ser executados nessa instância"
},
"plan_id": {
"type": "string",
"description": "Identificador do plano de serviço associado à instância, conforme definido no Catálogo Global",
"pattern": "^.*$",
"minLength": 1,
"maxLength": 128
},
"usage_allocation_seconds": {
"type": "string",
"description": "A soma máxima da alocação de uso permitida na instância."
}
}
}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. |
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' 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
import requests
response = requests.request(
"GET",
"https://quantum.cloud.ibm.com/api/v1/instances/configuration",
headers={
"Accept": "application/json",
"IBM-API-Version": "2026-04-15",
"Authorization": "Bearer YOUR-TOKEN",
"Service-CRN": "YOUR-SERVICE-CRN"
},
)
print(response.json())Saída
Código de status | Descrição |
|---|---|
| 200 | Ok |
| 401 | Desautorizado |
| 403 | Proibido |
| 404 | Não encontrado |
{
"instance_limit": 123456
}{
"type": "object",
"description": "Configuração da instância",
"properties": {
"instance_limit": {
"type": "number",
"format": "double",
"description": "Limite de uso da instância em segundos"
}
}
}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
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: 1Valor máximo: 2147483647 |
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' 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
import requests
response = requests.request(
"PUT",
"https://quantum.cloud.ibm.com/api/v1/instances/configuration",
headers={
"Accept": "application/json",
"IBM-API-Version": "2026-04-15",
"Authorization": "Bearer YOUR-TOKEN",
"Service-CRN": "YOUR-SERVICE-CRN"
},
)
print(response.json())Saída
Código de status | Descrição |
|---|---|
| 204 | Ok |
| 400 | Solicitação inválida |
| 401 | Desautorizado |
| 403 | Proibido |
| 404 | Não encontrado |
| 409 | O uso excede o limite da instância |
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. |
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' 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
import requests
response = requests.request(
"GET",
"https://quantum.cloud.ibm.com/api/v1/instances/usage",
headers={
"Accept": "application/json",
"IBM-API-Version": "2026-04-15",
"Authorization": "Bearer YOUR-TOKEN",
"Service-CRN": "YOUR-SERVICE-CRN"
},
)
print(response.json())Saída
Código de status | Descrição |
|---|---|
| 200 | |
| 401 | Desautorizado |
{
"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"
}{
"type": "object",
"properties": {
"instance_id": {
"type": "string"
},
"plan_id": {
"type": "string"
},
"usage_period": {
"description": "Horário de início e término do período de uso",
"allOf": [
{
"type": "object",
"properties": {
"start_time": {
"format": "date-time",
"type": "string",
"description": "A hora de início do uso"
},
"end_time": {
"format": "date-time",
"type": "string",
"description": "O horário de término do uso"
}
}
}
]
},
"usage_consumed_seconds": {
"type": "number",
"example": 12,
"description": "Uso consumido no período de uso atual"
},
"usage_limit_seconds": {
"type": "number",
"example": 60,
"description": "O limite de uso em segundos durante o período de uso"
},
"usage_allocation_seconds": {
"type": "number",
"example": 120,
"description": "Os segundos que são alocados para a instância durante o período de uso"
},
"usage_limit_reached": {
"type": "boolean",
"example": false,
"description": "verdadeiro se o limite de uso for atingido. falso se não for alcançado. indefinido se os limites de uso não se aplicarem a essa instância."
},
"time_available_at": {
"format": "date-time",
"type": "string",
"description": "A data e hora mais precoce em que o uso ficará abaixo do limite da instância, devido à saída do uso antigo da janela de 28 dias. Apenas aparece quando o limite por instância é atingido em um plano de janela móvel.",
"example": "2024-01-01T00:00:00.000Z",
"minLength": 20,
"maxLength": 29
}
},
"required": [
"instance_id",
"plan_id",
"usage_consumed_seconds"
]
}