Skip to main content

​
Request Limits

​
Rate Limits

To ensure service stability, APIs have rate limits on request frequency. When requests are too frequent, a 429 status code with RequestTooFrequently error will be returned.
Please control your request frequency reasonably and avoid sending a large number of requests in a short period. It is recommended to implement a retry mechanism with exponential backoff when receiving a 429 error.

​
Permission Limits

  • An APP Key with All permissions has no additional API-scope restriction, but remains limited by the creator’s current role permissions
  • Custom permissions requires at least one selected API permission; the APP Key can call only APIs in that selected scope
  • When an operation exceeds either the APP Key scope or the creator’s role permissions, a 403 status code with AccessDenied error is returned
  • It is recommended to create separate APP Keys for different purposes, following the principle of least privilege

​
Error Code List

​
Error Handling Recommendations

Possible causes:
  • Missing required parameters
  • Incorrect parameter format
  • Content-Type not set to application/json
Solution: Check request parameters and Headers settings, refer to API documentation for parameter requirements.
Possible causes:
  • APP Key not provided
  • APP Key is incorrect or has expired
Solution:
  1. Confirm that the request URL contains the app_key parameter
  2. Go to the console to check if the APP Key is valid
Possible causes:
  • Current user does not have permission to perform this operation
  • The user corresponding to the APP Key has insufficient permissions
Solution: Contact the account administrator to elevate permissions, or use an APP Key with the appropriate permissions.
Possible causes:
  • Too many requests sent in a short period
Solution:
  1. Reduce request frequency
  2. Implement exponential backoff retry mechanism
  3. Combine multiple requests (e.g., use batch APIs)
Possible causes:
  • Server-side internal exception
Solution:
  1. Retry later
  2. If the issue persists, contact technical support and provide the request_id

​
Best Practices

Implement Retry Mechanism

For network errors and 5xx errors, it is recommended to implement exponential backoff retry with an initial interval of 1 second and a maximum of 3 retries.

Record request_id

Save the request_id returned from each request to facilitate troubleshooting and technical support.

Protect APP Key

Do not hardcode APP Key in client code. It is recommended to manage it through environment variables or configuration centers.

Rotate Keys Regularly

Regularly replace APP Keys and promptly delete keys that are no longer in use to reduce the risk of leakage.