Certificate Manager 개요

Prev Next

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

Certificate Manager는 네이버 클라우드 플랫폼의 연계 서비스(Load Balancer, Global edge)와 외부 환경에서 사용되는 SSL/TLS 인증서를 발급, 등록, 관리할 수 있는 서비스입니다. 인증서 발급 및 관리 기능은 RESTful API 형태로 제공되며, API 호출을 위해 API Gateway의 IAM 인증이 필요합니다.

Certificate Manager API 1.0 Certificate Manager API 2.0
Base URL(도메인) https://certificatemanager.apigw.ntruss.com/api/v1 https://certificatemanager.apigw.ntruss.com/api/v2
API 종류 외부 인증서 등록, 삭제, 조회 기능 3종만 제공
  • createExternalCertificate, deleteCertificate, getCertificateList
 콘솔에서 제공되는 모든 인증서 관리 기능을 API로 동일하게 제공
  • 인증서 신청, 재발급, 상태 조회, 다운로드, 갱신 설정, 및 삭제 등

Certificate Manager API 공통 설정

Certificate Manager API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.

요청

공통 요청 형식을 설명합니다.

API URL

Certificate Manager API는 버전별로 아래와 같은 Base URL을 제공합니다. 연동하려는 기능의 버전에 맞춰 URL을 선택하여 사용하시기 바랍니다.

Certificate Manager API 1.0: https://certificatemanager.apigw.ntruss.com/api/v1
Certificate Manager API 2.0: https://certificatemanager.apigw.ntruss.com/api/v2

요청 헤더

헤더에 대한 설명은 다음과 같습니다.

필드 필수 여부 설명
x-ncp-apigw-timestamp Required 1970년 1월 1일 00:00:00 UTC부터의 경과 시간 (밀리초 단위)
• API Gateway 서버와 5분 이상 시간 차 발생 시 유효하지 않은 요청으로 간주
x-ncp-iam-access-key Required 네이버 클라우드 플랫폼에서 발급받은 Access Key
• 인증키 생성 가이드 참조
• 서브 계정 이용 시 서브 계정 생성 가이드 참조
x-ncp-apigw-signature-v2 Required Access Key와 매핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)을 사용하여 생성한 서명값 (Base64 인코딩)
• 시그니처 생성 가이드 참조
Content-Type Required 요청 데이터의 형식
  • application/json
Accept Required 응답 데이터의 형식
• application/json

응답

공통 응답 형식을 설명합니다.

응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

HTTP 상태 코드 코드 메시지 설명
200 1002 Unable to load certificate. Expecting PEM format file. PEM 형식이 유효하지 않음
200 1004 Failed to delete the certificate. Delete the instance being used first or replace the certificate being used for the instance. 인증서 삭제 실패(인스턴스 사용 중)
200 1004 Failed to delete the certificate. No certificate was found with a matching with requested certificate name and certificate number. 인증서 삭제 실패(이름, 번호 불일치)
200 2200 No certificate was found. 인증서 검색 결과 없음
200 26034 The certificate is invalid. 인증서가 유효하지 않음
200 26040 Public key in certificate does not match with private key. 개인 키 정합성이 유효하지 않음
400 100 Bad Request Exception 요청 구문 오류
400 2000 CertificateName is invalid. certificateName can only contain 3-20 English alphabet, numbers, and "-" and must start with an alphabetic character. 인증서 이름이 유효하지 않음
400 2100 CertificateName is missing; PrivateKey is missing; PublicKeyCertificate is missing; CertificateChain is missing. 인증서의 이름이나 개인 키, 공개 키, 체인을 찾을 수 없음
401 200 Authentication Failed 인증 실패
401 210 Permission Denied 접근 권한 없음
404 300 Not Found Exception 서버에서 찾을 수 없음
413 430 Request Entity Too Large 요청 크기 초과
429 400 Quota Exceeded 요청 할당량 초과
429 410 Throttle Limited 너무 빠르거나 잦은 요청
429 420 Rate Limited 특정 시간 동안 너무 많은 요청
503 500 Endpoint Error 엔드포인트 오류
504 510 Endpoint Timeout 엔드포인트 타임아웃
500 900 Unexpected Error 알 수 없는 오류
참고

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

Certificate Manager API 1.0

Certificate Manager 서비스에서 제공하는 API 1.0에 대한 설명은 다음과 같습니다.

API 설명
createExternalCertificate 외부 인증서 추가
deleteCertificate 인증서 삭제
getCertificateList 인증서 조회

Certificate Manager API 2.0

Certificate Manager 서비스에서 제공하는 API 2.0에 대한 설명은 다음과 같습니다.

Certificate Request

Certificate Request 관련 API를 사용하여 용도에 맞는 인증서를 신규로 신청하거나 재발급할 수 있으며, 타사에서 발급받은 외부 인증서의 등록이 가능합니다.

API 설명
CloudBasicCertificateRequest CloudBasic 인증서 신청
AdvancedCertificateRequest Advanced 인증서 신청
GlobalEdgeCertificateRequest GlobalEdge 인증서 신청
ReissueCertificate 인증서 재발급
RegisterExternalCertificate 외부 인증서 등록

Certificate Lookup

Certificate Inquiry & Status 관련 API는 각 인증서 종류 별 인증서 조회 및 상태 조회 시 사용되는 API입니다.

API 설명
ListCertificateTypes 인증서 유형 목록을 조회합니다.
ListCertificates 전체 인증서 조회
ListCloudCertificates Cloud Basic SSL과 GlobalEdge 인증서를 조회합니다.
ListAdvancedCertificates Advanced 인증서를 조회합니다.
ListDcvStatuses 신청한 SSL 인증서의 DCV 검증 상태를 조회합니다.
ListRecentCertChanges 지정한 기간(분 또는 초) 동안 상태가 변경된 인증서 목록을 조회합니다.

Certificate Management

Certificate Management & Lifecycle API는 인증서 조회, 다운로드, 갱신 및 삭제 등 인증서 수명 주기 관리에 사용되는 API입니다.

API 설명
GetCertificateChain 요청한 인증서를 PEM 형식으로 반환하며, 인증서 체인을 함께 제공
DownloadCertificate 인증서 파일 다운로드
DeleteCertificate 인증서 삭제
SetRenewalStatus 인증서 자동 갱신 대상 여부 설정
RegisterPrivateKey 인증서에 대한 개인 키 등록

Certificate Manager 연관 리소스

Certificate Manager API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.