跳转到主要内容

​
为什么使用

当调用失败或需要 VMEG 协助排查时，request ID 能把该次 HTTP 请求对应的服务端日志、幂等记录与任务创建链路串起来。 可在 任意 Open API 请求（/openapi/v1/**）上传入你自己的 ID；不传时由服务端生成（32 位十六进制，无连字符）。
req_id 标识 本次 HTTP 请求，便于日志与工单排查。X-Idempotency-Key 用于防重复写，taskId 用于跟踪异步任务，pipelineKey 用于 Webhook 去重 — 按场景选用对应字段，通常可同时传递。

​
如何传递

使用 query 参数：
说明：
  • 建议使用便于在你方日志中检索的值（例如 UUID 或 order-12345-attempt-1）
  • 适用于 /openapi/v1/** 下的 GET 与 POST
  • 成功响应的 JSON 通常不包含 request ID；请在你方日志中保存传入的值

​
示例

若 URL 已有其它 query 参数，用 &req_id=... 追加即可。

​
联系支持时

请提供：
  • 你使用的 req_id（若未设置，可提供大致时间与使用的 API Key）
  • 异步任务相关的 taskId（如有）
  • 产品与接口路径
建议在流程的 第一次 请求就设置 req_id，便于排查。逻辑上是 新的一次提交 时请使用新的 req_id（新写入还需新的幂等键）。