Updated on 2022-08-15 GMT+08:00

Querying Maintenance Time Windows

Function

This API is used to query the start and end time of the maintenance window.

URI

GET /v1.0/instances/maintain-windows

Request

Request parameters

None.

Example Request

GET https://{dms_endpoint}/v1.0/instances/maintain-windows

Response

Response parameters

Table 1 and Table 2 describe the response parameters.

Table 1 Parameter description

Parameter

Type

Description

maintain_windows

Array

Indicates a list of supported maintenance time windows.

Table 2 maintain_windows parameter description

Parameter

Type

Description

seq

Integer

Indicates the sequential number of a maintenance time window.

begin

String

Indicates the time at which a maintenance time window starts.

end

String

Indicates the time at which a maintenance time window ends.

default

Boolean

Indicates whether a maintenance time window is set to the default time segment.

Example response

{ 
    "maintain_windows": [ 
        { 
            "seq": 1, 
            "begin": "22", 
            "end": "02", 
            "default": false 
        }, 
        { 
            "seq": 2, 
            "begin": "02", 
            "end": "06", 
            "default": true 
        }, 
        { 
            "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", 
            "default": false 
        } 
    ] 
}

Status Code

Table 3 describes the status code of successful operations. For details about other status codes, see Status Code.

Table 3 Status code

Status Code

Description

200

The maintenance time windows are queried successfully.