createExternalCertificate

Prev Next

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

NAVERクラウドプラットフォームではない外部の公認認証局が発行した SSL証明書を追加します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /certificate/withExternal

リクエストヘッダ

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

フィールド 必須の有無 説明
Content-Type Required リクエストデータの形式
  • application/json

Certificate Manager APIで共通して使用されるヘッダの詳細は、Certificate Managerの共通ヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
certificateName String Required 証明書名
  • 英数字、記号の「-」を使用して3~30文字以内で入力
  • 重複不可
privateKey String Required PEMエンコードされた証明書の秘密鍵
publicKeyCertificate String Required PEMエンコードされた証明書ボディ
  • 重複不可
certificateChain String Required PEMエンコードされた証明書チェーン

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://certificatemanager.apigw.ntruss.com/api/v1/certificate/withExternal' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--data '{
    "certificateName": {Certificate Name},
    "privateKey": {Private Key},
    "publicKeyCertificate": {Public Key Certificate},
    "certificateChain": {Certificate Chain}
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
returnCode String - レスポンスコード
returnMessage String - レスポンスメッセージ
totalRows Integer - SSL証明書(sslCertificateList)数
sslCertificateList Array - 証明書リスト

sslCertificateList

sslCertificateListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
certificateNo Integer - 証明書番号
certificateType String - 証明書タイプ
certificateName String - 証明書名
memberNo String - ユーザーの NAVERクラウドプラットフォーム会員番号
dnInfo String - 証明書の Distinguished Name(DN)情報
domainAddress String - 証明書の代表ドメインアドレス
subDomainAddress String - 証明書のサブドメインアドレス
regDate Date - 証明書の登録日時
validStartDate Date - 証明書の有効開始日時
validEndDate Date - 証明書の有効終了日時
revokeDate Date - 証明書の失効日時
  • 証明書が失効された場合にのみ表示
    		•
    statusCode String - 証明書の状態コード
    statusName String - 証明書の状態
    externalYn String - 外部証明書かどうか
    domainCode String - ドメインコード
    caInfo String - 証明書認証局(CA)情報
    certSerialNumber String - 証明書のシリアル番号
    certPublicKeyInfo String - 公開鍵(Public key)情報
    certSignAlgorithmName String - 署名アルゴリズム
    usedInstanceNoList String - 証明書を使用中のインスタンスリスト
    updateDate Date - 最終更新日時

    レスポンスステータスコード

    Certificate Manager APIで共通して使用されるレスポンスステータスコードの詳細は、Certificate Managerの共通レスポンスステータスコードをご参照ください。

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    {
    "returnCode": "0",
    "returnMessage": "Success",
    "totalRows": 1,
    "sslCertificateList": [
        {
            "certificateNo": 30728,
            "certificateType": "EXT",
            "certificateName": "zero-certi",
            "memberNo": "*******",
            "dnInfo": "CN=************.***.kr",
            "domainAddress": "************.***.kr",
            "subDomainAddress": "",
            "regDate": "2024-07-30 11:33:33",
            "validStartDate": "2024-07-30 09:00:00",
            "validEndDate": "2024-10-29 08:59:59",
            "statusCode": "1",
            "statusName": "Normal",
            "externalYn": "Y",
            "domainCode": "PUB",
            "caInfo": "ZeroSSL RSA Domain Secure Site CA",
            "certSerialNumber": "92cf99ce**************a6205a5018",
            "certPublicKeyInfo": "Sun RSA public key, 2048 bits",
            "certSignAlgorithmName": "SHA384withRSA",
            "updateDate": "2024-07-30 11:33:33"
        }
    ]
}