Documentation sur Oracle Cloud Infrastructure

Contenu d'un événement du journal de vérification

Décrit le contenu d'un événement du journal de vérification.

Vous trouverez ci-dessous la description des contenus d'un événement de journal pour le service de vérification. Chaque événement du journal de vérification contient deux pièces principales : 

  • Des enveloppes faisant office de conteneur pour tous les messages d'événement
  • Des données utiles qui contiennent des données provenant de la ressource émettant le message d'événement

Identificateurs de ressource

La plupart des types de ressource Oracle Cloud Infrastructure ont un identifiant unique affecté par Oracle, appelé OCID (identificateur Oracle Cloud). Pour des informations sur le format des OCID et sur les autres moyens d'identifier vos ressources, voir Identificateurs de ressource.

Enveloppe d'événement

Ces attributs d'enveloppe d'événement sont les mêmes pour tous les événements. La structure de l'enveloppe suit le format standard de l'industrie CloudEvents hébergé par la Cloud Native Computing Foundation (CNCF).

Propriété Description
cloudEventsVersion

Version de la spécification CloudEvents.

Note :Le service Vérification utilise la spécification version 0.1 de l'enveloppe d'événement CloudEvents.

contentType Réglez la valeur à application/json. Type de contenu des données incluses dans l'attribut data.
data Données utiles de l'événement. Les informations comprises dans data proviennent de la ressource émettant l'événement.
eventID

UUID de l'événement. Cet identificateur n'est pas un OCID, mais seulement un ID unique pour l'événement.

eventTime Heure de l'événement dans le format d'horodatage RFC 3339.
eventType

Type de l'événement qui s'est produit.

Note : Le service qui produit l'événement peut également ajouter, supprimer ou modifier la signification d'un champ. Un service qui modifie ces champs publie une nouvelle version du champ eventType et révise le champ eventTypeVersion.

eventTypeVersion

Version du type d'événement. Cette version s'applique aux données utiles de l'événement et non à l'enveloppe. Utilisez cloudEventsVersion pour déterminer la version de l'enveloppe.

source Ressource qui a produit l'événement. Par exemple, une base de données Autonomous Database ou un seau de stockage d'objets.

Données utiles

Les données de ces champs dépendent du service qui a produit le journal des événements et du type d'événement qu'il définit.

Données

L'objet de données contient les attributs suivants.

Propriété Description
data.additionalDetails Objet de conteneur pour les attributs uniques à la ressource émettant l'événement.
data.availabilityDomain Domaine de disponibilité dans lequel réside la ressource.
data.compartmentId OCID du compartiment de la ressource émettant l'événement.
data.compartmentName Nom du compartiment de la ressource émettant l'événement.
data.definedTags Marqueurs définis ajoutés à la ressource émettant l'événement.
data.eventGroupingId

Cette valeur relie plusieurs événements de vérification faisant partie de la même opération d'API. Par exemple, une opération d'API de longue durée qui émet un événement au début et à la fin de l'opération.
data.eventName

Nom de l'opération d'API ayant généré l'événement.

Exemple : LaunchInstance
data.freeformTags Marqueurs à structure libre ajoutés à la ressource émettant l'événement.
data.identity Objet de conteneur pour les attributs d'identité. Voir Identité.
data.request Objet de conteneur pour les attributs de demande. Voir Demande.
data.resourceId OCID ou ID de la ressource émettant l'événement.
data.resourceName Nom de la ressource émettant l'événement.
data.response Objet de conteneur pour les attributs de réponse. Voir Réponse.
data.stateChange Objet de conteneur pour les attributs de modification d'état. Voir Modification d'état.

Identité

L'objet d'identité contient les attributs suivants.

Propriété Description
data.identity.authType Type d'authentification utilisé.
data.identity.callerId OCID du programme d'appel. Programme d'appel ayant effectué une demande au nom du principal d'instance.
data.identity.callerName Nom de l'utilisateur ou du service qui émet la demande. Cette valeur est le nom convivial associé à callerId.
data.identity.consoleSessionId Cette valeur identifie toute session de la console associée à la demande.
data.identity.credentials ID données d'identification de l'utilisateur.
data.identity.ipAddress Adresse IP de la source de la demande.
data.identity.principalId OCID du principal.
data.identity.principalName Nom de l'utilisateur ou du service. Cette valeur est le nom convivial associé à principalId .
data.identity.tenantId OCID du locataire.
data.identity.userAgent Agent utilisateur du client qui a soumis la demande.

Demande

L'objet de demande contient les attributs suivants.

Propriété Description
data.request.action

Méthode HTTP de la demande.

Exemple : GET
data.request.headers Champs et valeurs d'en-tête HTTP de la demande.
data.request.id Identificateur unique d'une demande.
data.request.parameters Tous les paramètres fournis par le programme d'appel au cours de l'opération.
data.request.path

Chemin complet de la demande d'API.

Exemple : /20160918/instances/ocid1.instance.oc1.phx.<unique_ID>

Réponse

L'objet de réponse contient les attributs suivants.

Propriété Description
data.response.headers En-têtes de la réponse.
data.response.message Description conviviale de ce qui s'est produit lors de l'opération.
data.response.payload Cette valeur est incluse pour la compatibilité descendante avec le schéma version 1 du service Vérification, qui contient les métadonnées d'intérêt provenant des données utiles de la réponse.
data.response.responseTime Heure de la réponse à la demande vérifiée, exprimée dans le format d'horodatage RFC 3339.
data.response.status Code de statut de la réponse.

Modification d'état

L'objet de modification d'état contient les attributs suivants.

Propriété Description
data.stateChange.current Indique l'état courant des champs qui peuvent avoir été modifiés au cours d'une opération. Pour déterminer comment l'opération courante a modifié une ressource, comparez les informations de cet attribut à data.stateChange.previous.
data.stateChange.previous Indique l'état précédent des champs qui peuvent avoir été modifiés au cours d'une opération. Pour déterminer comment l'opération courante a modifié une ressource, comparez les informations de cet attribut à data.stateChange.current.

Exemple de journal pour le service de vérification

Voici un exemple d'événement enregistré par le service de vérification. 

{
	"eventType": "com.oraclecloud.ComputeApi.GetInstance",
	"cloudEventsVersion": "0.1",
	"eventTypeVersion": "2.0",
	"source": "ComputeApi",
	"eventId": "<unique_ID>",
	"eventTime": "2019-09-18T00:10:59.252Z",
	"contentType": "application/json",
	"data": {
		"eventGroupingId": null,
		"eventName": "GetInstance",
		"compartmentId": "ocid1.tenancy.oc1..<unique_ID>",
		"compartmentName": "compartmentA",
		"resourceName": "my_instance",
		"resourceId": "ocid1.instance.oc1.phx.<unique_ID>",
		"availabilityDomain": "<availability_domain>",
		"freeformTags": null,
		"definedTags": null,
		"identity": {
			"principalName": "ExampleName",
			"principalId": "ocid1.user.oc1..<unique_ID>",
			"authType": "natv",
			"callerName": null,
			"callerId": null,
			"tenantId": "ocid1.tenancy.oc1..<unique_ID>",
			"ipAddress": "172.24.80.88",
			"credentials": null,
			"userAgent": "Jersey/2.23 (HttpUrlConnection 1.8.0_212)",
			"consoleSessionId": null
		},
		"request": {
			"id": "<unique_ID>",
			"path": "/20160918/instances/ocid1.instance.oc1.phx.<unique_ID>",
			"action": "GET",
			"parameters": {},
			"headers": {
				"opc-principal": [
					"{\"tenantId\":\"ocid1.tenancy.oc1..<unique_ID>\",\"subjectId\":\"ocid1.user.oc1..<unique_ID>\",\"claims\":[{\"key\":\"pstype\",\"value\":\"natv\",\"issuer\":\"authService.oracle.com\"},{\"key\":\"h_host\",\"value\":\"iaas.r2.oracleiaas.com\",\"issuer\":\"h\"},{\"key\":\"h_opc-request-id\",\"value\":\"<unique_ID>\",\"issuer\":\"h\"},{\"key\":\"ptype\",\"value\":\"user\",\"issuer\":\"authService.oracle.com\"},{\"key\":\"h_date\",\"value\":\"Wed, 18 Sep 2019 00:10:58 UTC\",\"issuer\":\"h\"},{\"key\":\"h_accept\",\"value\":\"application/json\",\"issuer\":\"h\"},{\"key\":\"authorization\",\"value\":\"Signature headers=\\\"date (request-target) host accept opc-request-id\\\",keyId=\\\"ocid1.tenancy.oc1..<unique_ID>/ocid1.user.oc1..<unique_ID>/8c:b4:5f:18:e7:ec:db:08:b8:fa:d2:2a:7d:11:76:ac\\\",algorithm=\\\"rsa-pss-sha256\\\",signature=\\\"<unique_ID>\\\",version=\\\"1\\\"\",\"issuer\":\"h\"},{\"key\":\"h_(request-target)\",\"value\":\"get /20160918/instances/ocid1.instance.oc1.phx.<unique_ID>\",\"issuer\":\"h\"}]}"
				],
				"Accept": [
					"application/json"
				],
				"X-Oracle-Auth-Client-CN": [
					"splat-proxy-se-02302.node.ad2.r2"
				],
				"X-Forwarded-Host": [
					"compute-api.svc.ad1.r2"
				],
				"Connection": [
					"close"
				],
				"User-Agent": [
					"Jersey/2.23 (HttpUrlConnection 1.8.0_212)"
				],
				"X-Forwarded-For": [
					"172.24.80.88"
				],
				"X-Real-IP": [
					"172.24.80.88"
				],
				"oci-original-url": [
					"https://iaas.r2.oracleiaas.com/20160918/instances/ocid1.instance.oc1.phx.<unique_ID>"
				],
				"opc-request-id": [
					"<unique_ID>"
				],
				"Date": [
					"Wed, 18 Sep 2019 00:10:58 UTC"
				]
			}
		},
		"response": {
			"status": "200",
			"responseTime": "2019-09-18T00:10:59.278Z",
			"headers": {
				"ETag": [
					"<unique_ID>"
				],
				"Connection": [
					"close"
				],
				"Content-Length": [
					"1828"
				],
				"opc-request-id": [
					"<unique_ID>"
				],
				"Date": [
					"Wed, 18 Sep 2019 00:10:59 GMT"
				],
				"Content-Type": [
					"application/json"
				]
			},
			"payload": {
				"resourceName": "my_instance",
				"id": "ocid1.instance.oc1.phx.<unique_ID>"
			},
			"message": null
		},
		"stateChange": {
			"previous": null,
			"current": null
		},
		"additionalDetails": {
			"imageId": "ocid1.image.oc1.phx.<unique_ID>",
			"shape": "VM.Standard1.1",
			"type": "CustomerVmi"
		}
	}
}