Résumé des données fournies par le service de métadonnées
Utilisez le service de métadonnées pour accéder aux informations relatives à l'instance, aux clés SSH et aux groupes de placement. Le résumé suivant contient les chemins d'accès URI et les clés de métadonnées, et décrit les métadonnées.
La réponse de l'API pour chaque type de métadonnées est fournie au format JSON et contient des paires clé-valeur de métadonnées.
Récapitulatif des métadonnées pour les instances
Utilisez les informations du tableau 1 pour comprendre le type de métadonnées renvoyées pour une instance. Pour accéder à toutes les métadonnées, voir Récupération des métadonnées d'une instance.
| Chemin d'URI d'instance | Clé de métadonnées | Description des métadonnées |
|---|---|---|
/instance |
availability_policy |
La règle de disponibilité de cette instance de serveur virtuel. |
/instance |
bandwidth |
La bande passante totale, exprimée en mégabits par seconde, partagée entre les interfaces réseau de l'instance de serveur virtuel et les volumes d' Block Storage. |
/instance |
boot_volume_attachment |
Connexion du volume d'amorçage, avec nom de volume, CRN et ID. |
/instance |
catalog_offering |
Ces informations s'affichent si l'instance du serveur virtuel a été provisionnée avec une image personnalisée dans un catalogue privé. |
/instance |
created_at |
Date et heure de création de l'instance de serveur virtuel. |
/instance |
crn |
Nom de ressource de cloud pour cette instance de serveur virtuel. |
/instance |
dedicated_host |
Ensemble des références des hôtes dédiés, comprenant le CRN, les hôtes supprimés, l'ID, le nom et le type de ressource. |
/instance |
disks |
Liste des disques de l'instance. |
/instance |
gpu |
Configuration GPU de l'instance de serveur virtuel |
/instance |
id |
Identificateur unique de cette instance de serveur virtuel. |
/instance |
image |
Image à partir de laquelle l'instance de serveur virtuel a été mise à disposition. Par exemple, une image stockée Debian Linux. |
/instance |
lifecycle_reasons |
Raisons de l'état actuel du cycle de vie. |
/instance |
lifecycle_state |
État du cycle de vie de l'instance de serveur virtuel. |
/instance |
memory |
La quantité de mémoire; arrondie au gigaoctet entier. |
/instance |
metadata_service |
Indique si le point de terminaison des services de métadonnées est disponible pour l'instance de serveur virtuel. (L'état activé est true ou false.) |
/instance |
name |
Nom défini par l'utilisateur pour cette instance de serveur virtuel (et nom d'hôte système par défaut). |
/instance |
network_interfaces |
Liste des interfaces réseau de l'instance de serveur virtuel, y compris l'interface réseau principale. |
/instance |
placement_target |
Restrictions de placement de l'instance de serveur virtuel. |
/instance |
primary_network_interface |
Interface réseau principale de l'instance. |
/instance |
profile |
Nom unique global de ce profil d'instance de serveur virtuel. Par exemple, un profil équilibré bx2-2x8. |
/instance |
software_attachments |
Liste des composants logiciels associés à l'instance de serveur virtuel. |
/instance |
startable |
Indique si l'état de l'instance de serveur virtuel permet une demande de démarrage. |
/instance |
status |
Statut de l'instance: suppression, échec, suspendu, suspension, en attente, redémarrage, reprise, exécution, démarrage, arrêté ou en cours d'arrêt. |
/instance |
status_reasons |
Les raisons de l'état en cours |
/instance |
total_network_bandwidth |
Quantité de bande passante en mégabits par seconde allouée exclusivement aux interfaces réseau d'instance. |
/instance |
total_volume_bandwidth |
Quantité de bande passante en mégabits par seconde allouée exclusivement aux volumes de stockage par blocs de l'instance. L'augmentation de cette valeur entraîne une diminution correspondante de la bande passante totale du réseau. |
/instance |
vcpu |
Le nombre de VCPU attribués via une structure comprenant des propriétés relatives au nombre et à l'architecture. |
/instance |
volume_attachments |
Liste des attachements de volumes de l'instance de serveur virtuel. |
/instance |
boot_volume_attachment |
Attache du volume d'amorçage de l'instance. |
/instance |
volume_bandwidth_qos_mode |
La bande passante du volume en mode « QoS » pour cette instance de serveur virtuel. Soit regroupées, soit pondérées. |
/instance |
vpc |
VPC dans lequel réside l'instance de serveur virtuel. |
/instance |
zone |
Nom unique global de la zone. |
/instance/initialization |
default_trusted_profile |
La configuration par défaut du profil de confiance qui a été spécifiée lors de la création de l'instance du serveur virtuel. |
/instance/initialization |
keys |
Liste des références aux clés SSH publiques utilisées lors de l'initialisation de l'instance. |
/instance/initialization |
password |
Mot de passe de l'administrateur à l'initialisation, chiffré à l'aide d'encryption_key, et renvoyé en code base64. |
/instance/initialization |
user_data |
Données utilisateur mises à disposition lorsque vous configurez une nouvelle instance de serveur virtuel. |
/instance/network_interfaces |
network_interfaces |
Liste des interfaces réseau. Pour plus de détails, voir /instance/network_interfaces/{id}. |
/instance/network_interfaces/{id} |
allow_ip_spoofing |
Indique si l'usurpation d'adresse IP source est autorisée sur cette interface. La mise à false empêche l'usurpation d'adresse IP source sur cette interface. La mise à true permet l'usurpation d'adresse IP source sur cette interface. |
/instance/network_interfaces/{id} |
created_at |
Date et heure de création de l'interface réseau. |
/instance/network_interfaces/{id} |
floating_ips |
Tableau contenant les références aux adresses IP flottantes associées à l'interface réseau. |
/instance/network_interfaces/{id} |
id |
Identificateur unique de l'interface réseau. |
/instance/network_interfaces/{id} |
name |
Nom défini par l'utilisateur pour l'interface réseau. |
/instance/network_interfaces/{id} |
port_speed |
Vitesse du port de l'interface réseau en Mbit/s. |
/instance/network_interfaces/{id} |
primary_ipv4_address |
Adresse IPv4 principale. |
/instance/network_interfaces/{id} |
resource_type |
Type de ressource. |
/instance/network_interfaces/{id} |
security_groups |
Liste des groupes de sécurité. |
/instance/network_interfaces/{id} |
status |
Statut de l'interface réseau. |
/instance/network_interfaces/{id} |
subnet |
Sous-réseau associé à l'instance. |
/instance/network_interfaces/{id} |
type |
Type de cette interface réseau en ce qui concerne une instance. |
/instance/software_attachments |
software_attachments |
Un tableau contenant zéro ou plusieurs objets d'extension logicielle. |
/instance/software_attachments/{id} |
id |
L'identifiant unique (UUID) associé à cette pièce jointe logicielle. |
/instance/software_attachments/{id} |
name |
Nom de ce fichier joint. Ce nom est unique au sein de l'ensemble des composants logiciels associés à l'instance de serveur virtuel. |
/instance/software_attachments/{id} |
href |
URL s concernant ce logiciel. |
/instance/software_attachments/{id} |
catalog_offering |
Objet contenant le CRN de l'offre du catalogue et le CRN du plan logiciel associé, qui désigne le logiciel. |
/instance/software_attachments/{id} |
offering_instance |
Objet représentant l'instance de l'offre logicielle instanciée à partir du plan logiciel. Contient le CRN de l'instance de l'offre logicielle. |
/instance/software_attachments/{id} |
entitlement |
Objet représentant les droits de licence associés à l'instance de l'offre logicielle. Cette propriété est renseignée dynamiquement une fois que l'appel au gestionnaire de licences visant à obtenir les droits d'utilisation a abouti. |
/instance/software_attachments/{id} |
entitlement.licensed_software |
Un tableau contenant zéro ou plusieurs objets, chacun représentant un logiciel ou une fonctionnalité installé(e) et sous licence dans l'instance de serveur virtuel. |
/instance/software_attachments/{id} |
entitlement.licensed_software[].sku |
La référence (SKU, Stock Keeping Unit) d'un logiciel ou d'une fonctionnalité sous licence, associée au plan logiciel et s'exécutant sur l'instance de serveur virtuel. |
/instance/software_attachments/{id} |
entitlement.licensed_software[].key |
La clé de licence correspondant au droit d'utilisation du logiciel. La valeur de ce bien immobilier peut évoluer au fil du temps. |
/instance/software_attachments/{id} |
lifecycle_state |
L'état du cycle de vie de la pièce jointe logicielle, indiquant si celle-ci est complète et utilisable. |
/instance/software_attachments/{id} |
lifecycle_reasons |
Une liste des raisons expliquant l'état actuel du cycle de vie. |
/instance/software_attachments/{id} |
resource_type |
Type de ressource. Définit sur instance_software_attachment. |
/instance/software_attachments/{id} |
created_at |
La date et l'heure de création de ce logiciel joint. |
/instance/volume_attachments/{id} |
bandwidth |
La bande passante maximale, exprimée en mégabits par seconde, pour ce volume lorsqu'il est associé à cette instance. Cette valeur peut être inférieure à la bande passante du volume, selon la configuration de l'instance. |
/instance/volume_attachments/{id} |
created_at |
Date et heure de connexion du volume. |
/instance/volume_attachments/{id} |
delete_volume_on_instance_delete |
Si l'option est définie sur « true », le volume sera également supprimé lorsque vous supprimerez l'instance. |
/instance/volume_attachments/{id} |
device |
Informations sur la manière dont le volume est exposé au système d'exploitation de l'instance. |
/instance/volume_attachments/{id} |
id |
Identificateur unique de la connexion de volume. |
/instance/volume_attachments/{id} |
name |
Nom défini par l'utilisateur pour la connexion de volume. |
/instance/volume_attachments/{id} |
status |
Statut de l'attachement de volume : attaché, attachement, suppression ou détachement. |
/instance/volume_attachments/{id} |
type |
Type de connexion de volume, d'amorçage ou de données. |
/instance/volume_attachments/{id} |
volume |
Volume connecté contenant la valeur CRN, ID, name et deleted, lorsque le volume est supprimé. |
Récapitulatif des métadonnées pour les clés SSH
Utilisez les informations du tableau 2 pour comprendre le type de métadonnées renvoyées pour les clés SSH.
| Chemin d'URI de clé SSH | Clé de métadonnées | Description des métadonnées |
|---|---|---|
/keys |
keys |
Collection de clés. Voir keys/{id} pour des détails. |
/keys/{id} |
created_at |
Date et heure de création de la clé. |
/keys/{id} |
crn |
Nom de la ressource cloud associée à la clé. |
/keys/{id} |
fingerprint |
L'empreinte digitale de la clé. La valeur est renvoyée codée en base64 et préfixée avec l'algorithme de hachage (toujours SHA256). |
/keys/{id} |
id |
Identificateur unique de la clé. |
/keys/{id} |
length |
La longueur de la clé, en bits. |
/keys/{id} |
name |
Nom unique défini par l'utilisateur pour la clé. Si aucun nom n'est spécifié, celui-ci est constitué d'une liste de mots choisis au hasard, séparés par des tirets (par exemple, elderly-mountain-troop-opponent.) |
/keys/{id} |
public_key |
Clé SSH publique. |
/keys/{id} |
type |
Le système de cryptographie utilisé par la clé. |
Récapitulatif des métadonnées pour les groupes de placement
Utilisez les informations du tableau 3 pour comprendre le type des métadonnées renvoyées pour les groupes de placement.
| Chemin d'URI du groupe de placement | Clé de métadonnées | Description des métadonnées |
|---|---|---|
/placement_groups |
placement_groups |
Collection de groupes de placement. Voir placement_groups/{id} pour des détails. |
/placement_groups/{id} |
created_at |
Date et heure de création du groupe de placement. |
/placement_groups/{id} |
crn |
Nom de la ressource cloud pour le groupe de placement. |
/placement_groups/{id} |
id |
L'identifiant unique du groupe de placement. |
/placement_groups/{id} |
lifecycle_state |
Etat du cycle de vie du groupe de placement. |
/placement_groups/{id} |
name |
Nom défini par l'utilisateur pour le groupe de placement. |
/placement_groups/{id} |
resource_type |
Type de ressource. |
/placement_groups/{id} |
strategy |
La stratégie pour le groupe de placement. |
Résumé des métadonnées relatives aux pièces jointes logicielles
Utilisez les informations du tableau ci-dessous pour comprendre le type de métadonnées renvoyées pour les pièces jointes de type logiciel.
Le point de terminaison /metadata/v1/instance/software_attachments renvoie un tableau contenant zéro ou plusieurs objets de pièce jointe logicielle. Chaque objet représente une instance logicielle enregistrée par
un contrôleur de ressources et correspondant à un plan logiciel.
| Chemin d'accès URI des pièces jointes logicielles | Clé de métadonnées | Description des métadonnées |
|---|---|---|
/instance/software_attachments/{id} |
id |
Un UUID unique pour la pièce jointe logicielle. |
/instance/software_attachments/{id} |
name |
Un nom unique parmi l'ensemble des composants logiciels associés à l'instance de serveur virtuel. Ce nom est attribué par défaut à une valeur aléatoire générée par le système et peut être modifié ultérieurement par le propriétaire s'il le souhaite. Notez que la modification du nom dans la configuration logicielle de l'instance de serveur virtuel n'a aucune incidence sur celui du volume de démarrage associé ni sur les instantanés déjà créés à partir de ce volume. |
/instance/software_attachments/{id} |
href |
URL s concernant ce logiciel. |
/instance/software_attachments/{id} |
catalog_offering |
Objet dont la valeur est identique à celle de l'objet d'instance portant le même nom, contenant le CRN de la version de l'offre du catalogue et le CRN du plan logiciel associé représentant le logiciel. |
/instance/software_attachments/{id} |
offering_instance |
Objet représentant l'instance de l'offre logicielle instanciée à partir du plan logiciel. |
/instance/software_attachments/{id} |
offering_instance.crn |
L'instance de l'offre logicielle CRN. |
/instance/software_attachments/{id} |
entitlement (facultatif) |
Objet représentant les droits de licence associés à l'instance de l'offre logicielle. Si ce champ est vide, aucune licence n'est associée au plan logiciel. |
/instance/software_attachments/{id} |
entitlement.licensed_software |
Un tableau contenant zéro ou plusieurs objets, chacun représentant un logiciel ou une fonctionnalité installé(e) et sous licence dans l'instance de serveur virtuel. |
/instance/software_attachments/{id} |
entitlement.licensed_software[].sku |
La référence (SKU, Stock Keeping Unit) d'un logiciel ou d'une fonctionnalité sous licence, associée au plan logiciel et s'exécutant sur l'instance de serveur virtuel. Cela revêt une importance particulière pour l'éditeur du logiciel. |
/instance/software_attachments/{id} |
entitlement.licensed_software[].key (facultatif) |
La clé de licence correspondant au droit d'utilisation du logiciel. Si cette mention n'apparaît pas, cela signifie que la licence n'a pas encore été obtenue. |
/instance/software_attachments/{id} |
lifecycle_state |
L'état du cycle de vie de la pièce jointe logicielle. Si le statut est « stable », cela signifie que l'instance du logiciel a été créée avec succès. |
/instance/software_attachments/{id} |
lifecycle_reasons[] |
Raisons de l'état actuel du cycle de vie. |
/instance/software_attachments/{id} |
resource_type |
Le type de ressource, défini sur « instance_software_attachment ». |
/instance/software_attachments/{id} |
created_at |
La date et l'heure de création de ce logiciel joint. |