ListDomainValidations

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

登録されているドメインの検証情報リストを照会します。

リクエスト

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

メソッド	URI
GET	/api/v2/domain/domains

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`page`	Integer	Optional	ページ番号デフォルト: 1
`pageSize`	Integer	Optional	ページサイズデフォルト: 10
`domainAddress`	String	Optional	ドメインアドレス
`dcvType`	String	Optional	ドメイン検証(DCV)タイプ `PTXT` \| `TXT` `PTXT`: 最初に一度設定するだけで、その後はレコードを変更することなく継続的に検証が可能 `TXT`: 発行するたびに新しいレコードを設定する必要があり、有効期限が切れた場合は再検証が必要
`orgNo`	Integer	Optional	組織番号
`validState`	String	Optional	検証の状態 `PENDING` \| `VALID` \| `INVALID` `PENDING`: 検証待ち `VALID`: 検証完了 `INVALID`: 検証失敗

リクエスト例

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

curl --location --request GET 'https://certificatemanager.apigw.ntruss.com/api/v2/domain/domains?page=1&pageSize=10' \
--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	-	レスポンスコード成功: `0` 失敗: `1`以上
`returnMessage`	String	-	レスポンスメッセージ
`totalRows`	Integer	-	照会されたリストの総数
`domainVldList`	Array	-	ドメイン検証情報リスト: domainVldList

`domainVldList`

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

フィールド	タイプ	必須の有無	説明
`dmnId`	Long	-	ドメイン ID
`memberNo`	String	-	会員番号
`domainAddress`	String	-	ドメインアドレス
`dcvType`	String	-	ドメイン検証(DCV)タイプ `PTXT` \| `TXT`
`validState`	String	-	検証の状態 `VALID` \| `FAILED` \| `PENDING` \| `EXPIRED` `VALID`: 検証完了 `FAILED`: 検証失敗 `PENDING`: 検証待ち `EXPIRED`: 検証タイムアウト
`issueType`	String	-	発行タイプ `CONSOLE` \| `ACME`
`orgNo`	Integer	-	組織番号
`validYn`	String	-	検証の有無 `Y` \| `N`
`validDate`	DateTime	-	検証日
`createdDate`	DateTime	-	作成日時
`expireDate`	DateTime	-	有効期限

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

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

レスポンス例

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

{
    "returnCode": "0",
    "returnMessage": "Success",
    "totalRows": 9,
    "domainVldList": [
        {
            "dmnId": 573,
            "memberNo": "5000816",
            "domainAddress": "test.ncp-cm.com",
            "dcvType": "PTXT",
            "validState": "PENDING",
            "issueType": "CONSOLE",
            "acmeAccountId": null,
            "orgNo": null,
            "persistUntil": null,
            "validYn": "N",
            "validDate": null,
            "createdDate": "2026-04-16T17:11:20",
            "expireDate": "2026-04-25T17:11:20"
        }
    ]
}