MENU
      GetPlannedMaintenanceList

        GetPlannedMaintenanceList


        Article summary

        Available in Classic and VPC

        Get the list of all maintenance schedules. There are two ways to get the list, and you must select one to call it.

        • Query by time range: Use the request query parameters from, to, and timeType
        • Query by resource ID: Use the request query parameters resourceId and productKey

        Request

        This section describes the request format. The method and URI are as follows:

        MethodURI
        GET/cw_fea/real/cw/api/planned-maintenances

        Request headers

        For information about the headers common to all Cloud Insight APIs, see Cloud Insight request headers.

        Request query parameters

        You can use the following query parameters with your request:

        FieldTypeRequiredDescription
        fromIntegerConditionalQuery start date and time
        • Unix timestamp format
        • Use when querying by time range
        toIntegerConditionalQuery end date and time
        • Unix timestamp format
        • Use when querying by time range
        timeTypeStringConditionalQuery criteria
        • startTime | endTime
          • startTime: start time
          • endTime: end time
        • Use when querying by time range
        resourceIdStringConditionalResource ID
        productKeyStringConditionalProduct key (cw_key)
        pageNumIntegerRequiredPage number
        • 1 - N
        pageSizeIntegerRequiredPage output count
        • 1 - N

        Request example

        The request example is as follows:

        Query by time range

        The following is a sample request to query by time range.

        curl --location --request GET 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/planned-maintenances?pageNum=1&pageSize=5&from=**********&to=**********&timeType=endTime' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
        --header 'Content-Type: application/json'
        Shell

        Query by resource ID

        The following is a sample request to query by resource ID.

        curl --location --request GET 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/planned-maintenances?pageNum=1&pageSize=5&productKey=**********&resourceId=**********' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
        --header 'Content-Type: application/json'
        Shell

        Response

        This section describes the response format.

        Response body

        For more information on the fields related to the maintenance schedule information, see PMCreateUpdateDto.

        Response status codes

        For response status codes common to NAVER Cloud Platform, see Cloud Insight API response status codes.

        Response example

        The response example is as follows:

        {
            "data": [
                {
                    "desc": "Planned maintenance example 01",
                    "dimensions": {
                        "**********": [
                            {
                                "instanceNo": "**********",
                                "mnt_nm": "/",
                                "type": "fs"
                            }
                        ]
                    },
                    "endTime": 1721133000000,
                    "id": "**********",
                    "startTime": 1721129400000,
                    "title": "test-pm-delete"
                },
                {
                    "desc": "Planned maintenance example 02",
                    "dimensions": {
                        "**********": [
                            {
                                "instanceNo": "**********",
                                "mnt_nm": "/",
                                "type": "fs"
                            }
                        ]
                    },
                    "endTime": 1721133356000,
                    "id": "**********",
                    "startTime": 1721129412000,
                    "title": "test-pm"
                }
            ],
            "pageNumCurrent": 1,
            "pageNumTotal": 1,
            "pageSize": 5,
            "total": 2
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.