ListDcvStatuses

Prev Next

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

証明書ドメイン所有権検証(DCV)の状態を照会します。

リクエスト

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

メソッド URI
GET /certificate/getVerificationInfo/{certificateNo}

リクエストヘッダ

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

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
certificateNo Integer Required 証明書番号

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
domainAddress String Required 検証対象ドメイン(FQDN)

リクエスト例

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

curl --location --request GET 'https://certificatemanager.apigw.ntruss.com/api/v2/certificate/getVerificationInfo/55332?domainAddress=ncloud.com \
--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 - レスポンスメッセージ
totalRows Integer - 照会されたリストの総数
dnsVerificationCount Integer - DNS TXTレコードによるドメイン検証リクエスト数
dnsVerificationList Array - DNS TXTレコードによるドメイン検証リクエストリスト

dnsVerificationList

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

フィールド タイプ 必須の有無 説明
validSn String - 検証履歴識別子
requestSn String - リクエストの固有 ID
validStatusCode String - 検証の状態コード
  • VALID_STATUS_SUCCESS | VALID_STATUS_REG | VALID_STATUS_TIMEOUT
    • VALID_STATUS_SUCCESS: 検証完了
    • VALID_STATUS_REG: 検証実行中
    • VALID_STATUS_TIMEOUT: 検証時間タイムアウト
txtName String - DNS TXTレコード名
txtValue String - DNS TXTレコード値 (ランダムな値)
validYn String - 検証完了したか
  • Y | N
    • Y: 検証完了
    • N: 未検証
registDate String - 検証リクエストの登録日時
  • yyyy-MM-dd HH:mm:ss(UTC+09:00)形式
validDate String - 検証完了日時
  • yyyy-MM-dd HH:mm:ss(UTC+09:00)形式

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

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

レスポンス例

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

{
  "returnCode": "0",
  "returnMessage": "Success",
  "totalRows": 1,
  "dnsVerificationCount": 1,
  "dnsVerificationList": [
    {
      "validSn": 30001,
      "requestSn": "a1b2c3d4e5f6478899aa00bbccddeeff",
      "validStatusCode": "VALID_STATUS_SUCCESS",
      "txtId": 1,
      "txtName": "_dnsvalidation.example.com",
      "txtValue": "_abc123def456ghi789jkl012mno345pqr678stu901vwx234yz",
      "validYn": "Y",
      "registDate": "2026-02-01 10:00:00",
      "validDate": "2026-02-01 10:01:15"
    }
  ]
}