Certificate Managerの概要

Prev Next

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

Certificate Managerは、連携サービス(Load Balancer、CDN+など)で使用する証明書を発行、登録、管理できる NAVERクラウドプラットフォームのサービスです。証明書の登録、削除、照会機能に関する APIを RESTful形式で提供します。APIを呼び出すには、API Gatewayの IAM認証を完了する必要があります。

Certificate Managerの共通設定

Certificate Manager APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

https://certificatemanager.apigw.ntruss.com/api/v1

リクエストヘッダ

ヘッダの説明は次の通りです。

フィールド 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
    		•
    x-ncp-iam-access-key Required NAVERクラウドプラットフォームから発行された Access Key
  • Access Keyの発行と確認: 認証キーの作成を参照
  • サブアカウントの Access Key発行と確認: サブアカウントの作成を参照
    		•
    x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64でエンコードした署名
  • Secret Keyの発行と確認: 認証キーの作成を参照
  • 署名の作成: シグネチャーの作成を参照
    		•
    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

    Certificate Managerサービスで提供する APIの説明は次の通りです。

    API 説明
    createExternalCertificate 外部証明書を追加
    deleteCertificate 証明書を削除
    getCertificateList 証明書を照会

    Certificate Manager関連リソース

    Certificate Manager APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。