Every Alibaba Cloud API request returns a unique RequestId. Use it in OpenAPI Troubleshoot to diagnose errors or in ActionTrail to audit requests.
Applies only to APIs available on OpenAPI Portal.
Methods
Use any of the following methods to find the RequestId. If a request fails, enter the RequestId on the OpenAPI Troubleshoot page to diagnose the error. For permission errors, the response also includes AccessDeniedDetail, which contains the unauthorized action (AuthAction) and an encrypted diagnostic message (EncodedDiagnosticMessage).
Use browser developer tools in the console
Open browser developer tools (F12) while using the console. Filter network activity by api.json? to locate the API call. The RequestId appears in the response headers or payload.
Use the OpenAPI Portal
Make a test call in OpenAPI Explorer. The RequestId appears in the response.
Use SDKs
The RequestId appears in the API response object. If an error occurs, catch the exception to access error details, including the RequestId.
Use the Alibaba Cloud CLI
The RequestId appears in the standard output of CLI API calls.
Use Terraform
Terraform orchestrates multiple API calls, so a successful apply does not display a single RequestId. If an API call fails, the error output includes the RequestId.
Other API clients
For other clients such as cURL or Postman, the RequestId is included in the response headers. If a Signature V3 API call fails, the RequestId appears in the error response.
Diagnose errors with a RequestId
OpenAPI Troubleshoot
Enter a RequestId on the page to view the call chain, basic information, authentication details, and request content. If the request failed, the page also provides a solution.
If a request is denied due to insufficient RAM permissions, get the EncodedDiagnosticMessage from the error response and call the DecodeDiagnosticMessage operation to decode it.
ActionTrail
Call the LookupEvents operation with the RequestId to query event details. Set the LookupAttribute array as follows:
|
Parameter |
Description |
|
Key |
Set to EventId. |
|
Value |
The RequestId value. |
