Webex · Schema
BadGatewayError
CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Properties
| Name | Type | Description |
|---|---|---|
| code | integer | HTTP status code for Bad Gateway. |
| message | string | A detailed error message explaining the gateway error. |
| trackingId | string | A unique identifier for this error that can be used for debugging purposes. |
| details | object | Additional details about the gateway error. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/BadGatewayError",
"title": "BadGatewayError",
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "integer",
"enum": [
502
],
"description": "HTTP status code for Bad Gateway.",
"example": 502
},
"message": {
"type": "string",
"description": "A detailed error message explaining the gateway error.",
"example": "The server received an invalid response from an upstream server."
},
"trackingId": {
"type": "string",
"description": "A unique identifier for this error that can be used for debugging purposes.",
"example": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f597"
},
"details": {
"type": "object",
"description": "Additional details about the gateway error.",
"properties": {
"upstreamService": {
"type": "string",
"description": "The upstream service that failed",
"example": "dnc-service"
},
"retryRecommended": {
"type": "boolean",
"description": "Whether retrying the request is recommended",
"example": true
}
}
}
},
"example": {
"code": 502,
"message": "The server received an invalid response from an upstream server.",
"trackingId": "WXC-12345-67897",
"details": {
"upstreamService": "dnc-service",
"retryRecommended": true
}
}
}