証明書のプロビジョニング

Prev Next

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

証明書をプロビジョニングします。

参考

証明書をプロビジョニングするには、先に Certificate Managerサービスを介して証明書を発行するか、外部証明書を登録する必要があります。コンソールでは証明書発行と外部証明書登録がいずれも可能ですが、APIは外部証明書登録のみサポートしています。証明書の発行および登録方法の詳細は、次をご参照ください。

リクエスト

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

メソッド URI
POST /api/v1/certificate/provisioning

リクエストヘッダ

Global Edge APIで共通して使用されるヘッダの詳細は、Global Edgeのリクエストヘッダをご参照ください。

リクエストボディ

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

フィールド タイプ 必須の有無 説明
serviceRegion String Required サービス地域
  • KR_JP | KR_JP_GLOBAL
    • KR_JP: 韓国、日本
    • KR_JP_GLOBAL: グローバル
cmCertificateIds Array Required 証明書番号リスト
  • Certificate Managerサービスに登録されている証明書の番号
  • KR_JPの場合: 韓国、日本証明書が1つ必要
  • KR_JP_GLOBALの場合: 韓国、日本証明書が1つ、グローバル証明書1つ必要
tlsVersion String Required TLSプロトコルサポートバージョン
  • TLS_ALL_VERSIONS | TLS_MIN_VERSION_1_2
    • TLS_ALL_VERSIONS: 全 TLSバージョン
    • TLS_MIN_VERSION_1_2: TLS 1.2以降 (推奨)
cipherProfile String Required 有効なパスワードプロファイル
  • DEFAULT | GENERAL | STRICT
    • DEFAULT: GE-DEFAULT-v1
    • GENERAL: GE-GENERAL-v1
    • STRICT: GE-STRICT-v1
  • tlsVersionがTLS_ALL_VERSIONSの場合、STRICTは使用不可

リクエスト例

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

curl --location --request POST 'https://edge.apigw.ntruss.com/api/v1/certificate/provisioning' \
--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' \
--data '{
  "serviceRegion": "KR_JP_GLOBAL",
  "cmCertificateIds": [
    8***5, 8***8
  ],
  "tlsVersion": "TLS_MIN_VERSION_1_2",
  "cipherProfile": "STRICT"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code String - レスポンスコード
message String - レスポンスメッセージ
result Boolean - レスポンス結果
  • true | false
    • true: 成功
    • false: 失敗

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

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

レスポンス例

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

{
  "code": "0000",
  "message": "Success",
  "result": true
}