ApsaraDB for MongoDB integrates with Cloud Monitor to push event notifications for scheduled Operations and Maintenance (O&M) events, minor version upgrades, instance restarts, instance migrations, primary/secondary failovers, and instance failures. Subscribe to event notifications to receive timely alerts. This topic describes the payload format and parameters of Cloud Monitor event notifications.
General notification parameters
All notifications share a common top-level structure.
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-hongkong:192******719:instance/<resource-id>",
"level": "WARN",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance_Switchover",
"content": {},
"status": "Executed"
}| Parameter | Description | Example |
|---|---|---|
product |
The cloud product that the system event belongs to. | MongoDB |
resourceID |
The affected resource. The value starts with acs:mongodb: and includes the instance region, Alibaba Cloud account ID, and instance ID. |
acs:mongodb:cn-hangzhou:135218574272**:instance/dtsb1gx8vo2265** |
level |
The severity of the system event. Valid values: CRITICAL (critical), WARN (warning), INFO (informational). |
INFO |
instanceName |
The name of the affected instance, in the format <task_ID>/<instance_name>. |
f1es8k10220****/testdb |
regionID |
The region of the instance. | cn-hangzhou |
name |
The name of the system event. For valid values, see the event name column in Supported events. | Instance:SystemMaintenance.Reboot |
content |
The event-specific payload. This field can be empty. For details, see each event type below. | - |
status |
The status of the system event. Valid values: Scheduled, Waiting, Executing, Executed, Canceled. |
Executed |
Supported events
The following table lists all supported event types, their lifecycle states, and potential impact.
| Event type | Event name | Impact |
|---|---|---|
| Instance scheduled O&M event (Scheduled) | Instance:SystemMaintenance.ScheduledOperation:Scheduled |
Varies by O&M type |
| Instance scheduled O&M event (Pre-execution reminder) | Instance:SystemMaintenance.ScheduledOperation:ReminderNotifice |
Varies by O&M type |
| Instance scheduled O&M event (Executing) | Instance:SystemMaintenance.ScheduledOperation:Executing |
Varies by O&M type |
| Instance scheduled O&M event (Executed) | Instance:SystemMaintenance.ScheduledOperation:Executed |
Varies by O&M type |
| Instance scheduled O&M event (Canceled) | Instance:SystemMaintenance.ScheduledOperation:Canceled |
None |
| Instance minor version upgrade (Scheduled) | Instance:SystemMaintenance.MinorVersionUpgrade:Scheduled |
Transient instance disconnection |
| Instance minor version upgrade (Pre-execution reminder) | Instance:SystemMaintenance.MinorVersionUpgrade:ReminderNotice |
Transient instance disconnection |
| Instance minor version upgrade (Executing) | Instance:SystemMaintenance.MinorVersionUpgrade:Executing |
Transient instance disconnection |
| Instance minor version upgrade (Executed) | Instance:SystemMaintenance.MinorVersionUpgrade:Executed |
Transient instance disconnection |
| Instance minor version upgrade (Canceled) | Instance:SystemMaintenance.MinorVersionUpgrade:Canceled |
None |
| Instance restart | Instance:SystemMaintenance.Reboot |
Transient instance disconnection |
| Instance migration (Scheduled) | Instance:SystemMaintenance.Transfer:Scheduled |
Transient instance disconnection |
| Instance migration (Pre-execution reminder) | Instance:SystemMaintenance.Transfer:ReminderNotice |
Transient instance disconnection |
| Instance migration (Executing) | Instance:SystemMaintenance.Transfer:Executing |
Transient instance disconnection |
| Instance migration (Executed) | Instance:SystemMaintenance.Transfer:Executed |
Transient instance disconnection |
| Instance migration (Canceled) | Instance:SystemMaintenance.Transfer:Canceled |
None |
| Primary/secondary failover | Instance_Failover |
Transient instance disconnection |
| Task-triggered primary/secondary switchover | Instance_Switchover |
Transient instance disconnection |
| Instance fault start | Instance_Failure_Start |
Service interruption |
| Instance fault resolved | Instance_Failure_End |
None |
Scheduled O&M events
To maintain stable, high-quality ApsaraDB services, Alibaba Cloud may initiate scheduled O&M events for your instances. These events include software and hardware upgrades, configuration upgrades, network upgrades, and parameter adjustments. Notifications are sent at each stage: when an event is scheduled, before it starts, while it is running, after it completes, and if it is canceled.
The following examples use an SSL certificate update as the representative scenario.
Scheduled
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-shanghai:192******11719:instance/<resource-id>",
"level": "INFO",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance:SystemMaintenance.ScheduledOperation:Scheduled",
"content": {
"eventId": "b26***5bc",
"publishTime": "2025-09-02T10:00:54+08:00",
"reason": "*** cer***ate *** ab*** *** ex***",
"product": "Mo***DB",
"instanceComment": "dds***e54",
"instanceId": "dds***e54",
"extra": {
"eventCode": "rds***ate",
"instanceInfo": "",
"eventNameEn": "*** cer***ate up***",
"impactZh": "Transient instance disconnection",
"impactEn": "Tr***nt in***ce dis***ion",
"startTime": "2025-09-19T02:00:00+08:00",
"detailCode": "SSL***ire",
"switchTime": "2025-09-19T02:10:00+08:00",
"cancelCode": "Aff***ire",
"eventNameZh": "SSL Certificate update"
},
"instanceType": "In***ce",
"eventType": "Mai***nce"
},
"status": "Scheduled"
}content field parameters:
| Parameter | Description | Example |
|---|---|---|
eventId |
The unique ID of the event. | 45d924b0-1131-54e8-bb74-1205fbbcc7d6 |
product |
The product name. | MongoDB |
reason |
The reason for the event. | SSL certificate is about to expire |
instanceId |
The instance ID. | dds-***ce4 |
instanceComment |
The instance name. | dds-***ce4 |
instanceType |
The instance type. Valid values: Instance (instance event), Host (host event). |
Instance |
eventType |
The event type. | Maintenance |
publishTime |
The time when the notification was created. | 2025-09-01T10:10:43+08:00 |
extra |
Extended event information. | - |
extra.eventCode |
The event code. | rds_apsaradb_ssl_update |
extra.eventNameEn |
The event name in English. | SSL certificate update |
extra.eventNameZh |
The event name in Chinese. | SSL Certificate update |
extra.impactEn |
The impact of the event in English. | Transient instance disconnection |
extra.impactZh |
The impact of the event in Chinese. | Transient instance disconnection |
extra.startTime |
The scheduled start time of the event. | 2025-09-01T02:00:00+08:00 |
extra.switchTime |
The scheduled switchover time. | 2025-09-01T02:10:00+08:00 |
extra.detailCode |
The code identifying the specific O&M operation. | SSLCertificateAboutToExpire |
extra.cancelCode |
The event cancellation code. | AffectAvailabilityWhenSSLExpire |
extra.instanceInfo |
Component-level instance information. This parameter is available only for sharded cluster instances. | - |
Pre-execution reminder
A reminder notification is sent before the scheduled event starts (status: Waiting). The content field has the same structure as the Scheduled notification, with the same parameters. The extra field does not include execTime.
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-hongkong:192******719:instance/<resource-id>",
"level": "WARN",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance:SystemMaintenance.ScheduledOperation:ReminderNotifice",
"content": {
"eventId": "9715f9ef-54b0-54da-9d56-9d2b11608d59",
"product": "MongoDB",
"reason": "SSL certificate is about to expire",
"extra": {
"impactEn": "Transient instance disconnection",
"eventCode": "rds_apsaradb_ssl_update",
"eventNameEn": "SSL certificate update",
"eventNameZh": "SSL Certificate update",
"detailCode": "SSLCertificateAboutToExpire",
"switchTime": "2025-09-01T02:10:00+08:00",
"startTime": "2025-09-01T02:00:00+08:00",
"cancelCode": "AffectAvailabilityWhenSSLExpire",
"impactZh": "Transient instance disconnection",
"instanceInfo": ""
},
"instanceId": "dds-***f4",
"eventType": "Maintenance",
"instanceComment": "dds-***f4",
"instanceType": "Instance",
"publishTime": "2025-08-12T16:01:26+08:00"
},
"status": "Waiting"
}Executing
When the event enters execution (status: Executing), the extra.execTime field is added to indicate when execution started. The extra.impactZh field may contain a detailed status message during this phase.
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-hongkong:192******719:instance/<resource-id>",
"level": "WARN",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance:SystemMaintenance.ScheduledOperation:Executing",
"content": {
"eventId": "9715f9ef-54b0-54da-9d56-9d2b11608d59",
"product": "MongoDB",
"reason": "SSL certificate is about to expire",
"extra": {
"impactEn": "Transient instance disconnection",
"eventCode": "rds_apsaradb_ssl_update",
"execTime": "2025-09-01T02:00:27+08:00",
"eventNameEn": "SSL certificate update",
"eventNameZh": "SSL Certificate update",
"detailCode": "SSLCertificateAboutToExpire",
"cancelCode": "AffectAvailabilityWhenSSLExpire",
"impactZh": "The task has entered the scheduling queue. The switchover is expected to start at 2025-09-01T02:10:00+08:00. Before the switchover, availability is not affected.",
"instanceInfo": ""
},
"instanceId": "dds-***5f4",
"eventType": "Maintenance",
"instanceComment": "dds-***5f4",
"instanceType": "Instance",
"publishTime": "2025-09-01T02:00:27+08:00"
},
"status": "Executing"
}Additional extra parameter for the Executing state:
| Parameter | Description | Example |
|---|---|---|
extra.execTime |
The time when the event started executing. | 2025-09-01T02:00:00+08:00 |
Executed
When the event completes (status: Executed), the extra.execTime field records the completion time.
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-hongkong:192******719:instance/<resource-id>",
"level": "WARN",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance:SystemMaintenance.ScheduledOperation:Executed",
"content": {
"eventId": "9715f9ef-54b0-54da-9d56-9d2b11608d59",
"product": "MongoDB",
"reason": "SSL certificate is about to expire",
"extra": {
"impactEn": "Transient instance disconnection",
"eventCode": "rds_apsaradb_ssl_update",
"execTime": "2025-09-01T02:00:27+08:00",
"eventNameEn": "SSL certificate update",
"eventNameZh": "SSL Certificate update",
"detailCode": "SSLCertificateAboutToExpire",
"cancelCode": "AffectAvailabilityWhenSSLExpire",
"impactZh": "Transient instance disconnection",
"instanceInfo": ""
},
"instanceId": "dds-***5f4",
"eventType": "Maintenance",
"instanceComment": "dds-***5f4",
"instanceType": "Instance",
"publishTime": "2025-09-01T02:00:27+08:00"
},
"status": "Executed"
}Additional extra parameter for the Executed state:
| Parameter | Description | Example |
|---|---|---|
extra.execTime |
The time when the event completed. | 2025-09-01T02:00:00+08:00 |
Canceled
When the event is canceled (status: Canceled), the extra field omits startTime, switchTime, execTime, impactEn, and impactZh.
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-hongkong:192******719:instance/<resource-id>",
"level": "WARN",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance:SystemMaintenance.ScheduledOperation:Canceled",
"content": {
"eventId": "1ac4dbdc-1cec-5af2-9293-d6520c0dfb9c",
"product": "MongoDB",
"reason": "SSL certificate is about to expire",
"extra": {
"eventCode": "rds_apsaradb_ssl_update",
"eventNameEn": "SSL certificate update",
"eventNameZh": "SSL Certificate update",
"detailCode": "SSLCertificateAboutToExpire",
"cancelCode": "AffectAvailabilityWhenSSLExpire",
"instanceInfo": ""
},
"instanceId": "dds-***5f4",
"eventType": "Maintenance",
"instanceComment": "dds-***5f4",
"instanceType": "Instance",
"publishTime": "2025-08-03T00:14:25+08:00"
},
"status": "Canceled"
}Minor version upgrades
Notifications are sent at each stage of the minor version upgrade process. The content field structure is identical to that of scheduled O&M events, with the same parameters. The examples below use a proxy node host maintenance scenario.
Scheduled
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-hongkong:192******11719:instance/<resource-id>",
"level": "WARN",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance:SystemMaintenance.MinorVersionUpgrade:Scheduled",
"content": {
"eventId": "7643e4c3-21f6-543e-af78-adbae1913692",
"product": "MongoDB",
"reason": "Proxy node host maintenance/upgrade",
"extra": {
"impactEn": "Transient instance disconnection, minor version upgrade",
"eventCode": "rds_apsaradb_upgrade",
"eventNameEn": "Minor version update",
"eventNameZh": "Minor version upgrade",
"detailCode": "ProxyNodeHostMaintain",
"switchTime": "2025-09-16T03:30:00+08:00",
"startTime": "2025-09-16T03:25:00+08:00",
"cancelCode": "HostMachineRiskProxyStability",
"impactZh": "Transient instance disconnection, minor version number update",
"instanceInfo": ""
},
"instanceId": "dds-***04",
"eventType": "Maintenance",
"instanceComment": "Replica***Subscription",
"instanceType": "Instance",
"publishTime": "2025-09-02T16:32:25+08:00"
},
"status": "Scheduled"
}For content field parameters, see the Scheduled O&M events section. The extra.eventCode value for minor version upgrade events is rds_apsaradb_upgrade.
Pre-execution reminder
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:na-south-1:176******461:instance/<resource-id>",
"level": "INFO",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance:SystemMaintenance.MinorVersionUpgrade:ReminderNotice",
"content": {
"eventId": "7c6228ee-8a28-5cc3-a374-44a68cb52686",
"product": "MongoDB",
"reason": "Proxy node host maintenance/upgrade",
"extra": {
"impactEn": "Transient instance disconnection, minor version upgrade",
"eventCode": "rds_apsaradb_upgrade",
"eventNameEn": "Minor version update",
"eventNameZh": "Minor version upgrade",
"detailCode": "ProxyNodeHostMaintain",
"switchTime": "2025-08-13T04:50:00+08:00",
"startTime": "2025-08-13T04:45:00+08:00",
"cancelCode": "HostMachineRiskProxyStability",
"impactZh": "Transient instance disconnection, minor version number update",
"instanceInfo": "s-pz***384,s-pz***9d4,d-pz***f84,dds-pz***5f4-cs,d-pz***a14"
},
"instanceId": "dds-***5f4",
"eventType": "Maintenance",
"instanceComment": "dds-***5f4",
"instanceType": "Instance",
"publishTime": "2025-08-06T14:10:56+08:00"
},
"status": "Waiting"
}Executing
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-hongkong:192******11719:instance/<resource-id>",
"level": "WARN",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance:SystemMaintenance.MinorVersionUpgrade:Executing",
"content": {
"eventId": "d1eb313e-eb1d-5f8f-b78b-b34a261604e9",
"product": "MongoDB",
"reason": "Proxy node host maintenance/upgrade",
"extra": {
"impactEn": "Transient instance disconnection, minor version upgrade",
"eventCode": "rds_apsaradb_upgrade",
"execTime": "2025-07-24T16:47:56+08:00",
"eventNameEn": "Minor version update",
"eventNameZh": "Minor version upgrade",
"detailCode": "ProxyNodeHostMaintain",
"cancelCode": "HostMachineRiskProxyStability",
"impactZh": "The task has entered the scheduling queue. The switchover is expected to start at 2025-07-24T16:52:52+08:00. Before the switchover, availability is not affected.",
"instanceInfo": ""
},
"instanceId": "dds-***394",
"eventType": "Maintenance",
"instanceComment": "dds-***394",
"instanceType": "Instance",
"publishTime": "2025-07-24T16:47:56+08:00"
},
"status": "Executing"
}Executed
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-hongkong:192******11719:instance/<resource-id>",
"level": "WARN",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance:SystemMaintenance.MinorVersionUpgrade:Executed",
"content": {
"eventId": "245075c7-1a14-59af-a234-61ee25094860",
"product": "MongoDB",
"reason": "Proxy node host maintenance/upgrade",
"extra": {
"impactEn": "Transient instance disconnection, minor version upgrade",
"eventCode": "rds_apsaradb_upgrade",
"execTime": "2025-07-24T16:52:54+08:00",
"eventNameEn": "Minor version update",
"eventNameZh": "Minor version upgrade",
"detailCode": "ProxyNodeHostMaintain",
"cancelCode": "HostMachineRiskProxyStability",
"impactZh": "Transient instance disconnection, minor version number update",
"instanceInfo": "s-***354,s-***b24,d-***264,d-***844,dds-***4-cs"
},
"instanceId": "dds-pz51c4144f4747a4",
"eventType": "Maintenance",
"instanceComment": "zq-sharding-ssd-prepaid",
"instanceType": "Instance",
"publishTime": "2025-07-24T15:52:55+08:00"
},
"status": "Executed"
}Canceled
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-hongkong:192******11719:instance/<resource-id>",
"level": "WARN",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance:SystemMaintenance.MinorVersionUpgrade:Canceled",
"content": {
"eventId": "399bf2a3-254c-5386-acd5-a124ab63060c",
"product": "MongoDB",
"reason": "Proxy node host maintenance/upgrade",
"extra": {
"eventCode": "rds_apsaradb_upgrade",
"eventNameEn": "Minor version update",
"eventNameZh": "Minor version upgrade",
"detailCode": "ProxyNodeHostMaintain",
"cancelCode": "HostMachineRiskProxyStability",
"instanceInfo": ""
},
"instanceId": "dds-***6b4",
"eventType": "Maintenance",
"instanceComment": "dds-***6b4",
"instanceType": "Instance",
"publishTime": "2025-07-24T17:13:35+08:00"
},
"status": "Canceled"
}Instance restart
An instance restart notification is sent when a user or system triggers a restart. This is a single-state notification (no lifecycle stages).
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:na-south-1:176******461:instance/<resource-id>",
"level": "INFO",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance:SystemMaintenance.Reboot",
"content": {
"eventId": "740e68cd6c4b92e1143ecad98d54a0ad",
"product": "MongoDB",
"reason": "",
"extra": {
"eventTime": "2025-08-26T12:36:06+08:00",
"cloudEvent": {
"data": {
"uid": "140******49",
"eventCode": "Instance:SystemMaintenance.Reboot",
"instanceId": "dds-***0c4",
"eventType": "SystemMaintenance",
"regionID": "cn-shenzhen",
"eventId": "e-0mqrlfhomixumi6osh",
"maineventId": null,
"eventReason": "SystemMaintenance.Reboot",
"hasLifeCycle": 0,
"dbType": "mongodb",
"cmsProduct": "MongoDB",
"product": "dds",
"handleStatus": "None",
"sourceType": "User",
"eventDetail": "{\"caller_user_ID\":\"\",\"node_name\":\"dds-***0c4\"}",
"eventCategory": "Notification",
"detailImpact": "-",
"isClosed": 1,
"eventImpact": "Reboot",
"startTime": "2025-08-26T04:36:06Z",
"gmtModified": "2025-08-26T04:37:27Z",
"eventLevel": "INFO",
"detailReason": "-",
"resourceType": "Instance",
"gmtCreated": "2025-08-26T04:37:27Z",
"eventStatus": "Executed",
"endTime": "2025-08-26T04:36:06Z"
},
"region": "cn-shenzhen",
"time": "2025-08-26T04:37:27Z",
"source": "acs:dds:mongodb",
"type": "Instance:SystemMaintenance.Reboot",
"specversion": "1.0",
"ID": "e-0mqrlfhomixumi6osh",
"subject": "acs:dds:cn-shenzhen:140******49:instance/dds-***0c4"
},
"region": "cn-shenzhen"
},
"instanceId": "dds-***0c4",
"eventType": "Notification",
"instanceComment": "dusai_api_test_EncryptionKey",
"instanceType": "Instance",
"publishTime": "2025-08-26T12:37:34+08:00"
},
"status": "Executed"
}The instance restart notification uses a CloudEvents-formatted payload inside extra.cloudEvent. All content field parameters are described below.
content field parameters:
| Parameter | Description | Example |
|---|---|---|
eventId |
The unique ID of the event. | 740e68cd6c4b92e1143ecad98d54a0ad |
product |
The product name. | MongoDB |
reason |
The reason for the event. | - |
instanceId |
The instance ID. | dds-***ce4 |
instanceComment |
The instance name. | api_test |
instanceType |
The instance type. Valid values: Instance (instance event), Host (host event). |
Instance |
eventType |
The event type. | Notification |
publishTime |
The time when the notification was created. | 2025-08-26T12:37:34+08:00 |
extra.eventTime |
The time when the event was recorded. | 2025-08-26T12:36:06+08:00 |
extra.cloudEvent.data.uid |
The user ID associated with the instance. | 140******49 |
extra.cloudEvent.data.eventCode |
The event name. | Instance:SystemMaintenance.Reboot |
extra.cloudEvent.data.instanceId |
The instance ID. | dds-***0c4 |
extra.cloudEvent.data.eventType |
The event type. | SystemMaintenance |
extra.cloudEvent.data.regionID |
The region where the event occurred. | cn-shenzhen |
extra.cloudEvent.data.eventId |
The UUID that uniquely identifies this event record. | e-0mqrlfhomixumi6osh |
extra.cloudEvent.data.maineventId |
The ID of the parent event. null if no parent event exists. |
null |
extra.cloudEvent.data.eventReason |
The reason for the event. | SystemMaintenance.Reboot |
extra.cloudEvent.data.hasLifeCycle |
Whether the event has a lifecycle. 0 means no lifecycle. |
0 |
extra.cloudEvent.data.dbType |
The database type. | mongodb |
extra.cloudEvent.data.cmsProduct |
The product name used in Cloud Monitor. | MongoDB |
extra.cloudEvent.data.product |
The product code. | dds |
extra.cloudEvent.data.handleStatus |
The handling status of the event. | None |
extra.cloudEvent.data.sourceType |
The source that triggered the event. Valid values: User, ScheduledEventUser, ScheduledEvent. |
User |
extra.cloudEvent.data.eventDetail |
A JSON string containing additional details, such as the caller user ID and node name. | {\"caller_user_ID\":\"\",\"node_name\":\"dds-***0c4\"} |
extra.cloudEvent.data.eventCategory |
The event category. | Notification |
extra.cloudEvent.data.detailImpact |
The detailed impact description. | - |
extra.cloudEvent.data.isClosed |
Whether the event is closed. | 1 |
extra.cloudEvent.data.eventImpact |
The impact of the event. | Reboot |
extra.cloudEvent.data.startTime |
The time when the event was reported (UTC). | 2025-08-26T04:36:06Z |
extra.cloudEvent.data.gmtModified |
The time when the event record was last modified (UTC). | 2025-08-26T04:37:27Z |
extra.cloudEvent.data.eventLevel |
The event severity. Valid values: INFO, WARN, CRITICAL. |
INFO |
extra.cloudEvent.data.detailReason |
The detailed reason for the event. | - |
extra.cloudEvent.data.resourceType |
The resource type. Valid values: Instance (instance event), Host (host event). |
Instance |
extra.cloudEvent.data.gmtCreated |
The time when the event record was created (UTC). | 2025-08-26T04:37:27Z |
extra.cloudEvent.data.eventStatus |
The event status. | Executed |
extra.cloudEvent.data.endTime |
The time when the event ended (UTC). | 2025-08-26T04:36:06Z |
extra.cloudEvent.region |
The region where the event occurred. | cn-shenzhen |
extra.cloudEvent.time |
The time when the event was processed (UTC). | 2025-08-26T04:37:27Z |
extra.cloudEvent.source |
The event source. Format: acs:${product}:${dbtype}. |
acs:dds:mongodb |
extra.cloudEvent.type |
The event class identifier. Format: (Instance|Host|Component):(ExceptionEvent|${other_event}). |
Instance:SystemMaintenance.Reboot |
extra.cloudEvent.specversion |
The CloudEvents specification version. Fixed to 1.0. |
1.0 |
extra.cloudEvent.id |
The UUID that uniquely identifies this event record. | e-0mqrlfhomixumi6osh |
extra.cloudEvent.subject |
The entity where the event occurred. Format: acs:${product}:${dbtype}:${region}:${accountID}:(instance|host|component)/${target_name}. |
acs:dds:cn-shenzhen:140****49:instance/dds-*0c4 |
Instance migrations
Notifications are sent at each stage of the instance migration process. The content field structure is the same as scheduled O&M events. The examples below use a host software/hardware upgrade scenario.
Scheduled
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-hongkong:192******11719:instance/<resource-id>",
"level": "WARN",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance:SystemMaintenance.Transfer:Scheduled",
"content": {
"eventId": "50f7a836-e9a7-543a-9e3a-95ac0d757b35",
"product": "MongoDB",
"reason": "Host software/hardware upgrade",
"extra": {
"impactEn": "Transient instance disconnection",
"eventCode": "rds_apsaradb_transfer",
"eventNameEn": "Instance migration",
"eventNameZh": "Instance migration",
"detailCode": "HostSoftHardwareUpgrade",
"switchTime": "2025-08-25T04:30:00+08:00",
"startTime": "2025-08-24T15:30:00+08:00",
"cancelCode": "OutOfGoodPerfBySoftHardwareUpgrade",
"impactZh": "Transient instance disconnection",
"instanceInfo": ""
},
"instanceId": "dds-t4n6ab765e1a90d4",
"eventType": "Maintenance",
"instanceComment": "whisper_sg",
"instanceType": "Instance",
"publishTime": "2025-08-20T16:00:55+08:00"
},
"status": "Scheduled"
}For content field parameters, see the Scheduled O&M events section. The extra.eventCode value for instance migration events is rds_apsaradb_transfer.
Pre-execution reminder
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-hongkong:192******11719:instance/<resource-id>",
"level": "WARN",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance:SystemMaintenance.Transfer:Waiting",
"content": {
"eventId": "b062abe3-2ad1-511f-a379-0d7a4e08de99",
"product": "MongoDB",
"reason": "Host software/hardware upgrade",
"extra": {
"impactEn": "Transient instance disconnection",
"eventCode": "rds_apsaradb_transfer",
"eventNameEn": "Instance migration",
"eventNameZh": "Instance migration",
"detailCode": "HostSoftHardwareUpgrade",
"switchTime": "2025-08-25T04:30:00+08:00",
"startTime": "2025-08-24T15:30:00+08:00",
"cancelCode": "OutOfGoodPerfBySoftHardwareUpgrade",
"impactZh": "Transient instance disconnection",
"instanceInfo": ""
},
"instanceId": "dds-***ce4",
"eventType": "Maintenance",
"instanceComment": "Production mongod",
"instanceType": "Instance",
"publishTime": "2025-08-24T06:30:00+08:00"
},
"status": "Waiting"
}Executing
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-hongkong:192******11719:instance/<resource-id>",
"level": "WARN",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance:SystemMaintenance.Transfer:Executing",
"content": {
"eventId": "b062abe3-2ad1-511f-a379-0d7a4e08de99",
"product": "MongoDB",
"reason": "Host software/hardware upgrade",
"extra": {
"impactEn": "Transient instance disconnection",
"eventCode": "rds_apsaradb_transfer",
"execTime": "2025-08-25T05:00:01+08:00",
"eventNameEn": "Instance migration",
"eventNameZh": "Instance migration",
"detailCode": "HostSoftHardwareUpgrade",
"cancelCode": "OutOfGoodPerfBySoftHardwareUpgrade",
"impactZh": "The task has entered the scheduling queue. The switch is expected to start at 2025-08-25T05:10:00+08:00. Availability is not affected before the switch.",
"instanceInfo": ""
},
"instanceId": "dds-***0a4",
"eventType": "Maintenance",
"instanceComment": "dds-***0a4",
"instanceType": "Instance",
"publishTime": "2025-08-25T05:00:01+08:00"
},
"status": "Executing"
}Executed
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-hongkong:192******11719:instance/<resource-id>",
"level": "WARN",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance:SystemMaintenance.Transfer:Executed",
"content": {
"eventId": "b062abe3-2ad1-511f-a379-0d7a4e08de99",
"product": "MongoDB",
"reason": "Host software/hardware upgrade",
"extra": {
"impactEn": "Transient instance disconnection",
"eventCode": "rds_apsaradb_transfer",
"execTime": "2025-08-25T06:30:00+08:00",
"eventNameEn": "Instance migration",
"eventNameZh": "Instance migration",
"detailCode": "HostSoftHardwareUpgrade",
"cancelCode": "OutOfGoodPerfBySoftHardwareUpgrade",
"impactZh": "Transient instance disconnection",
"instanceInfo": ""
},
"instanceId": "dds-***0a4",
"eventType": "Maintenance",
"instanceComment": "dds-***0a4",
"instanceType": "Instance",
"publishTime": "2025-08-25T06:30:00+08:00"
},
"status": "Executed"
}Canceled
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-hongkong:192******11719:instance/<resource-id>",
"level": "WARN",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance:SystemMaintenance.Transfer:Canceled",
"content": {
"eventId": "ba074fbf-9e57-5199-a70f-1976d1ef249e",
"product": "MongoDB",
"reason": "Host software/hardware upgrade",
"extra": {
"eventCode": "rds_apsaradb_transfer",
"eventNameEn": "Instance migration",
"eventNameZh": "Instance migration",
"detailCode": "HostSoftHardwareUpgrade",
"cancelCode": "OutOfGoodPerfBySoftHardwareUpgrade",
"instanceInfo": ""
},
"instanceId": "dds-***6b4",
"eventType": "Maintenance",
"instanceComment": "dds-***6b4",
"instanceType": "Instance",
"publishTime": "2025-08-16T22:21:00+08:00"
},
"status": "Canceled"
}Primary/secondary failover
ApsaraDB for MongoDB sends notifications for two types of primary/secondary role changes: automatic failovers triggered by an instance fault, and task-triggered switchovers.
Failover
An automatic failover occurs when the primary node becomes unavailable.
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-shanghai-cloudspe:192****1719:instance/<resource-id>",
"level": "WARN",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance_Failover",
"content": {
"InstanceName": "dds***b84",
"eventId": "7b1***b2c",
"publishTime": "2025-09-02T10:27:15+08:00",
"reason": "",
"product": "Mo***DB",
"instanceComment": "dds***b84",
"instanceId": "dds***b84",
"EventType": "Ins***nce",
"extra": {
"node": "",
"impact": "Instance***",
"reason": "Instance fault (*** error))",
"eventTime": "2025-09-02T10:26:41+08:00",
"nodeInfo": [],
"reasonCode": "Pla***ror"
},
"instanceType": "In***ce",
"eventType": "Ins***nce",
"Timestamp": "1756780035.398"
},
"status": "Executed"
}content field parameters:
| Parameter | Description | Example |
|---|---|---|
InstanceName |
The instance name. | dds***b84 |
eventId |
The unique ID of the event. | 7b1***b2c |
publishTime |
The time when the notification was created. | 2025-09-01T10:10:43+08:00 |
reason |
The reason for the event. | - |
product |
The product name. | MongoDB |
instanceComment |
The instance name. | dds***b84 |
instanceId |
The instance ID. | dds***b84 |
instanceType |
The instance type. Valid values: Instance (instance event), Host (host event). |
Instance |
eventType |
The event type. | InstanceMaintenance |
extra |
Extended event information. | - |
extra.eventTime |
The time when the event was triggered. | 2025-09-01T10:09:32+08:00 |
extra.nodeInfo |
Information about the nodes involved in the event. | - |
extra.nodeEn |
Node information in English. | - |
extra.nodeZh |
Node information in Chinese. For sharded cluster instances, this may contain node IDs such as d-bp11eb739a1f81c4. |
- |
extra.reasonCode |
The reason code for the event. | Platform.Ha.PrimaryInstanceUnavailable |
extra.reasonEn |
The reason for the event in English. | Instance Failures(Primary Instance Unavailable) |
extra.reasonZh |
The reason for the event in Chinese. | Instance is abnormal (Master is unavailable). |
extra.impactEn |
The impact of the event in English. | Transient instance disconnection |
extra.impactZh |
The impact of the event in Chinese. | Transient instance disconnection. |
Switchover
A switchover is triggered by a task (for example, a manual switchover initiated through the console or API).
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:cn-qingdao:192****1719:instance/<resource-id>",
"level": "WARN",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance_Switchover",
"content": {
"eventId": "569279dc-bc3c-5007-a84b-92a4acbe82ab",
"product": "MongoDB",
"reason": "",
"extra": {
"eventTime": "2025-09-01T10:31:48+08:00",
"impact": "Transient instance disconnection",
"nodeInfo": [],
"node": "",
"reason": "",
"reasonCode": ""
},
"instanceId": "dds-****54",
"eventType": "InstanceMaintenance",
"instanceComment": "du***test",
"instanceType": "Instance",
"publishTime": "2025-09-01T10:32:43+08:00"
},
"status": "Executed"
}The content field parameters are the same as the Failover notification, with extra.reasonCode, extra.reasonEn, and extra.reasonZh typically empty for task-triggered switchovers.
Instance faults
Instance fault notifications are sent when an instance enters a fault state and again when the fault is resolved.
Fault start
When an instance fault begins (status: Executing), a CRITICAL-level notification is sent.
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:na-south-1:192****1719:instance/<resource-id>",
"level": "CRITICAL",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance_Failure_Start",
"content": {
"eventId": "44e3e82d-9738-5cd4-bccc-8e51d2a5e345",
"product": "MongoDB",
"reason": "",
"extra": {
"eventTime": "2025-08-31T20:33:21+08:00",
"impactEn": "",
"nodeInfo": [],
"nodeZh": "",
"reasonEn": "",
"reasonZh": "",
"nodeEn": "",
"impactZh": "",
"reasonCode": ""
},
"instanceId": "dds-***8d84",
"eventType": "InstanceFailure",
"instanceComment": "dds-***8d84",
"instanceType": "Instance",
"publishTime": "2025-08-31T20:33:42+08:00"
},
"status": "Executing"
}content field parameters:
| Parameter | Description | Example |
|---|---|---|
eventId |
The unique ID of the event. | 7b1***b2c |
publishTime |
The time when the notification was created. | 2025-09-01T10:10:43+08:00 |
reason |
The reason for the event. | - |
product |
The product name. | MongoDB |
instanceComment |
The instance name. | dds***b84 |
instanceId |
The instance ID. | dds***b84 |
instanceType |
The instance type. Valid values: Instance (instance event), Host (host event). |
Instance |
eventType |
The event type. InstanceFailure for fault start, InstanceFailureRecovery for fault resolved. |
InstanceFailure |
extra |
Extended event information. | - |
extra.eventTime |
The time when the event was triggered. | 2025-09-01T10:09:32+08:00 |
extra.nodeInfo |
Information about the nodes involved in the event. | - |
extra.nodeEn |
Node information in English. | - |
extra.nodeZh |
Node information in Chinese. | - |
extra.reasonCode |
The reason code for the event. | - |
extra.reasonEn |
The reason for the event in English. | - |
extra.reasonZh |
The reason for the event in Chinese. | - |
extra.impactEn |
The impact of the event in English. | - |
extra.impactZh |
The impact of the event in Chinese. | - |
Fault resolved
When the fault is resolved (status: Executed), another CRITICAL-level notification is sent. The eventType changes to InstanceFailureRecovery.
Notification example:
{
"product": "MongoDB",
"resourceID": "acs:mongodb:na-south-1:192****1719:instance/<resource-id>",
"level": "CRITICAL",
"instanceName": "instanceName",
"regionID": "cn-hangzhou",
"name": "Instance_Failure_End",
"content": {
"eventId": "b37da090-ca56-512c-9f17-43dd91820378",
"product": "MongoDB",
"reason": "",
"extra": {
"eventTime": "2025-08-31T20:36:21+08:00",
"impactEn": "",
"nodeInfo": [],
"nodeZh": "",
"reasonEn": "",
"reasonZh": "",
"nodeEn": "",
"impactZh": "",
"reasonCode": ""
},
"instanceId": "dds-***8d84",
"eventType": "InstanceFailureRecovery",
"instanceComment": "dds-***8d84",
"instanceType": "Instance",
"publishTime": "2025-08-31T20:36:43+08:00"
},
"status": "Executed"
}The content field parameters are the same as the fault start notification. The key difference is eventType: InstanceFailureRecovery and status: Executed.