Autional Autional
API Reference GitHub autional.com →

GET /status/maintenances/{id}

Get full details of a single planned maintenance by maintenance ID

Status page None application/json

Request Parameters

NameInTypeRequiredDefaultExampleConstraintsDescription
id path string Yes Maintenance ID

Responses

StatusDescriptionSchema
200Maintenance detailsgitee_com_linmes_authms_micro-services_status-service_internal_handler_dto.MaintenanceDataResponse
400Invalid request parametersdto.Problem
500Internal server errordto.Problem

Referenced Schemas

dto.FieldViolation

FieldTypeRequiredExampleConstraintsDescription
code string No Code is the error code (optional). Used for programmatic identification of error types, e.g., "required", "format", "range"
description string No Description is a human-readable error description. Should explain which rule was violated, e.g., "Must be a valid email address"
field string No Field is the path to the error field. Use dot notation for nested fields, e.g., "user.email" or "addresses[0].city"
value object No Value is the value that caused the error (optional, used in development mode). May not be returned in production to avoid leaking sensitive information

dto.Problem

FieldTypeRequiredExampleConstraintsDescription
code integer No Code is the business error code. Used for programmatic handling of specific error scenarios. Example: 30101001
detail string No Detail is a human-readable explanation for this specific error instance. May include specific error details, e.g., "Field 'email' is required"
errors array of

See dto.FieldViolation

No Errors is a list of field-level validation errors (extended field). Follows Web API standard practices, each error contains field name and error message
i18n_args object No I18nArgs are internationalization arguments. Used to dynamically populate translation templates
i18n_key string No I18nKey is the internationalization key. Used for client-side localization of error messages. Example: "error.user_not_found"
instance string No Instance is the specific URI reference where the problem occurred. Usually the request URL, may include query parameters. Example: "/api/v1/users?limit=invalid"
request_id string No RequestID is the unique request identifier. Used for log correlation and issue tracking. Example: "req_550e8400-e29b-41d4-a716-446655440000"
retry_after integer No RetryAfter is used for 429 Too Many Requests responses. Indicates how many seconds the client should wait before retrying (RFC 6585)
service string No Service is the service name. Used in microservice architecture to locate the error source. Example: "auth-service"
span_id string No SpanID is the current span identifier. Used to precisely locate the current node in a distributed trace
status integer No Status is the HTTP status code generated. Used by clients to distinguish problem types, does not change with Accept-Language. Example: 400, 401, 403, 404, 500
timestamp string No Timestamp is the time the error occurred. ISO 8601 format. Example: "2026-04-03T12:00:00Z"
title string No Title is a short, human-readable summary of the problem type. The same Type should always have the same Title (does not vary per instance). Example: "Invalid Request Parameters"
trace_id string No TraceID is the distributed trace identifier. Follows W3C Trace Context standard. Example: "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01"
type string No Type is a URI reference that identifies the problem type. When dereferenced, should provide human-readable documentation. Example: "https://api.example.com/errors/invalid-request"

gitee_com_linmes_authms_micro-services_status-service_internal_domain.MaintenanceStatus

string

gitee_com_linmes_authms_micro-services_status-service_internal_handler_dto.MaintenanceDataResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
data gitee_com_linmes_authms_micro-services_status-service_internal_handler_dto.MaintenanceResponse No
message string No

gitee_com_linmes_authms_micro-services_status-service_internal_handler_dto.MaintenanceResponse

FieldTypeRequiredExampleConstraintsDescription
affected_services array of

string

No ['["audit-service"]']
created_at string No 2026-05-20T10:00:00Z
description string No Scheduled database index optimization for audit-service
id string No 01HX5KA1B2C3
scheduled_end_at string No 2026-05-22T04:00:00Z
scheduled_start_at string No 2026-05-22T02:00:00Z
status object No scheduled
title string No Database Index Optimization
updated_at string No 2026-05-20T10:00:00Z