Instancias
Obtener detalles de la instancia actual
Devuelve los detalles de la instancia conectada actualmente, utilizando el CRN de la cabecera de la petició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.instance.read
Auditoría
La invocación de este método genera los siguientes eventos de auditoría.
quantum-computing.instance.read
Entrada
Información |
|---|
| Este punto final no acepta entradas. |
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/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: 2024-01-01' 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/instance
import requests
response = requests.request(
"GET",
"https://quantum.cloud.ibm.com/api/v1/instance",
headers={
"Accept": "application/json",
"IBM-API-Version": "2024-01-01",
"Authorization": "Bearer YOUR-TOKEN",
"Service-CRN": "YOUR-SERVICE-CRN"
},
)
print(response.json())Resultado
Código de estado | Descripción |
|---|---|
| 200 | Aceptar |
| 401 | No autorizado |
| 403 | Prohibido |
| 404 | No se ha 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": "Instancia",
"properties": {
"backends": {
"type": "array",
"description": "Lista de sistemas backend o clusters asociados a la instancia de servicio",
"items": {
"type": "string",
"pattern": "^.*$",
"minLength": 1,
"maxLength": 128,
"nullable": false
},
"minItems": 0,
"maxItems": 100
},
"instance_limit": {
"type": "number",
"format": "double",
"description": "Representa los límites de instancia en segundos; se sustituirá por instance_limit\\_seconds",
"deprecated": true
},
"instance_limit_seconds": {
"type": "string",
"description": "Especifica el número máximo de recursos tiempo que pueden ejecutarse en esta instancia"
},
"plan_id": {
"type": "string",
"description": "Identificador del plan de servicio asociado a la instancia tal y como se define en el Catálogo Global",
"pattern": "^.*$",
"minLength": 1,
"maxLength": 128
},
"usage_allocation_seconds": {
"type": "string",
"description": "La suma máxima de asignación de uso permitida en la instancia."
}
}
}Obtener configuración de instancia
Obsoleto: utiliza Resource Controller para gestionar la configuración de la instancia. Consulte /docs/guides/access-instances-platform-apis. Devuelve la configuración de la instancia especificada (por ejemplo, el límite de la instancia en segundos), utilizando el valor « CRN » del encabezado de la solicitud.
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.instance.configuration.read
Auditoría
La invocación de este método genera los siguientes eventos de auditoría.
quantum-computing.instance.configuration.read
Entrada
Información |
|---|
| Este punto final no acepta entradas. |
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/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: 2024-01-01' 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/instances/configuration
import requests
response = requests.request(
"GET",
"https://quantum.cloud.ibm.com/api/v1/instances/configuration",
headers={
"Accept": "application/json",
"IBM-API-Version": "2024-01-01",
"Authorization": "Bearer YOUR-TOKEN",
"Service-CRN": "YOUR-SERVICE-CRN"
},
)
print(response.json())Resultado
Código de estado | Descripción |
|---|---|
| 200 | Aceptar |
| 401 | No autorizado |
| 403 | Prohibido |
| 404 | No se ha encontrado |
{
"instance_limit": 123456
}{
"type": "object",
"description": "Configuración de instancia",
"properties": {
"instance_limit": {
"type": "number",
"format": "double",
"description": "Límite de uso de la instancia en segundos"
}
}
}Actualizar la configuración de la instancia
Obsoleto: utiliza Resource Controller para gestionar la configuración de la instancia. Consulte /docs/guides/access-instances-platform-apis. Actualiza la configuración de la instancia especificada (por ejemplo, el límite de la instancia en segundos) utilizando CRN a partir de los parámetros de contexto de la solicitud.
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.instance.configuration.update
Auditoría
La invocación de este método genera los siguientes eventos de auditoría.
quantum-computing.instance.configuration.update
Entrada
Nombre, Tipo | Descripción |
|---|---|
instance_limit integer | Este campo puede ser nulo o un número entero. Utilice null para restablecer/eliminar el límite de instancia. Valor mínimo: 1Valor máximo: 2147483647 |
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/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: 2024-01-01' 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/instances/configuration
import requests
response = requests.request(
"PUT",
"https://quantum.cloud.ibm.com/api/v1/instances/configuration",
headers={
"Accept": "application/json",
"IBM-API-Version": "2024-01-01",
"Authorization": "Bearer YOUR-TOKEN",
"Service-CRN": "YOUR-SERVICE-CRN"
},
)
print(response.json())Resultado
Código de estado | Descripción |
|---|---|
| 204 | Aceptar |
| 400 | Solicitud errónea |
| 401 | No autorizado |
| 403 | Prohibido |
| 404 | No se ha encontrado |
| 409 | El uso supera el límite de instancias |
Obtener el uso de la instancia
Obtener el uso de la instancia
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.instance-usage.read
Auditoría
La invocación de este método genera los siguientes eventos de auditoría.
quantum-computing.instance-usage.read
Entrada
Información |
|---|
| Este punto final no acepta entradas. |
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/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: 2024-01-01' 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/instances/usage
import requests
response = requests.request(
"GET",
"https://quantum.cloud.ibm.com/api/v1/instances/usage",
headers={
"Accept": "application/json",
"IBM-API-Version": "2024-01-01",
"Authorization": "Bearer YOUR-TOKEN",
"Service-CRN": "YOUR-SERVICE-CRN"
},
)
print(response.json())Resultado
Código de estado | Descripción |
|---|---|
| 200 | |
| 401 | No autorizado |
{
"instance_id": "example",
"plan_id": "example",
"usage_period": {
"start_time": "example",
"end_time": "example"
},
"usage_consumed_seconds": 12,
"usage_consumed_ru": 0.2,
"usage_limit_seconds": 60,
"usage_limit_ru": 1,
"usage_allocation_seconds": 120,
"usage_allocation_ru": 2,
"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": "Hora de inicio y fin del periodo de utilización",
"allOf": [
{
"type": "object",
"properties": {
"start_time": {
"format": "date-time",
"type": "string",
"description": "Hora de inicio de la utilización"
},
"end_time": {
"format": "date-time",
"type": "string",
"description": "Hora de finalización de la utilización"
}
}
}
]
},
"usage_consumed_seconds": {
"type": "number",
"example": 12,
"description": "Uso consumido en el periodo de uso actual"
},
"usage_consumed_ru": {
"type": "number",
"example": 0.2,
"format": "float",
"description": "Consumo registrado en el periodo de consumo actual, expresado en unidades de recurso"
},
"usage_limit_seconds": {
"type": "number",
"example": 60,
"description": "El límite de uso en segundos durante el periodo de uso"
},
"usage_limit_ru": {
"type": "number",
"example": 1,
"format": "float",
"description": "El límite de consumo en unidades de recurso durante el periodo de consumo"
},
"usage_allocation_seconds": {
"type": "number",
"example": 120,
"description": "Los segundos que se asignan a la instancia durante el periodo de uso"
},
"usage_allocation_ru": {
"type": "number",
"example": 2,
"format": "float",
"description": "Las unidades de recursos que se asignan a la instancia durante el periodo de uso"
},
"usage_limit_reached": {
"type": "boolean",
"example": false,
"description": "true si se alcanza el límite de uso. false si no se alcanza. undefined si los límites de uso no se aplican a esta instancia."
},
"time_available_at": {
"format": "date-time",
"type": "string",
"description": "La fecha y hora más temprana en la que el consumo descenderá por debajo del límite de la instancia debido a que el consumo anterior queda fuera del periodo de 28 días. Solo aparece cuando se alcanza el límite a nivel de instancia en un plan de ventana móvil.",
"example": "2024-01-01T00:00:00.000Z",
"minLength": 20,
"maxLength": 29
}
},
"required": [
"instance_id",
"plan_id",
"usage_consumed_seconds",
"usage_consumed_ru"
]
}