确认一个警报

注意

群组和项目是同义术语。您的 {PROJECT-ID} 与您的群组 ID（group ID）相同。对于现有群组，您的群组/项目 ID 保持不变。当引用说明时，此页面使用更为人熟知的术语“群组”。终结点保持不变，如文档中所述。

Resource

基本 URL： https://cloud.mongodb.com/api/public/v1.0

PATCH /groups/{PROJECT-ID}/alerts/{ALERT-ID}

请求路径参数

Parameter	类型	必要性	说明
`PROJECT-ID`	字符串	必需	设置此警报的项目的唯一标识符。
`ALERT-ID`	字符串	必需	警报的唯一标识符。

请求查询参数

以下查询参数为可选参数：

名称	类型	必要性	说明	默认
pretty	布尔	Optional	指示响应正文是否应采用 prettyprint 格式的标记。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。对于返回一个结果的端点，响应体包括： `status`: HTTP 响应代码 `content`：预期响应正文	`false`

请求正文参数

字段	类型	必要性	说明
`acknowledged` `Until`	字符串	可选的	警报应被确认到的 ISO 8601 日期和时间格式（UTC）的时间戳。要“永远”确认警报，请将该字段值设置为未来的大量年数。建议设置为 100 年后。要取消确认已确认的警报，请从请求中删除此参数。
`acknowledgement` `Comment`	字符串	Optional	此确认原因的文本描述。 Cloud Manager 在警报已确认的消息旁边显示注释。

响应

返回文档中的字段取决于警报类型：

名称	类型	说明
`acknowledged` `Until`	字符串	警报已确认的截止时间，采用 ISO 8601 日期和时间格式，以 UTC 为准。如果警报已被确认，Cloud Manager 将返回此值。
`acknowledgement` `Comment`	字符串	确认警报的用户留下的评论。如果警报已被确认，Cloud Manager 将返回此值。
`acknowledging` `Username`	字符串	确认警报的用户的用户名。如果警报已被确认，Cloud Manager 将返回此值。
`alertConfigId`	字符串	触发此警报的警报配置的唯一标识符。
`clusterId`	字符串	此警报适用的集群的唯一标识符。在以下情况下，Cloud Manager 会返回该值： `"eventTypeName" : "SHARDED_CLUSTER"`
`clusterName`	字符串	此警报适用的集群的名称。在以下情况下，Cloud Manager 会返回该值： `"eventTypeName" : "SHARDED_CLUSTER"`
`created`	字符串	警报打开时采用 ISO 8601 日期和时间格式（UTC 的时间戳）。
`currentValue`	对象	触发警报的指标的当前值。 Cloud Manager 在`"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"`的情况下返回此值。
`currentValue` `.number`	数字	指标的值。
`currentValue` `.units`	字符串	值的单位。值取决于指标类型。示例，测量内存消耗的指标将具有字节测量值，而测量时间的指标将具有时间单位。 Cloud Manager 可以返回： `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS`
`eventTypeName`	字符串	触发警报的事件的名称。接受的值为：助手 `AUTOMATION_AGENT_DOWN` `AUTOMATION_AGENT_UP` `BACKUP_AGENT_CONF_CALL_FAILURE` `BACKUP_AGENT_DOWN` `BACKUP_AGENT_UP` `BACKUP_AGENT_VERSION_BEHIND` `BACKUP_AGENT_VERSION_CURRENT` `MONITORING_AGENT_DOWN` `MONITORING_AGENT_UP` `MONITORING_AGENT_VERSION_BEHIND` `MONITORING_AGENT_VERSION_CURRENT` `NEW_AGENT` 自动化配置 `AUTOMATION_CONFIG_PUBLISHED_AUDIT` 备份 `BAD_CLUSTERSHOTS` `CLUSTER_DENYLIST_UPDATED_AUDIT` `CLUSTER_CHECKKPOINT_UPDATED_AUDIT` `CLUSTER_CREDENTIAL_UPDATED_AUDIT` `CLUSTER_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` `CLUSTER_STATE_CHANGED_AUDIT` `CLUSTER_STORAGE_ENGINE_UPDATED_AUDIT` `CLUSTERSHOT_DELETED_AUDIT` `CLUSTERSHOT_EXPIRY_UPDATED_AUDIT` `CONSISTENT_BACKUP_CONFIGURATION` `GOOD_CLUSTERSHOT` `INCONSISTENT_BACKUP_CONFIGURATION` `INITIAL_SYNC_FINISHED_AUDIT` `INITIAL_SYNC_STARTED_AUDIT` `OPLOG_BEHIND` `OPLOG_CURRENT` `RESTORE_REQUESTED_AUDIT` `RESYNC_PERFORMED` `RESYNC_REQUIRED` `RS_DENYLIST_UPDATED_AUDIT` `RS_CREDENTIAL_UPDATED_AUDIT` `RS_ROTATE_MASTER_KEY_AUDIT` `RS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` `RS_STATE_CHANGED_AUDIT` `RS_STORAGE_ENGINE_UPDATED_AUDIT` `SNAPSHOT_DELETED_AUDIT` `SNAPSHOT_EXPIRY_UPDATED_AUDIT` `SYNC_PENDING_AUDIT` `SYNC_REQUIRED_AUDIT` BI Connector `BI_CONNECTOR_DOWN` `BI_CONNECTOR_UP` 帐单 `ACCOUNT_DOWNGRADED` `ACCOUNT_UPGRADED` `CHARGE_FAILED` `CHARGE_SUCCEEDED` `CHECK_PAYMENT_RECEIVED` `CREDIT_CARD_ABOUT_TO_EXPIRE` `CREDIT_CARD_CURRENT` `CREDIT_ISSUED` `DAILY_BILL_OVER_THRESHOLD` `DAILY_BILL_UNDER_THRESHOLD` `DISCOUNT_APPLIED` `INVOICE_ADDRESS_ADDED` `INVOICE_ADDRESS_CHANGED` `INVOICE_CLOSED` `PAYMENT_FORGIVEN` `PENDING_INVOICE_OVER_THRESHOLD` `PENDING_INVOICE_UNDER_THRESHOLD` `PREPAID_PLAN_ACTIVATED` `PROMO_CODE_APPLIED` `REFUND_ISSUED` `STALE_PENDING_INVOICES` `WIRE_TRANSFER_PAYMENT_RECEIVED` 集群 `CLUSTER_MONGOS_IS_MISSING` `CLUSTER_MONGOS_IS_PRESENT` `SHARD_ADDED` `SHARD_REMOVED` 已访问数据浏览器 `DATA_EXPLORER` `DATA_EXPLORER_CRUD` 磁盘备份 `CPS_RESTORE_REQUESTED_AUDIT` 主机 `ATTEMPT_KILLOP_AUDIT` `ATTEMPT_KILLSESSION_AUDIT` `DB_PROFILER_DISABLE_AUDIT` `DB_PROFILER_ENABLE_AUDIT` `DISABLE_HOST_AUDIT` `HIDE_AND_DISABLE_HOST_AUDIT` `HIDE_HOST_AUDIT` `HOST_DOWN` `HOST_DOWNGRADED` `HOST_EXPOSED` `HOST_IP_CHANGED_AUDIT` `HOST_LOCKED_DOWN` `HOST_NOW_PRIMARY` `HOST_NOW_SECONDARY` `HOST_NOW_STANDALONE` `HOST_RECOVERED` `HOST_RECOVERING` `HOST_SECURITY_CHECKUP_NOT_MET` `HOST_SSL_CERTIFICATE_CURRENT` `HOST_SSL_CERTIFICATE_STALE` `HOST_UP` `HOST_UPGRADED` `INSIDE_METRIC_THRESHOLD` `NEW_HOST` `OUTSIDE_METRIC_THRESHOLD` `PAUSE_HOST_AUDIT` `RESUME_HOST_AUDIT` `UNDELETE_HOST_AUDIT` `VERSION_BEHIND` `VERSION_CHANGED` `VERSION_CURRENT` 组织 `ALL_ORG_USERS_HAVE_MFA` `ORG_ACTIVATED` `ORG_ADMIN_SUSPENDED` `ORG_API_KEY_ADDED` `ORG_API_KEY_DELETED` `ORG_CREDIT_CARD_ABOUT_TO_EXPIRE` `ORG_CREDIT_CARD_ADDED` `ORG_CREDIT_CARD_CURRENT` `ORG_CREDIT_CARD_UPDATED` `ORG_DAILY_BILL_OVER_THRESHOLD` `ORG_DAILY_BILL_UNDER_THRESHOLD` `ORG_EMPLOYEE_ACCESS_RESTRICTED` `ORG_EMPLOYEE_ACCESS_UNRESTRICTED` `ORG_GROUP_CHARGES_OVER_THRESHOLD` `ORG_GROUP_CHARGES_UNDER_THRESHOLD` `ORG_INVOICE_OVER_THRESHOLD` `ORG_INVOICE_UNDER_THRESHOLD` `ORG_LOCKED` `ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED` `ORG_PUBLIC_API_ACCESS_LIST_REQUIRED` `ORG_RENAMED` `ORG_SUSPENDED` `ORG_TEMPORARILY_ACTIVATED` `ORG_TWO_FACTOR_AUTH_OPTIONAL` `ORG_TWO_FACTOR_AUTH_REQUIRED` `ORG_USERS_WITHOUT_MFA` 项目 `ALL_USERS_HAVE_MULTI_FACTOR_AUTH` `DELINQUENT` `PAID_IN_FULL` `USERS_WITHOUT_MULTI_FACTOR_AUTH` 副本集(Replica Set) `CONFIGURATION_CHANGED` `ENOUGH_HEALTHY_MEMBERS` `MEMBER_ADDED` `MEMBER_REMOVED` `MULTIPLE_PRIMARIES` `NO_PRIMARY` `ONE_PRIMARY` `TOO_FEW_HEALTHY_MEMBERS` `TOO_MANY_ELECTIONS` `TOO_MANY_UNHEALTHY_MEMBERS` 支持案例 `CASE_CREATED` 团队 `TEAM_ADDED_TO_GROUP` `TEAM_CREATED` `TEAM_DELETED` `TEAM_NAME_CHANGED` `TEAM_REMOVED_FROM_GROUP` `TEAM_ROLES_MODIFIED` `TEAM_UPDATED` `USER_ADDED_TO_TEAM` user `INVITED_TO_GROUP` `INVITED_TO_ORG` `JOIN_GROUP_REQUEST_APPROVED_AUDIT` `JOIN_GROUP_REQUEST_DENIED_AUDIT` `JOINED_TEAM` `REMOVED_FROM_GROUP` `REMOVED_FROM_ORG` `REMOVED_FROM_TEAM` `REQUESTED_TO_JOIN_GROUP`
`groupId`	字符串	为其打开此警报的群组的唯一标识符。
`hostId`	字符串	指标所属主机的唯一标识符。如果`"eventTypeName"`设置为以下值之一，Cloud Manager 会返回此值： `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`hostnameAndPort`	字符串	警报应用于的每个托管的托管名和端口号。这可以是主机名、FQDN、IPv4 地址或 IPv6 地址。如果`"eventTypeName"`设置为以下值之一，Cloud Manager 会返回此值： `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`id`	字符串	警报的唯一标识符。
`lastNotified`	字符串	Timestamp in ISO 8601 date and time format in UTC when the last notification was sent for this alert. Cloud Manager returns this value if notifications have been sent.
`links`	对象数组	指向子资源和/或相关资源的一个或多个链接。响应中的所有 `links` 数组至少包含一个名为 `self` 的链接。URL之间的关系在 Web 链接规范中进行了解释。
`metricName`	字符串	Go阈值的测量名称。如果`"eventTypeName"`设为`OUTSIDE_METRIC_THRESHOLD`，Cloud Manager会返回此值。有关可能的值，请参阅警报的测量类型。
`replicaSetName`	字符串	副本集名称。如果`"eventTypeName"`设置为以下值之一，Cloud Manager 会返回此值： `BACKUP` `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`resolved`	字符串	警报关闭时采用 ISO8601 日期和时间格式（ UTC 的时间戳），位于 ISO 中。 Cloud Manager 在`"status" : "CLOSED"`的情况下返回此值。
`status`	字符串	警报的当前状态。 Cloud Manager 可以返回以下之一： `TRACKING` 警报条件存在，但持续时间尚未超过定义的通知延迟。有关详细信息，请参阅请求查询参数。 `OPEN` `CLOSED` `CANCELLED`
`sourceTypeName`	字符串	`"eventTypeName" : "BACKUP"`时正在备份的主机的类型。 Cloud Manager 可以返回以下之一： `REPLICA_SET` `SHARDED_CLUSTER` `CONFIG_SERVER`
`tags`	字符串数组	正在为此警报设置标识标签。
`typeName`	字符串	已弃用字段。\|彩信\|忽略它。
`updated`	字符串	上次更新警报时的时间戳，采用 ISO 8601 日期和时间格式（UTC 时间）。

请求示例

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \2     --header "Accept: application/json" \3     --header "Content-Type: application/json" \4     --include \5     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-CONFIG-ID}"6     --data '7       {8         "acknowledgedUntil": "2016-04-15T00:00:00-0400",9         "acknowledgementComment": "This is normal. Please ignore."10       }'

响应示例

响应标头

HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive

HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

响应体

1{2  "id" : "{ALERT-CONFIG-ID}",3  "groupId" : "{PROJECT-ID}",4  "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",5  "status" : "OPEN",6  "acknowledgedUntil" : "2014-04-15T04:00:00Z",7  "acknowledgementComment" : "This is normal. Please ignore.",8  "acknowledgingUsername" : "someuser@example.com",9  "created" : "2014-04-03T20:28:14Z",10  "updated" : "2014-04-03T20:33:14Z",11  "lastNotified" : "2014-04-03T20:33:23Z",12  "metricName": "ASSERTS_REGULAR",13  "currentValue" : {14    "number" : 0.0,15    "units" : "RAW"16  },17  "links" : []18}