跳转到主要内容
告警与响应相关接口/告警路由与策略

获取告警Webhook安全文档

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

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

操作 ID

GetAlertWebhookSecurityDocs

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

此接口无需请求参数。

响应状态

200 OK
200 OK

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

  • algorithm
    String

    HMAC算法已使用签名。

    示例: HMAC-SHA256

  • signatureFormat
    String

    格式签名请求头。

    示例: v1=<hex-digest>

  • headerTimestamp
    String

    HTTP请求头名称时间戳。

    示例: X-Webhook-Timestamp

  • headerSignature
    String

    HTTP请求头名称签名。

    示例: X-Webhook-Signature

  • payloadFormat
    String

    格式已签名负载。

    示例: timestamp.body

  • replayWindowSec
    Integer

    重放窗口秒签名校验。

    示例: 300

  • examples
    LinkedHashMap

    示例条目引用。

    示例: (nested object)