Structured error replies
Stay organized with collections
Save and categorize content based on your preferences.
To allow better messages and logs, the Key Access Control List Service (KACLS)
operation failures returns a structured JSON reply in the body.
The standard HTTP status codes are used.
JSON representation |
{
"code": int,
"message": string,
"details": string
}
|
Fields |
code |
int
Standard HTTP status code
|
message |
string (UTF-8)
A human readable error message.
|
details |
string (UTF-8)
More details about the error, such as a stack trace.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-14 UTC.
[null,null,["Last updated 2024-11-14 UTC."],[[["\u003cp\u003eKACLS operation failures now return structured JSON responses for improved debugging.\u003c/p\u003e\n"],["\u003cp\u003eThese JSON responses include an HTTP status code, a human-readable message, and detailed error information.\u003c/p\u003e\n"],["\u003cp\u003eThis structure facilitates easier integration with automated systems and provides developers with more context for troubleshooting.\u003c/p\u003e\n"]]],["KACLS operation failures now return a structured JSON response in the body, using standard HTTP status codes. The JSON format includes three fields: `code` (an integer representing the HTTP status), `message` (a human-readable error string), and `details` (a string providing further information like a stack trace). This structured format improves the quality of error messages and logs.\n"],null,["# Structured error replies\n\nTo allow better messages and logs, the Key Access Control List Service (KACLS)\noperation failures returns a structured JSON reply in the body.\nThe standard HTTP status codes are used.\n\n| JSON representation ||\n|---------------------------------------------------------------|---|\n| ``` { \"code\": int, \"message\": string, \"details\": string } ``` |\n\n| Fields ||\n|-----------|-----------------------------------------------------------------------|\n| `code` | `int` Standard HTTP status code |\n| `message` | `string (UTF-8)` A human readable error message. |\n| `details` | `string (UTF-8)` More details about the error, such as a stack trace. |"]]