importLoginKey

Prev Next

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

사용자가 ssh-keygen으로 직접 생성한 공개키(Public key)를 사용하여 인증키(LoginKey)를 생성합니다. 인증키는 공개키(Public key)와 비공개키(Private key) 한 쌍으로 구성되며, 응답 결과에 인증키 이름과 비공개키 값이 반환됩니다. 비공개키 값을 사용하여 서버 접속에 사용하는 관리자 비밀번호를 확인할 수 있습니다. 비공개키 값은 응답 결과에 최초 발급된 후 다시 확인할 수 없으므로 별도로 안전하게 저장이 필요합니다.

요청

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

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

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

요청 헤더

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
regionCode String Optional 리전 코드
  • getRegionList 참조
    • 조회 결과의 첫 번째 리전 (기본값)
keyName String Optional 인증키 이름
  • 미입력 시 자동 생성 (기본값)
  • 영문 소문자, 숫자, 특수 문자 '-'를 조합하여 3~30자 이내로 입력
  • 문자열의 시작은 영문 소문자, 마지막은 영문 소문자 또는 숫자로 구성
publicKey String Required 공개키
  • ssh-keygen -t rsa -C "key-name" -f ~/.ssh/key-name으로 생성한 공개키
  • ssh-keygen 버전에 따라 -b 2048 -m PEM 옵션 필요
  • GET 방식 호출 시 URL 인코딩
responseFormatType String Optional 응답 데이터의 형식
  • xml (기본값) | json

요청 예시

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/importLoginKey
?regionCode=KR&keyName=test-***
&publicKey=ssh-rsa%20AAAAB3NzaC1...BrFL%20test-***
&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}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
importLoginKeyResponse Object - 응답 결과
importLoginKeyResponse.LoginKeyList Array - 인증키 목록: LoginKeyList 참조
importLoginKeyResponse.requestId String - 요청에 대한 아이디
  • UUID 형식
importLoginKeyResponse.returnCode String - 응답 코드
importLoginKeyResponse.returnMessage String - 응답 메시지

응답 상태 코드

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

응답 예시

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

{
    "importLoginKeyResponse": {
        "loginKeyList": [
            {
                "fingerprint": "",
                "keyName": "test-***",
                "createDate": "2025-06-25T17:20:42+0900"
            }
        ],
        "requestId": "e58e0e57-6a45-4939-92ab-62ad721f70d2",
        "returnCode": "0",
        "returnMessage": "success"
    }
}