Help Center/ Config/ User Guide/ Appendix/ Message Notification Models
Updated on 2024-05-29 GMT+08:00

Message Notification Models

Config send notifications when:

  • Resources are created, modified, or deleted.
  • Resource relationships change.
  • Notifications of resource changes are stored.
  • Resource snapshots are stored.

Notification Model of Resource Changes

Table 1 Parameter description

Parameter

Type

Description

notification_type

String

Specifies the message notification type.

notification_creation_time

String

Specifies the time when the message was sent.

The time is a UTC time in a fixed format complying with ISO-8601 (for example, 2018-11-14T08:59:14Z).

domain_id

String

Account ID

detail

Object

Specifies the message details.

Table 2 detail parameters

Parameter

Type

Description

resource_id

String

Specifies the resource ID.

resource_type

String

Specifies the resource type.

event_type

Enum

Specifies the event type. The value can be CREATE, UPDATE, or DELETE.

capture_time

String

Specifies the time when the event was captured.

The time is a UTC time in a fixed format complying with ISO-8601 (for example, 2018-11-14T08:59:14Z).

resource

Object

Specifies the resource details.

Table 3 resource parameters

Parameter

Type

Description

id

String

Specifies the resource ID.

name

String

Specifies the resource name.

provider

String

Specifies the cloud service name.

type

String

Specifies the cloud resource type.

region_id

String

Specifies the ID of the region where the resource is located.

project_id

String

Specifies the IAM project ID.

project_name

String

Specifies the IAM project name.

ep_id

String

Specifies the enterprise project ID.

ep_name

String

Specifies the enterprise project name.

checksum

String

Specifies the checksum.

created

String

Specifies the time when the cloud resource was created.

The time is a UTC time in a fixed format complying with ISO-8601 (for example, 2018-11-14T08:59:14Z).

updated

String

Specifies the last time when the cloud resource was updated.

The time is a UTC time in a fixed format complying with ISO-8601 (for example, 2018-11-14T08:59:14Z).

provisioning_state

String

Specifies the status of the operation that causes the resource change.

tags

Map

Specifies the cloud resource tag.

properties

Map

Specifies the cloud resource attribute.

Notification Example of Resource Changes

{
  "detail": {
    "resource": {
      "id": "3e62c0e6-e779-469e-b0f2-35743f6229d1",
      "name": "ecs-51c8",
      "provider": "evs",
      "type": "volumes",
      "checksum": "b3bcc019cecbb701e324e0dcf2f283236685885236b49f5ba5ea2f5f788170a1",
      "created": "2020-08-12T07:14:41.638Z",
      "updated": "2020-08-12T07:14:44.423Z",
      "tags": {},
      "properties": {
        "shareable": false,
        "volumeType": "SATA",
        "metadata": {},
        "attachments": [],
        "replicationStatus": "disabled",
        "availabilityZone": "regionid1a",
        "bootable": "true",
        "userId": "059b5c937d80d3e41ff3c00a3c883d16",
        "volTenantAttrTenantId": "059b5e0a2500d5552fa1c00adada8c06",
        "size": "40",
        "encrypted": false,
        "volumeImageMetadata": {
          "virtualEnvType": "FusionCompute",
          "isregistered": "true",
          "imageSourceType": "uds",
          "minDisk": "40",
          "platform": "CentOS",
          "size": 0,
          "osVersion": "CentOS 7.5 64bit",
          "minRam": "0",
          "name": "CentOS 7.5 64bit",
          "checksum": "d41d8cd98f00b204e9800998ecf8427e",
          "osBit": "64",
          "osType": "Linux",
          "containerFormat": "bare",
          "supportXen": "true",
          "id": "e0adce3a-a4d2-4207-9018-69ce64b4426a",
          "supportKvm": "true",
          "diskFormat": "zvhd2",
          "imageType": "gold"
        },
        "links": [
          {
            "rel": "self",
            "href": "https://evs.regionid1.xxxxxx.com/v2/059b5e0a2500d5552fa1c00adada8c06/os-vendor-volumes/3e62c0e6-e779-469e-b0f2-35743f6229d1"
          },
          {
            "rel": "bookmark",
            "href": "https://evs."regionid1.xxxxxx.com/059b5e0a2500d5552fa1c00adada8c06/os-vendor-volumes/3e62c0e6-e779-469e-b0f2-35743f6229d1"
          }
        ],
        "volHostAttrHost": ""regionid1a-pod01."regionid1#0",
        "multiattach": false,
        "status": "available"
      },
      "region_id": ""regionid1",
      "project_id": "059b5e0a2500d5552fa1c00adada8c06",
      "project_name": ""regionid1",
      "ep_id": "0",
      "ep_name": "default",
      "provisioning_state": "Succeeded"
    },
    "resource_id": "3e62c0e6-e779-469e-b0f2-35743f6229d1",
    "resource_type": "evs.volumes",
    "event_type": "CREATE",
    "capture_time": "2020-08-12T07:15:15.116Z"
  },
  "notification_type": "ResourceChanged",
  "notification_creation_time": "2020-08-12T07:14:47.192Z",
  "domain_id": "059b5c937100d3e40ff0c00a7675a0a0"
}

Notification Model of Resource Relationship Changes

Table 4 Parameter description

Parameter

Type

Description

notification_type

String

Specifies the message notification type.

notification_creation_time

String

Specifies the time when the message was sent.

The time is a UTC time in a fixed format complying with ISO-8601 (for example, 2018-11-14T08:59:14Z).

domain_id

String

Account ID

detail

Object

Specifies the message details.

Table 5 detail parameters

Parameter

Type

Description

resource_id

String

Specifies the resource ID.

resource_type

String

Specifies the resource type.

event_type

Enum

Specifies the event type (CHANGE).

capture_time

String

Specifies the time when the event was captured.

The time is a UTC time in a fixed format complying with ISO-8601 (for example, 2018-11-14T08:59:14Z).

Notification Example of Resource Relationship Changes

{
  "detail": {
    "resource_id": "f65b06d1-d63b-438a-93cc-bdd55b304f0a",
    "resource_type": "ecs.cloudservers",
    "event_type": "CHANGE",
    "capture_time": "2020-08-12T07:15:14.257Z"
  },
  "notification_type": "ResourceRelationChanged",
  "notification_creation_time": "2020-08-12T07:14:56.296Z",
  "domain_id": "059b5c937100d3e40ff0c00a7675a0a0"
}

Notification Model of Resource Snapshot Storage Completed

Table 6 Parameter description

Parameter

Type

Description

notification_type

String

Specifies the message notification type.

notification_creation_time

String

Specifies the time when the message was sent.

The time is a UTC time in a fixed format complying with ISO-8601 (for example, 2018-11-14T08:59:14Z).

domain_id

String

Specifies the tenant ID.

detail

Object

Specifies the message details.

Table 7 detail parameters

Parameter

Type

Description

snapshot_id

String

Specifies the resource snapshot ID.

region_id

String

Specifies the ID of the region where the resource snapshot is located.

bucket_name

String

Specifies the name of the OBS bucket where the resource snapshot is stored.

object_keys

Array of String

Specifies the resource snapshot path list.

Notification Example of Resource Snapshot Storage Completed

{
  "detail": {
    "snapshot_id": "474f85e6-72cd-442b-af4e-517120a5c669",
    "region_id": ""regionid1",
    "bucket_name": "test",
    "object_keys": [
      "RMSLogs/059b5c937100d3e40ff0c00a7675a0a0/Snapshot/2020/8/11/059b5c937100d3e40ff0c00a7675a0a0_Snapshot_"regionid1_ResourceSnapshot_2020-08-10T170901_474f85e6-72cd-442b-af4e-517120a5c669_part-1.json.gz"
    ]
  },
  "notification_type": "SnapshotArchiveCompleted",
  "notification_creation_time": "2020-08-10T17:09:27.314Z",
  "domain_id": "059b5c937100d3e40ff0c00a7675a0a0"
}

Notification Model of Resource Change Notification Storage Completed

Table 8 Parameter description

Parameter

Type

Description

notification_type

String

Specifies the message notification type.

notification_creation_time

String

Specifies the time when the message was sent.

The time is a UTC time in a fixed format complying with ISO-8601 (for example, 2018-11-14T08:59:14Z).

domain_id

String

Account ID

detail

Object

Specifies the message details.

Table 9 detail parameters

Parameter

Type

Description

region_id

String

Specifies the ID of the region where the resource snapshot is located.

bucket_name

String

Specifies the name of the OBS bucket where the resource snapshot is stored.

object_key

String

Specifies the resource snapshot path.

Notification Example of Resource Change Notification Storage Completed

{
	"detail": {
		"region_id": ""regionid1",
		"bucket_name": "test",
		"object_key": "RMSLogs/059b5c937100d3e40ff0c00a7675a0a0/Notification/2020/12/10/NotificationChunk/059b5c937100d3e40ff0c00a7675a0a0_Notification_"regionid2_NotificationChunk_VPC_VPCS_2020-12-10T024612Z_2020-12-10T050621Z.json.gz"
	},
	"notification_type": "NotificationArchiveCompleted",
	"notification_creation_time": "2020-12-10T05:09:28.002Z",
	"domain_id": "059b5c937100d3e40ff0c00a7675a0a0"
}