stopServerInstances

VPC環境で利用できます。

運用中状態のサーバインスタンス(VM)を停止します。

リクエスト

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

メソッド	URI
GET \| POST	/vserver/v2/stopServerInstances

参考

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照照会結果の最初のリージョン(デフォルト)
`serverInstanceNoList.N`	Array	Required	サーバインスタンス番号リスト getServerInstanceListを参照 <例> `serverInstanceNoList.1=1234&serverInstanceNoList.2=2345`
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/stopServerInstances
?regionCode=KR
&serverInstanceNoList.1=*****8773
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "stopServerInstancesResponse": {
        "totalRows": 1,
        "serverInstanceList": [
            {
                "serverInstanceNo": "*****8773",
                "serverName": "test-***",
                "serverDescription": "",
                "cpuCount": 4,
                "memorySize": 8589934592,
                "platformType": {
                    "code": "UBD64",
                    "codeName": "Ubuntu Desktop 64 Bit"
                },
                "loginKeyName": "test-***",
                "publicIpInstanceNo": "*****8824",
                "publicIp": "211.188.***.***",
                "serverInstanceStatus": {
                    "code": "RUN",
                    "codeName": "サーバ RUN状態"
                },
                "serverInstanceOperation": {
                    "code": "SHTDN",
                    "codeName": "サーバ SHUTDOWN OP"
                },
                "serverInstanceStatusName": "shutting down",
                "createDate": "2025-06-11T17:00:14+0900",
                "uptime": "2025-06-26T09:56:22+0900",
                "serverImageProductCode": "SW.VSVR.OS.LNX64.UBNTU.SVR24.G003",
                "serverProductCode": "SVR.VSVR.CPU.C004.M008.G003",
                "isProtectServerTermination": true,
                "zoneCode": "KR-1",
                "regionCode": "KR",
                "vpcNo": "***75",
                "subnetNo": "****6",
                "networkInterfaceNoList": [
                    "*****30"
                ],
                "initScriptNo": "",
                "serverInstanceType": {
                    "code": "CPU",
                    "codeName": "CPU Intensive"
                },
                "baseBlockStorageDiskType": {
                    "code": "NET",
                    "codeName": "ネットワークストレージ"
                },
                "baseBlockStorageDiskDetailType": {
                    "code": "SSD",
                    "codeName": "SSD"
                },
                "placementGroupNo": "",
                "placementGroupName": "",
                "memberServerImageInstanceNo": "",
                "hypervisorType": {
                    "code": "KVM",
                    "codeName": "KVM"
                },
                "serverImageNo": "104630229",
                "serverSpecCode": "ci4-g3",
                "eventList": [],
                "fabricClusterPoolNo": "",
                "fabricClusterPoolName": "",
                "fabricClusterMode": "",
                "fabricClusterNo": "",
                "fabricClusterName": ""
            }
        ],
        "requestId": "97521430-f667-4b6f-9d03-bf743aa2651a",
        "returnCode": "0",
        "returnMessage": "success"
    }
}