幂等调用

更新时间:
复制为 MD 格式

功能介绍

为保障接口调用的可靠性,部分OpenAPI支持通过请求头(Header)传递唯一标识(X-Idempotent-Request-ID)的方式实现幂等性控制。该功能可避免因网络异常、重复提交等原因导致的重复请求。

使用方法

在发起 OpenAPI 请求时,需在请求头Header中添加以下字段:

  • 字段名(Field Name):X-Idempotent-Request-ID。

  • 字段值(Field Value):自定义的唯一字符串(推荐使用32位标准UUID)。

注意事项

  1. 字段长度限制:

    1. X-Idempotent-Request-ID 最大长度为50字符。

    2. 建议使用标准UUID,例如:c0e77df6-2af3-4c60-8440-abf447845491。

  2. 空值处理:

    1. 若不包含该Header,或者字段值为 null、空字符串("")或仅含空白字符(如 " "),则幂等性功能失效。

  3. 有效期限制:

    1. 有效期内重复使用相同 ID:服务器将 返回缓存的首次处理后的结果(除了requestId之外,响应体与首次一致)。

    2. 超过有效期后重复使用相同 ID:服务器将 视为新请求,正常处理并返回新结果。

支持幂等调用的接口清单

接口名称

接口完整路径

是否强制幂等

X-Idempotent-Request-ID有效期

CreateTask

/rpa/openapi/raas/task/CreateTask

180