Idempotent calls

Overview

To ensure the reliability of API calls, some OpenAPIs support idempotency by passing a unique identifier in the X-Idempotent-Request-ID request header. This feature prevents duplicate requests caused by network failures or repeated submissions.

Usage

When you make an OpenAPI request, add the following field to the request header:

• Field name: X-Idempotent-Request-ID.

• Field value: A custom unique string. The recommended format is a standard 32-character UUID.

Usage notes

1. Length limit:

   1. X-Idempotent-Request-ID must not exceed 50 characters.

   2. The recommended format is a standard UUID, for example: c0e77df6-2af3-4c60-8440-abf447845491.

2. Empty value handling:

   1. The idempotency feature is disabled if the X-Idempotent-Request-ID header is omitted, or if its value is null, an empty string (""), or consists only of whitespace characters (for example, " ").

3. Validity period limit:

   1. If you reuse the same ID within its validity period, the server returns the cached result from the original request. The response body is identical to the original, except for the requestId.

   2. If you reuse an ID after its validity period expires, the server processes it as a new request and returns a new result.

Idempotent APIs