Oracle Cloud Infrastructureドキュメント

イベント・メッセージの内容

このトピックでは、イベント・メッセージの内容について説明します。 各イベント・メッセージには、次の2つの主要な部分があります: 

  • エンベロープ: すべてのイベント・メッセージのコンテナ
  • ペイロード: イベント・メッセージを発行しているリソースのデータ

イベント・エンベロープ

イベント・エンベロープのこれらの属性は、すべてのイベントで同じです。 エンベロープの構造は、「クラウド・ネイティブ・コンピューティング基盤(CNCF)」でホストされているCloudEventsの業界標準の形式に従います。

プロパティ 説明
cloudEventsVersion

CloudEvents仕様のバージョン。

ノート

「イベント」はCloudEventsイベント・エンベロープのバージョン0.1仕様を使用します。

contentType application/jsonに設定します。 data属性に含まれるデータのコンテンツ・タイプ。
data イベントのペイロード。 data内のすべての情報は、イベントを発行したリソースに基づきます。 ペイロードの構造の詳細は、次の表を参照してください。
eventID

イベントのUUID。 この識別子はOCIDではなく、イベントの一意のIDのみです。

eventTime RFC 3339タイムスタンプ書式で表されたイベントの時間。
eventType

発生したイベントのタイプ。 イベントを生成するすべてのサービス、およびそれらのサービスが追跡する場合でも、「イベントを生成するサービス」を参照してください。

ノート

イベントを生成するサービスでは、eventTypeの新しいバージョンを公開してeventTypeVersionフィールドを変更することで、フィールドの内容を追加、削除または変更することもできます。

eventTypeVersion

イベント・タイプのバージョン。

extensions イベントの発生元コンパートメントのOCID。 テナンシのルート・コンパートメントでイベントが発生している場合、この属性はテナンシOCIDを指定します。 CloudEvents仕様のOracle Cloud Infrastructure実装では、この属性は必須です。
source イベントを生成したリソース。 たとえば、Autonomous Databaseまたは「オブジェクト・ストレージ」バケットなどです。

ペイロード

これらのフィールドのデータは、イベントを生成したサービスおよび定義したイベント・タイプによって異なります。

プロパティ 説明
compartmentId

イベントを生成したリソースのコンパートメントのOCID。

compartmentName イベントを表示したリソースのコンパートメントの名前。
resourceName イベントを発行しているリソースの名前。
resourceId

イベントを発生させるリソースのOCIDまたはID。

availabilityDomain イベントを発行するリソースの可用性ドメイン。
freeFormTags

イベントを生成しているリソースに追加されたフリー・フォームのタグ。

definedTags イベントを発行するリソースに追加される定義済タグ。
additionalDetails

イベントを生成しているリソースに固有の属性のコンテナです。 次に示すバケット・イベントの例では、ペイロードに3つの「オブジェクト・ストレージ」属性が含まれています: 

  • namespace
  • publicAccessType
  • eTag

他のリソースに含まれる属性を決定するには、イベントを取得するか、「イベントを生成するサービス」に記載されている参照サンプルを参照してください。

リソース識別子

ほとんどのタイプのOracle Cloud Infrastructureリソースには、Oracle Cloud ID (OCID)という名前の一意のOracle割当て識別子があります。 OCID形式およびリソースを識別するその他の方法については、「リソース識別子」を参照してください。

サンプル・イベント

「オブジェクト・ストレージ」が表示するバケット・イベントの例を次に示します。

{
	"cloudEventsVersion": "0.1",
	"eventID": "<unique_ID>",
	"eventType": "com.oraclecloud.objectstorage.deletebucket",
	"source": "objectstorage",
	"eventTypeVersion": "1.0",
	"eventTime": "2019-01-10T21:19:24Z",
	"schemaURL": null,
	"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"
		}
	}
}