<ph type="x-smartling-placeholder"></ph>
您正在查看 Apigee Edge 文档。
转到
Apigee X 文档。 信息
使用 TLS 到期提醒来 在环境中的 TLS 证书即将到期时收到通知。
TLS 证书简介
TLS(传输层安全协议)是一种标准的安全技术 用于在网络服务器和 Web 客户端(例如浏览器或 应用。加密链接可确保服务器和客户端之间传递的所有数据都保持不变。 私密。
TLS 证书是数字文件,用于标识 TLS 事务中的实体。Edge 使用 TLS cert 用于为以下项配置 TLS:
- 通过 API 客户端访问您的 API 代理。 使用虚拟主机 来配置 TLS
- 通过 Edge 访问后端服务。 使用目标端点和目标服务器 ,以便配置 TLS。
TLS 证书包含失效日期。如果 TLS 证书过期,TLS 连接将失败 直到更新证书为止。这意味着,除非您更新证书,否则对您的 API 的所有请求都将失败。
关于到期提醒
您不必等待证书过期或对 API 发出的请求失败,而是使用 到期提醒 在环境中的任何 TLS 证书即将过期时收到通知。 触发提醒后,您可以更新证书,这样您的客户就不会 以确保服务出现中断。
配置提醒时,请不要指定单独的证书,而应指定特定环境。 系统会在安排部署的任何证书时触发提醒 在指定时间范围内过期
您可以将到期提醒设置为发生以下情况:
- 证书过期前 1 天
- 证书到期前 14 天
- 证书到期前 30 天
添加到期提醒和通知
如需添加到期提醒和通知,请按以下步骤操作: <ph type="x-smartling-placeholder">- </ph>
- 在 Edge 界面中点击分析 > 提醒规则。
- 点击 +提醒。
- 输入以下有关提醒的常规信息:
字段 说明 提醒名称 提醒的名称。请使用能够描述触发器且对您有意义的名称。 该名称不能超过 128 个字符。 说明 提醒的说明。 提醒类型 选择 TLS 到期。请参阅 如需了解详情,请参阅提醒类型简介。 环境 从下拉列表中选择环境。 状态 切换以启用或停用提醒。 - 为触发提醒的条件定义阈值和维度。
条件字段 说明 阈值 配置即将过期的证书的时间范围。您可以选择在证书即将到期时发出提醒:
- 1 天
- 14 天
- 30 天
维度 维度固定为 任何 TLS 证书。 - 点击 + 通知 即可添加提醒通知。
通知详情 说明 Channel 选择要使用的通知渠道并指定目标位置:Email、Slack、PagerDuty 或网络钩子。 目标 根据所选渠道类型指定目标位置: <ph type="x-smartling-placeholder"> - </ph>
- 电子邮件地址 - 电子邮件地址,例如
joe@company.com
- Slack - Slack 频道网址,例如
https://hooks.slack.com/services/T00000000/B00000000/XXXXX
- PagerDuty - PagerDuty 代码(例如
abcd1234efgh56789
) - 网络钩子 - 网络钩子网址,例如
https://apigee.com/test-webhook
注意:您只能为每条通知指定一个目的地。指定多个目的地 同一频道类型,请添加其他通知。
- 电子邮件地址 - 电子邮件地址,例如
- 要添加其他通知,请重复上一步。
- 如果您添加了通知,请设置以下字段:
字段 说明 Playbook (可选)自由格式的文本字段,用于对解决建议采取的措施提供简要说明 以及它们在触发时的提醒您还可以指定一个指向您的内部 Wiki 或社区页面的链接, 您可以参考最佳做法此字段中的信息将包含在通知中。 此字段中的内容不能超过 1500 个字符。 Throttle 发送通知的频率。从下拉列表中选择一个值。 - 点击保存。
在事件信息中心内查看提醒
当 Edge 检测到警报条件时,会自动将该条件记录到 Edge 界面中的事件信息中心。事件信息中心中显示的事件列表 包括所有提醒,包括固定提醒和证书提醒。
要查看提醒,请执行以下操作:
在 Edge 界面中依次点击 Analyze > Events。系统会显示新的“活动”信息中心:
按以下条件过滤“事件”信息中心:
- 环境
- 区域
- 时间段
- 在事件信息中心内选择一行,以显示包含即将过期的证书的密钥库 进一步调查相应提醒。在“密钥库”页面中,您可以上传新证书并删除 即将过期的证书
将提醒 API 用于到期提醒
您用于创建和管理到期提醒的大多数 API 都与您所用的 API 相同 以及固定的提醒对于固定提醒和过期提醒,以下提醒 API 的运作方式相同:
- 获取提醒 - 获取固定提醒或异常提醒定义。
- 获取提醒历史记录 - 获取提醒历史记录指标。
- 删除提醒 - 删除已修正或异常的提醒定义。
- 获取提醒实例 - 获取有关触发的提醒的信息。
- 获取提醒数量 - 获取提醒总数。
但是,一些 API 具有用于支持异常值提醒的其他属性,包括:
创建或更新过期提醒
使用相同的 API 创建 或更新 到期提醒和当前提醒的方式一样要创建或更新的 API 调用的正文 到期提醒与固定提醒相同,但有以下更改:
您必须添加以下新属性,以指定提醒为过期提醒:
"alertType": "cert" "alertSubType": "certfixed"
这些属性的默认值为:
"alertType": "runtime" "alertSubType": "fixed"
在
conditions
数组中:metrics
属性仅接受expiration
的值。- 使用
gracePeriodSeconds
属性可指定证书有效期的时间范围(以秒为单位),最长持续时间为 30 天。 - 不支持
threshold
、durationSeconds
和comparator
属性。
- 在
conditions
数组的dimensions
元素中: <ph type="x-smartling-placeholder">- </ph>
- 您必须将
certificate
属性的值设置为ANY
。 - 您必须将
proxy
属性的值设置为ALL
。 statusCode
、developerApp
、collection
、faultCodeCategory
不支持faultCodeSubCategory
和faultCodeName
属性。
- 您必须将
- 到期提醒不支持
reportEnabled
属性。
以下示例 API 调用将创建一个到期提醒, 生产环境将在 30 天后过期。系统会向指定的电子邮件地址发送通知 当提醒被触发时:
curl 'https://apimonitoring.enterprise.apigee.com/alerts' \ -X POST \ -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -d '{ "organization":"myorg", "name":"My Cert Expiry Alert", "description":"My Cert Expiry Alert", "environment":"prod", "enabled":true, "alertType": "cert", "alertSubType": "certfixed", "conditions":[ { "description":"My Cert Expiry Alert", "dimensions":{ "org":"myorg", "env":"prod", "proxy":"ALL", "certificate": "ANY" }, "metric":"expiration", "gracePeriodSeconds": 2592000 }], "notifications":[{ "channel":"email", "destination":"ops@acme.com" }], "playbook":"http://acme.com/pb.html", "throttleIntervalSeconds":3600, "reportEnabled":false }'
按照说明,将 $ACCESS_TOKEN
设置为您的 OAuth 2.0 访问令牌
获取 OAuth 2.0 访问令牌。
如需了解此示例中使用的 c网址 选项,请参阅使用 c网址。
接收到期提醒
默认情况下,Get Alerts API 用于返回有关所有已定义的提醒的信息,包括固定提醒和过期提醒。此 API 现在接受查询参数,可用于过滤结果:
enabled
- 如果true
指定仅返回已启用的提醒。默认值为false
。alertType
- 指定要返回的提醒类型。允许的值为runtime
(默认值)和cert
。alertSubType
- 指定要返回的提醒子类型。未设置默认值,表示返回所有提醒子类型。指定certfixed
可返回到期提醒。
例如,使用以下 API 调用即可仅为名为 myorg
的组织启用提醒:
curl -H "Authorization: Bearer $ACCESS_TOKEN" \ 'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'
以下调用仅返回过期提醒(包括已启用和已停用):
curl -H "Authorization: Bearer $ACCESS_TOKEN" \ 'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=cert&alertSubType=certfixed'
按照说明,将 $ACCESS_TOKEN
设置为您的 OAuth 2.0 访问令牌
获取 OAuth 2.0 访问令牌。
如需了解此示例中使用的 c网址 选项,请参阅使用 c网址。