跳转到主要内容
API Explorer|API Explorer
告警与响应相关接口/告警路由与策略
GETAlerting起始版本 1.0同步需要认证

获取告警Webhook安全文档

获取Webhook安全文档包含签名算法详情。

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

此接口无需请求参数。

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • algorithmString

    HMAC算法已使用签名。

    示例： HMAC-SHA256

  • signatureFormatString

    格式签名请求头。

    示例： v1=<hex-digest>

  • headerTimestampString

    HTTP请求头名称时间戳。

    示例： X-Webhook-Timestamp

  • headerSignatureString

    HTTP请求头名称签名。

    示例： X-Webhook-Signature

  • payloadFormatString

    格式已签名负载。

    示例： timestamp.body

  • replayWindowSecInteger

    重放窗口秒签名校验。

    示例： 300

  • examplesLinkedHashMap

    示例条目引用。

    示例： (nested object)

请求地址

GET/api/v1/alerting/docs/webhook-security

/api/v1/alerting/docs/webhook-security

操作 ID

GetAlertWebhookSecurityDocs

永久链接

请求示例

curl -X GET '{host}/api/v1/alerting/docs/webhook-security' -H 'Authorization: Bearer {token}'

响应示例

200
{
  "algorithm": "HMAC-SHA256",
  "signatureFormat": "v1=<hex-digest>",
  "headerTimestamp": "X-Webhook-Timestamp",
  "headerSignature": "X-Webhook-Signature",
  "payloadFormat": "timestamp.body",
  "replayWindowSec": 300,
  "examples": null
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史