interruptServerInstance

Prev Next

VPC環境で利用できます。

異常動作するサーバインスタンス(VM)の状態を分析するために、診断の割り込みを実行します。

参考

診断の割り込みは、Windows系 OSを使用するハイパーバイザ XENタイプのサーバインスタンス(VM)に限ってサポートします。診断の割り込みの使用方法の詳細は、Serverご利用ガイドの診断の割り込みをご参照ください。

リクエスト

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

メソッド URI
GET | POST /vserver/v2/interruptServerInstance
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
serverInstanceNo String Required サーバインスタンス番号
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/interruptServerInstance
?regionCode=KR
&serverInstanceNo=*****3161
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
interruptServerInstanceResponse Object - レスポンス結果
interruptServerInstanceResponse.returnCode String - レスポンスコード
interruptServerInstanceResponse.returnMessage String - レスポンスメッセージ

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

Server APIで共通して使用されるレスポンスステータスコードの詳細は、Serverのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
    "interruptServerInstanceResponse": {
        "totalRows": 1,
        "serverInstanceList": [
            {
                "serverInstanceNo": "*****3161",
                "serverName": "test-***",
                "serverDescription": "",
                "cpuCount": 2,
                "memorySize": 8589934592,
                "platformType": {
                    "code": "WND64",
                    "codeName": "Windows 64 Bit"
                },
                "loginKeyName": "test-***",
                "publicIpInstanceNo": "*****3452",
                "publicIp": "211.188.***.***",
                "serverInstanceStatus": {
                    "code": "RUN",
                    "codeName": "サーバ RUN状態"
                },
                "serverInstanceOperation": {
                    "code": "SETUP",
                    "codeName": "現在、SETUP状態である"
                },
                "serverInstanceStatusName": "setting up",
                "createDate": "2025-06-19T15:45:23+0900",
                "uptime": "2025-06-19T16:13:43+0900",
                "serverImageProductCode": "SW.VSVR.OS.WND64.WND.SVR2016EN.B100",
                "serverProductCode": "SVR.VSVR.STAND.C002.M008.NET.SSD.B100.G002",
                "isProtectServerTermination": false,
                "zoneCode": "KR-1",
                "regionCode": "KR",
                "vpcNo": "***75",
                "subnetNo": "****36",
                "networkInterfaceNoList": [
                    "*****25"
                ],
                "initScriptNo": "",
                "serverInstanceType": {
                    "code": "STAND",
                    "codeName": "Standard"
                },
                "baseBlockStorageDiskType": {
                    "code": "NET",
                    "codeName": "ネットワークストレージ"
                },
                "baseBlockStorageDiskDetailType": {
                    "code": "SSD",
                    "codeName": "SSD"
                },
                "placementGroupNo": "",
                "placementGroupName": "",
                "memberServerImageInstanceNo": "",
                "hypervisorType": {
                    "code": "XEN",
                    "codeName": "XEN"
                },
                "serverImageNo": "16187006",
                "serverSpecCode": "s2-g2-s100",
                "eventList": [],
                "fabricClusterPoolNo": "",
                "fabricClusterPoolName": "",
                "fabricClusterMode": "",
                "fabricClusterNo": "",
                "fabricClusterName": ""
            }
        ],
        "requestId": "3698198d-df7b-4cd3-a219-bd437cad8ddf",
        "returnCode": "0",
        "returnMessage": "success"
    }
}