ListCloudCertificates

Prev Next

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

保有している Cloud DB Basic、Global Edge証明書を照会します。

リクエスト

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

メソッド URI
GET /certificate/certificates

リクエストヘッダ

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

リクエスト例

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

curl --location --request GET 'https://certificatemanager.apigw.ntruss.com/api/v2/certificate/certificates' \
--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'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
returnCode String - レスポンスコード
returnMessage String - レスポンスメッセージ
totalCount Integer - 照会されたリストの総数
sslCertificateList Array - 証明書リスト

sslCertificateList

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

フィールド タイプ 必須の有無 説明
certificateNo Integer - 証明書番号
certificateName String - 証明書名
memberNo String - NAVERクラウドプラットフォームユーザーの会員番号
commonName String - 証明書の CN(Common Name)に含まれるドメイン
dnsName String - 証明書 SAN(Subject Alternative Name)に含まれるドメインリスト
statusCode String - 証明書の状態コード
  • 0 | 1 | 2 | 3 | -1 | -2 | -3 | -4 | -5 | -6 | -7 | -11 | -12 | -20
    • 0: ONGOING
    • 1: NORMAL
    • 2: NORMAL_UNREGISTERED_PRIVATE_KEY
    • 3: NORMAL_GLOBAL_EDGE_DEDICATED
    • -1: FAILED
    • -2: EXPIRE
    • -3: VALIDATION_FAILED
    • -4: VALIDATION_EXPIRE
    • -5: REVOKE
    • -6: DELETED
    • -7: REQUEST_REVOKE
    • -11: FAILED (LINT)
    • -12: FAILED (CT)
    • -20: FAILED (ORG_LOCK / DNS_TXT)
statusName String - 証明書の状態
  • ONGOING | NORMAL | NORMAL_UNREGISTERED_PRIVATE_KEY | NORMAL_GLOBAL_EDGE_DEDICATED | FAILED | EXPIRE | VALIDATION_FAILED | VALIDATION_EXPIRE | REVOKE | DELETED | REQUEST_REVOKE
    • ONGOING: 進行中
    • NORMAL: 正常
    • NORMAL_UNREGISTERED_PRIVATE_KEY: 正常 (秘密鍵を登録していない)
    • NORMAL_GLOBAL_EDGE_DEDICATED: 正常 (Global Edge Dedicated)
    • FAILED: 失敗
    • FAILED (LINT): 失敗 (LINTチェック)
    • FAILED (CT): 失敗 (CTチェック)
    • FAILED (ORG_LOCK / DNS_TXT): 組織情報不一致 (DNS TXT)
    • EXPIRE: 有効期限切れ
    • VALIDATION_FAILED: 検証失敗
    • VALIDATION_EXPIRE: 検証時間超過
    • REVOKE: 失効
    • DELETED: 削除
    • REQUEST_REVOKE: 失効処理中
certificateType String - 証明書タイプ
  • NCP_FREE_DV_01 | NCP_GLOBAL_EDGE_DEDICATED
    • NCP_FREE_DV_01: Cloud DB Basic証明書
    • NCP_GLOBAL_EDGE_DEDICATED: Global Edge証明書
domainCode String - 発行環境のドメイン
  • PUB: NAVERクラウドプラットフォーム(個人/一般企業向け)
updateDate String - 最終更新日時
  • yyyy-MM-dd HH:mm:ss(UTC+09:00)形式
issueType String - 発行状態: その証明書を利用した再発行が可能かを確認するために使用
  • ORIGINAL | REPRESENTATIVE | REISSUE
    • ORIGINAL: 原本証明書(代表証明書がない場合に再発行可能)
    • REPRESENTATIVE: 代表証明書 (再発行可能)
    • REISSUE: 再発行証明書 (再発行不可)
subjectDN String - 証明書の Distinguished Name(DN)情報
registDate String - 証明書の登録日時
  • yyyy-MM-dd HH:mm:ss(UTC+09:00)形式

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

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

レスポンス例

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

{
  "returnCode": "0",
  "returnMessage": "Success",
  "totalCount": 42,
  "sslCertificateList": [
        {
            "certificateNo": 12345,
            "certificateName": "sample-certificate",
            "memberNo": "9999999",
            "commonName": "*.example.com",
            "dnsName": "example.com,example-docs.com",
            "statusCode": "1",
            "statusName": "Normal",
            "certificateType": "SAMPLE_DV_01",
            "domainCode": "PUB",
            "updateDate": "2026-01-01 10:00:00(UTC+09:00)",
            "issueType": "ORIGINAL",
            "subjectDN": "CN=*.example.com",
            "registDate": "2026-01-01 10:00:00(UTC+09:00)"
        },
  ]
  ...
}