Listing Maintenance Time Windows

Updated on 2023-07-20 GMT+08:00

View PDF

Function

The API is used to query the start time and end time of maintenance time windows.

URI

GET /v2/instances/maintain-windows

Request Parameters

None

Response Parameters

Status code: 200

**Table 1** Response body parameters
Parameter	Type	Description
maintain_windows	Array of MaintainWindowsEntity objects	List of supported maintenance time windows.

**Table 2** MaintainWindowsEntity
Parameter	Type	Description
default	Boolean	Whether a maintenance time window is set to the default time segment.
end	String	End time of the maintenance time window.
begin	String	Start time of the maintenance time window.
seq	Integer	Sequence number.

Example Requests

GET https://{endpoint}/v2/instances/maintain-windows

Example Responses

Status code: 200

Maintenance time window queried successfully.

{
  "maintain_windows" : [ {
    "default" : false,
    "seq" : 1,
    "begin" : "22",
    "end" : "02"
  }, {
    "default" : true,
    "seq" : 2,
    "begin" : "02",
    "end" : "06"
  }, {
    "default" : false,
    "seq" : 3,
    "begin" : "06",
    "end" : "10"
  }, {
    "default" : false,
    "seq" : 4,
    "begin" : "10",
    "end" : "14"
  }, {
    "default" : false,
    "seq" : 5,
    "begin" : "14",
    "end" : "18"
  }, {
    "default" : false,
    "seq" : 6,
    "begin" : "18",
    "end" : "22"
  } ]
}