tencent cloud

文档反馈

接口超频告警回调

最后更新时间:2024-05-08 16:35:10

    功能说明

    接口请求频率超过阈值80%时,通过回调的方式,将调用频率告警信息转发给 App 后台。

    注意事项

    要启用回调,必须配置回调 URL,配置方法详细参见 第三方回调配置 文档。
    配置了回调 URL,请求频率超过告警阈值后,默认就会触发告警回调。
    回调的方向是即时通信 IM 后台向 App 后台发起 HTTP POST 请求。
    App 后台在收到回调请求之后,务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
    其他安全相关事宜请参见 第三方回调简介 - 安全考虑 文档。

    接口说明

    请求 URL 示例

    以下示例中 App 配置的回调 URL 为https://www.example.com 示例:
    https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&OptPlatform=$OptPlatform&contenttype=json

    请求参数说明

    请求参数说明

    参数
    说明
    https
    请求协议为 HTTPS,请求方式为 POST
    www.example.com
    回调 URL
    SdkAppid
    创建应用时在即时通信 IM 控制台分配的 SDKAppID
    CallbackCommand
    固定为 Alert.RequestOverLimit
    contenttype
    固定值为 JSON
    OptPlatform
    客户端平台,取值参见 第三方回调简介 - 回调协议 中 OptPlatform 的参数含义

    请求包示例

    { "CallbackCommand": "Alert.RequestOverLimit", "ServiceName": "openim", "Command": "batchsendmsg", "Request": 510, "Limit": 200 }

    请求包字段说明

    字段
    类型
    说明
    CallbackCommand
    String
    固定为 Alert.RequestOverLimit
    ServiceName
    String
    接口内部服务名,不同的 ServiceName 对应不同的服务类型
    Command
    String
    接口命令字,与 ServiceName 组合用来标识具体的业务功能
    Request
    Integer
    接口请求 QPS 频率
    Limit
    Integer
    接口请求 QPS 阈值

    应答包示例

    {
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
    }

    应答包字段说明

    字段
    类型
    说明
    ActionStatus
    String
    请求处理的结果:
    OK 表示处理成功
    FAIL 表示失败
    ErrorCode
    Integer
    错误码
    ErrorInfo
    String
    错误说明

    参考

    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持