Instances
Obtenir les détails de l'instance actuelle
Renvoie les détails de l'instance actuellement connectée, en utilisant le CRN de l'en-tête de la requête.
Autorisation
Pour appeler cette méthode, vous devez vous voir attribuer un ou plusieurs rôles d'accès IAM incluant les actions suivantes. Vous pouvez vérifier votre accès en vous rendant sur Users > User > Access
quantum-computing.instance.read
Audit
L'appel de cette méthode génère les événements d'audit suivants.
quantum-computing.instance.read
Entrée
Informations |
|---|
| Ce noeud final n'accepte aucun paramètre en entrée. |
Si votre instance se trouve dans la région « eu-de », utilisez plutôt ce lien : 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 votre instance se trouve dans la région « eu-de », utilisez plutôt ce lien : 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())Sortie
Code d'état | Description |
|---|---|
| 200 | bouton OK |
| 401 | Non autorisé |
| 403 | Interdit |
| 404 | Introuvable |
{
"backends": [
"ibm_backend"
],
"instance_limit": 60.7,
"instance_limit_seconds": "61",
"plan_id": "flex-plan-id-1",
"usage_allocation_seconds": "200"
}{
"type": "object",
"description": "Instance",
"properties": {
"backends": {
"type": "array",
"description": "Liste des systèmes backend ou des clusters associés à l'instance de service",
"items": {
"type": "string",
"pattern": "^.*$",
"minLength": 1,
"maxLength": 128,
"nullable": false
},
"minItems": 0,
"maxItems": 100
},
"instance_limit": {
"type": "number",
"format": "double",
"description": "Représente les limites de l'instance en secondes; sera remplacé par instance_limit\\_seconds",
"deprecated": true
},
"instance_limit_seconds": {
"type": "string",
"description": "Spécifie le nombre maximum de temps de ressources qui peuvent s'exécuter sur cette instance"
},
"plan_id": {
"type": "string",
"description": "Identifiant du plan de service associé à l'instance tel que défini dans le catalogue global",
"pattern": "^.*$",
"minLength": 1,
"maxLength": 128
},
"usage_allocation_seconds": {
"type": "string",
"description": "La somme maximale de l'allocation d'utilisation autorisée sur l'instance."
}
}
}Obtenir la configuration de l'instance
Obsolète : utilisez Resource Controller pour gérer la configuration de l'instance. Voir /docs/guides/access-instances-platform-apis. Renvoie la configuration de l'instance spécifiée (par exemple, la limite d'instance en secondes), à l'aide de la valeur « CRN » figurant dans l'en-tête de la requête.
Autorisation
Pour appeler cette méthode, vous devez vous voir attribuer un ou plusieurs rôles d'accès IAM incluant les actions suivantes. Vous pouvez vérifier votre accès en vous rendant sur Users > User > Access
quantum-computing.instance.configuration.read
Audit
L'appel de cette méthode génère les événements d'audit suivants.
quantum-computing.instance.configuration.read
Entrée
Informations |
|---|
| Ce noeud final n'accepte aucun paramètre en entrée. |
Si votre instance se trouve dans la région « eu-de », utilisez plutôt ce lien : 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 votre instance se trouve dans la région « eu-de », utilisez plutôt ce lien : 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())Sortie
Code d'état | Description |
|---|---|
| 200 | bouton OK |
| 401 | Non autorisé |
| 403 | Interdit |
| 404 | Introuvable |
{
"instance_limit": 123456
}{
"type": "object",
"description": "Configuration d'instance",
"properties": {
"instance_limit": {
"type": "number",
"format": "double",
"description": "Limite d'utilisation de l'instance en secondes"
}
}
}Mise à jour de la configuration de l'instance
Obsolète : utilisez Resource Controller pour gérer la configuration de l'instance. Voir /docs/guides/access-instances-platform-apis. Mettez à jour la configuration de l'instance spécifiée (par exemple, la durée maximale de l'instance en secondes) à l'aide de l' CRN, disponible dans les paramètres de contexte de la requête.
Autorisation
Pour appeler cette méthode, vous devez vous voir attribuer un ou plusieurs rôles d'accès IAM incluant les actions suivantes. Vous pouvez vérifier votre accès en vous rendant sur Users > User > Access
quantum-computing.instance.configuration.update
Audit
L'appel de cette méthode génère les événements d'audit suivants.
quantum-computing.instance.configuration.update
Entrée
Nom, type | Description |
|---|---|
instance_limit integer | Ce champ peut être nul ou entier. Utilisez null pour réinitialiser/supprimer la limite d'instance. Valeur minimale: 1Valeur maximale: 2147483647 |
Si votre instance se trouve dans la région « eu-de », utilisez plutôt ce lien : 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 votre instance se trouve dans la région « eu-de », utilisez plutôt ce lien : 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())Sortie
Code d'état | Description |
|---|---|
| 204 | bouton OK |
| 400 | Demande incorrecte |
| 401 | Non autorisé |
| 403 | Interdit |
| 404 | Introuvable |
| 409 | L'utilisation dépasse la limite de l'instance |
Obtenir l'utilisation de l'instance
Obtenir l'utilisation de l'instance
Autorisation
Pour appeler cette méthode, vous devez vous voir attribuer un ou plusieurs rôles d'accès IAM incluant les actions suivantes. Vous pouvez vérifier votre accès en vous rendant sur Users > User > Access
quantum-computing.instance-usage.read
Audit
L'appel de cette méthode génère les événements d'audit suivants.
quantum-computing.instance-usage.read
Entrée
Informations |
|---|
| Ce noeud final n'accepte aucun paramètre en entrée. |
Si votre instance se trouve dans la région « eu-de », utilisez plutôt ce lien : 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 votre instance se trouve dans la région « eu-de », utilisez plutôt ce lien : 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())Sortie
Code d'état | Description |
|---|---|
| 200 | |
| 401 | Non autorisé |
{
"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": "Heure de début et de fin de la période d'utilisation",
"allOf": [
{
"type": "object",
"properties": {
"start_time": {
"format": "date-time",
"type": "string",
"description": "L'heure de début de l'utilisation"
},
"end_time": {
"format": "date-time",
"type": "string",
"description": "L'heure de fin de l'utilisation"
}
}
}
]
},
"usage_consumed_seconds": {
"type": "number",
"example": 12,
"description": "Utilisation consommée pendant la période d'utilisation en cours"
},
"usage_limit_seconds": {
"type": "number",
"example": 60,
"description": "Limite d'utilisation en secondes pendant la période d'utilisation"
},
"usage_allocation_seconds": {
"type": "number",
"example": 120,
"description": "Les secondes allouées à l'instance pendant la période d'utilisation"
},
"usage_limit_reached": {
"type": "boolean",
"example": false,
"description": "true si la limite d'utilisation est atteinte. faux s'il n'est pas atteint. indéfini si les limites d'utilisation ne s'appliquent pas à cette instance."
},
"time_available_at": {
"format": "date-time",
"type": "string",
"description": "La date et l'heure les plus proches auxquelles l'utilisation passera sous la limite fixée, en raison de la sortie des anciennes données de consommation de la fenêtre de 28 jours. Ceci ne s'applique que lorsque la limite au niveau de l'instance est atteinte dans le cadre d'un plan à fenêtre glissante.",
"example": "2024-01-01T00:00:00.000Z",
"minLength": 20,
"maxLength": 29
}
},
"required": [
"instance_id",
"plan_id",
"usage_consumed_seconds"
]
}