Maintenance Window

A MaintenanceWindow is a resource snoozing Alerts during maintenance time.

Package : spaceone.api.monitoring.v1

MaintenanceWindow

MaintenanceWindow Methods:

Method	Request	Response
create	CreateMaintenanceWindowRequest	MaintenanceWindowInfo
update	UpdateMaintenanceWindowRequest	MaintenanceWindowInfo
close	MaintenanceWindowRequest	MaintenanceWindowInfo
get	GetMaintenanceWindowRequest	MaintenanceWindowInfo
list	MaintenanceWindowQuery	MaintenanceWindowsInfo
stat	MaintenanceWindowStatQuery	google.protobuf.Struct

create

POST /monitoring/v1/maintenance-windows

Creates a new MaintenanceWindow. When creating a MaintenanceWindow, you can set the title and maintenance schedule of the MaintenanceWindow. From the start_time to the end_time specified by the schedule set in this method, alerts in the Projects linked with the MaintenanceWindow are ceased.

Type	Message
Request	CreateMaintenanceWindowRequest
Response	MaintenanceWindowInfo

Request Example

{
    "title": "The dev server is under regular maintenance.",
    "projects": [
        "project-123456789012"
    ],
    "start_time": "2022-01-01T09:45:00.000Z",
    "end_time": "2022-01-01T10:45:00.000Z",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "maintenance_window_id": "mw-123456789012",
    "title": "The dev server is under regular maintenance.",
    "state": "OPEN",
    "start_time": "2022-01-01T09:45:00.000Z",
    "end_time": "2022-01-01T10:45:00.000Z",
    "tags": {},
    "projects": [
        "project-123456789012"
    ],
    "domain_id": "domain-123456789012",
    "created_by": "[e-mail]",
    "created_at": "2022-06-02T09:46:49.196Z",
    "updated_at": "2022-06-02T09:46:49.196Z"
}

update

PUT /monitoring/v1/maintenance-window/{maintenance_window_id}

Updates a specific MaintenanceWindow. You can make changes in MaintenanceWindow settings including, the title and the schedule.

Type	Message
Request	UpdateMaintenanceWindowRequest
Response	MaintenanceWindowInfo

Request Example

{
    "maintenance_window_id": "mw-123456789012",
    "title": "The dev server is under regular maintenance.",
    "projects": [
        "project-123456789012"
    ],
    "start_time": "2022-01-03T00:00:00.000Z",
    "end_time": "2022-01-03T01:00:00.000Z",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "maintenance_window_id": "mw-123456789012",
    "title": "The dev server is under regular maintenance.",
    "state": "OPEN",
    "start_time": "2022-06-03T00:00:00.000Z",
    "end_time": "2022-06-03T01:00:00.000Z",
    "tags": {},
    "projects": [
        "project-123456789012"
    ],
    "domain_id": "domain-123456789012",
    "created_by": "[e-mail]",
    "created_at": "2022-01-02T09:46:49.196Z",
    "updated_at": "2022-01-02T09:46:49.196Z"
}

close

PUT /monitoring/v1/maintenance-window/{maintenance_window_id}/close

Closes a MaintenanceWindow by changing the state of the MaintenanceWindow to CLOSED when the maintenance is completed. As the MaintenanceWindow is not deleted but closed, the maintenance history remains undeleted.

Type	Message
Request	MaintenanceWindowRequest
Response	MaintenanceWindowInfo

Request Example

{
    "maintenance_window_id": "mw-123456789012",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "maintenance_window_id": "mw-123456789012",
    "title": "The dev server is under regular maintenance.",
    "state": "CLOSED",
    "start_time": "2022-06-03T00:00:00.000Z",
    "end_time": "2022-06-03T01:00:00.000Z",
    "tags": {},
    "projects": [
        "project-123456789012"
    ],
    "domain_id": "domain-123456789012",
    "created_by": "[e-mail]",
    "created_at": "2022-01-02T09:46:49.196Z",
    "updated_at": "2022-01-02T09:46:49.196Z"
}

get

GET /monitoring/v1/maintenance-window/{maintenance_window_id}

Gets a specific MaintenanceWindow. Prints detailed information about the MaintenanceWindow, including the title and the schedule.

Type	Message
Request	GetMaintenanceWindowRequest
Response	MaintenanceWindowInfo

Request Example

{
    "maintenance_window_id": "mw-123456789012",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "maintenance_window_id": "mw-123456789012",
    "title": "The dev server is under regular maintenance.",
    "state": "OPEN",
    "start_time": "2022-06-03T00:00:00.000Z",
    "end_time": "2022-06-03T01:00:00.000Z",
    "tags": {},
    "projects": [
        "project-123456789012"
    ],
    "domain_id": "domain-123456789012",
    "created_by": "[e-mail]",
    "created_at": "2022-01-02T09:46:49.196Z",
    "updated_at": "2022-01-02T09:46:49.196Z"
}

list

GET /monitoring/v1/maintenance-windows

POST /monitoring/v1/maintenance-windows/search

Gets a list of all MaintenanceWindows. You can use a query to get a filtered list of MaintenanceWindows.

Type	Message
Request	MaintenanceWindowQuery
Response	MaintenanceWindowsInfo

Request Example

{
    "query": {},
    "domain_id": "domain-123456789012"
}

Response Example

{
    "results": [
        {
            "maintenance_window_id": "mw-123456789012",
            "title": "The dev server is under regular maintenance.",
            "state": "OPEN",
            "start_time": "2022-06-03T00:00:00.000Z",
            "end_time": "2022-06-03T01:00:00.000Z",
            "tags": {},
            "projects": [
                "project-123456789012"
            ],
            "domain_id": "domain-123456789012",
            "created_by": "[e-mail]",
            "created_at": "2022-01-01T09:59:01.966Z",
            "updated_at": "2022-01-01T09:59:01.966Z"
        },
        {
            "maintenance_window_id": "mw-987654321098",
            "title": "The prd server is under regular maintenance.",
            "state": "OPEN",
            "start_time": "2022-06-03T00:00:00.000Z",
            "end_time": "2022-06-03T01:00:00.000Z",
            "tags": {},
            "projects": [
                "project-123456789012"
            ],
            "domain_id": "domain-123456789012",
            "created_by": "[e-mail]",
            "created_at": "2022-01-02T09:57:28.999Z",
            "updated_at": "2022-01-02T09:57:28.999Z"
        }
    ],
    "total_count": 50
}

stat

POST /monitoring/v1/maintenance-windows/stat

Type	Message
Request	MaintenanceWindowStatQuery
Response	google.protobuf.Struct

Message

CreateMaintenanceWindowRequest

Field	Type	Required	Description
title	string	✔
projects	list of string	✔
start_time	string	✔
end_time	string	✔
tags	google.protobuf.Struct	✘
domain_id	string	✔

GetMaintenanceWindowRequest

Field	Type	Required	Description
maintenance_window_id	string	✔
domain_id	string	✔
only	list of string	✘

MaintenanceWindowInfo

Field	Type	Description
maintenance_window_id	string
title	string
state	NONE OPEN CLOSED
start_time	string
end_time	string
tags	google.protobuf.Struct
projects	list of string
domain_id	string
created_by	string
created_at	string
updated_at	string
closed_at	string

MaintenanceWindowQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘
maintenance_window_id	string	✘
title	string	✘
state	NONE OPEN CLOSED	✘
project_id	string	✘
created_by	string	✘
domain_id	string	✔

MaintenanceWindowRequest

Field	Type	Required	Description
maintenance_window_id	string	✔
domain_id	string	✔

MaintenanceWindowStatQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.StatisticsQuery	✔
domain_id	string	✔

MaintenanceWindowsInfo

Field	Type	Description
results	list of MaintenanceWindowInfo
total_count	int32

UpdateMaintenanceWindowRequest

Field	Type	Required	Description
maintenance_window_id	string	✔
title	string	✘
projects	list of string	✘
start_time	string	✘
end_time	string	✘
tags	google.protobuf.Struct	✘
domain_id	string	✔