Documentation Oracle Cloud Infrastructure

Contenu d'un message d'événement

En savoir plus sur le contenu d'un message d'événement.

Chaque message d'événement comprend deux parties principales :

  • Enveloppe : conteneur de tous les messages d'événement

  • Charge utile : données de la ressource émettant le message d'événement

Enveloppe d'événement

Ces attributs d'une enveloppe d'événement sont les mêmes pour tous les événements. La structure de l'enveloppe suit le format standard du secteur CloudEvents, géré par la CNCF (Cloud Native Computing Foundation).

Propriété Description
cloudEventsVersion

Version de la spécification CloudEvents.

Remarque: Events utilise la spécification version 0.1 de l'enveloppe d'événement CloudEvents.

contentType Définissez cette propriété sur application/json. Type de contenu des données dans l'attribut data.
data Charge utile de l'événement. Toutes les informations contenues dans data proviennent de la ressource émettant l'événement. Pour plus de détails sur la structure de la charge utile, reportez-vous au tableau suivant.
eventID

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

eventTime Heure de l'événement, exprimée au format d'horodatage RFC 3339.
eventType

Type de l'événement qui s'est produit. Pour obtenir la liste de tous les services qui génèrent des événements, et des types d'événement suivis par ces services, reportez-vous à Services produisant des événements.

Remarque: Le service qui produit l'événement peut également ajouter, enlever ou modifier la signification d'un champ en publiant une nouvelle version d'un attribut eventType et en révisant le champ eventTypeVersion.

eventTypeVersion

Version du type d'événement.

extensions OCID du compartiment duquel provient l'événement. Si l'événement provient du compartiment racine de la location, cet attribut indique un OCID de location. Cet attribut est obligatoire dans l'implémentation Oracle Cloud Infrastructure de la spécification CloudEvents.
source Ressource ayant généré l'événement. Par exemple, une base de données Autonomous Database ou un bucket Object Storage.

Charge utile

Les données de ces champs dépendent du service qui a généré l'événement et du type d'événement qu'il définit.

Propriété Description
compartmentId

OCID du compartiment de la ressource émettant l'événement.

compartmentName Nom du compartiment de la ressource émettant l'événement.
resourceName Nom de la ressource émettant l'événement.
resourceId

OCID ou ID de la ressource émettant l'événement.
availabilityDomain Domaine de disponibilité de la ressource émettant l'événement.
freeFormTags

Balises à format libre ajoutées à la ressource émettant l'événement.

definedTags Balises définies ajoutées à la ressource émettant l'événement.
additionalDetails

Conteneur des attributs propres à la ressource émettant l'événement. Dans l'exemple de bucket ci-après, la charge utile inclut trois attributs Object Storage :

  • namespace
  • publicAccessType
  • eTag

Afin de déterminer les attributs inclus pour d'autres ressources, extrayez un événement ou consultez les exemples de référence répertoriés dans Services produisant des événements.

Identificateurs de ressource

La plupart des types de ressource Oracle Cloud Infrastructure ont un identificateur unique affecté par Oracle appelé ID Oracle Cloud (OCID). Pour plus d'informations sur le format OCID et d'autres façons d'identifier vos ressources, reportez-vous à Identificateurs de ressource.

Exemple d'événement

Voici un exemple d'événement de bucket émis par Object Storage. 

{
	"cloudEventsVersion": "0.1",
	"eventID": "<unique_ID>",
	"eventType": "com.oraclecloud.objectstorage.deletebucket",
	"source": "objectstorage",
	"eventTypeVersion": "1.0",
	"eventTime": "2019-01-10T21:19:24Z",
	"contentType": "application/json",
	"extensions": {
		"compartmentId": "ocid1.compartment.oc1..<unique_ID>"
	},
	"data": {
		"compartmentId": "ocid1.compartment.oc1..<unique_ID>",
		"compartmentName": "example_name",
		"resourceName": "my_bucket",
		"resourceId": "ocid1.compartment.oc1..<unique_ID>",
		"availabilityDomain": "NfHZ:PHX-AD-2",
		"freeFormTags": {
			"Department": "Finance"
		},
		"definedTags": {
			"Operations": {
				"CostCenter": "42"
			}
		},
		"additionalDetails": {
			"namespace": "example_namespace",
			"publicAccessType": "NoPublicAccess",
			"eTag": "f8ffb6e9-f602-460f-a6c0-00b5abfa24c7"
		}
	}
}