getServerInstanceList

Prev Next

VPC 환경에서 이용 가능합니다.

서버 인스턴스(VM) 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET | POST /vserver/v2/getServerInstanceList
참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

요청 헤더

Server API에서 공통으로 사용하는 헤더에 대한 정보는 Server 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
regionCode String Optional 리전 코드
  • getRegionList 참조
    • 조회 결과의 첫 번째 리전 (기본값)
vpcNo String Optional VPC 번호로 필터링
serverInstanceNoList.N Array Optional 서버 인스턴스 번호 목록
  • 서버 인스턴스 번호로 필터링
  • getServerInstanceList 참조
  • <예시> serverInstanceNoList.1=1234&serverInstanceNoList.2=2345
serverName String Optional 서버 이름으로 필터링
serverInstanceStatusCode String Optional 서버 인스턴스 상태 코드로 필터링
  • INIT | CREAT | RUN | NSTOP
baseBlockStorageDiskTypeCode String Optional 기본 블록 스토리지의 디스크 유형 코드로 필터링
  • NET: 네트워크 디스크 (유효 값)
baseBlockStorageDiskDetailTypeCode String Optional 기본 블록 스토리지의 디스크 상세 유형 코드로 필터링
  • HDD | SSD
ip String Optional 서버 IP 주소로 필터링
  • 비공인 IP와 공인 IP 모두 포함
placementGroupNoList.N Array Optional 물리 배치 그룹 번호 목록
  • 서버 인스턴스가 소속된 물리 배치 그룹 번호로 필터링
  • getPlacementGroupList 참조
  • <예시> placementGroupNoList.1=1234&placementGroupNoList.2=2345
hypervisorTypeCodeList.N Array Optional 하이퍼바이저 타입 코드 목록
  • XEN | KVM
  • 하이퍼바이저 타입 코드로 필터링
  • <예시> hypervisorTypeCodeList.1=KVM&hypervisorTypeCodeList.2=XEN
pageNo Integer Optional 페이지 번호
  • 0~N (기본값: 0)
  • 첫 번째 페이지: 0 또는 1 입력
pageSize Integer Conditional 페이지당 항목 수
  • 1~1000 (기본값: 1)
  • pageNo 입력 시 필수 입력
sortedBy String Optional 정렬 기준
  • serverName | serverInstanceNo
    • serverName: 서버 이름
    • serverInstanceNo: 서버 인스턴스 번호
sortingOrder String Optional 정렬 순서
  • ASC (기본값) | DESC
    • ASC: 오름차순
    • DESC: 내림차순
responseFormatType String Optional 응답 데이터의 형식
  • xml (기본값) | json

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getServerInstanceList
?regionCode=KR
&vpcNo=*****
&serverInstanceNoList.1=*****8773
&serverName=test-***
&serverInstanceStatusCode=RUN
&baseBlockStorageDiskTypeCode=NET
&baseBlockStorageDiskDetailTypeCode=SSD
&ip=221.188.***.***
&placementGroupNoList.1=***45
&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}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
getServerInstanceListResponse Object - 응답 결과
getServerInstanceListResponse.requestId String - 요청에 대한 아이디
  • UUID 형식
getServerInstanceListResponse.returnCode String - 응답 코드
getServerInstanceListResponse.returnMessage String - 응답 메시지

응답 상태 코드

Server API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Server 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "getServerInstanceListResponse": {
        "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": "NULL",
                    "codeName": "서버 NULL OP"
                },
                "serverInstanceStatusName": "running",
                "createDate": "2025-06-11T17:00:14+0900",
                "uptime": "2025-06-19T16:49:07+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": "****36",
                "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": "f116d46e-638e-43d8-9047-e48746b6e6cf",
        "returnCode": "0",
        "returnMessage": "success"
    }
}