Certificate Managerの概要

Prev Next

Classic/VPC環境で利用できます。

Certificate Managerは、NAVERクラウドプラットフォームの連携サービス(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 NAVERクラウドプラットフォームから発行された 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 不明なエラー
参考

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、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 Global Edge証明書の申し込み
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についてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。