GetPlannedMaintenanceList

Classic/VPC環境で利用できます。

メンテナンススケジュールの全リストを照会します。2つの照会方法があるので、その中から選択して呼び出します。

• 時間範囲で照会: リクエストクエリパラメータとしてfrom、to、timeTypeを使用
• リソース IDで照会: リクエストクエリパラメータとしてresourceId、productKeyを使用

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

リクエストヘッダ

Cloud Insight APIで共通して使用されるヘッダの詳細は、Cloud Insightのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

時間範囲で照会

時間範囲で照会するリクエストのサンプルコードは次の通りです。

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'

リソース IDで照会

リソース 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'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

メンテナンススケジュール情報関連フィールドの詳細は、PMCreateUpdateDtoをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Cloud Insight APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

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