Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetDomainMaintenanceStatus

The status of the maintenance action.

Request Syntax


GET /2021-01-01/opensearch/domain/DomainName/domainMaintenance?maintenanceId=MaintenanceId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DomainName

The name of the domain.

Length Constraints: Minimum length of 3. Maximum length of 28.

Pattern: [a-z][a-z0-9\-]+

Required: Yes

MaintenanceId

The request ID of the maintenance action.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^([\s\S]*)$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Action": "string",
   "CreatedAt": number,
   "NodeId": "string",
   "Status": "string",
   "StatusMessage": "string",
   "UpdatedAt": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Action

The action name.

Type: String

Valid Values: REBOOT_NODE | RESTART_SEARCH_PROCESS | RESTART_DASHBOARD

CreatedAt

The time at which the action was created.

Type: Timestamp

NodeId

The node ID of the maintenance action.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 40.

Status

The status of the maintenance action.

Type: String

Valid Values: PENDING | IN_PROGRESS | COMPLETED | FAILED | TIMED_OUT

StatusMessage

The status message of the maintenance action.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: ^([\s\S]*)$

UpdatedAt

The time at which the action was updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

BaseException

An error occurred while processing the request.

HTTP Status Code: 400

DisabledOperationException

An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

ResourceNotFoundException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400