获取域名详情

GET

/openapi/v3/domains/:id

获取指定预审核域名的当前状态、验证方式和验证信息。

路径参数

参数	类型	必填	说明
id	string	是	预审核域名 ID，使用创建域名返回的 id

本接口无需查询参数或请求体。

返回参数

域名对象直接位于 data 下，例如 data.id、data.status。

参数	类型	说明
id	string	预审核域名 ID
domain	string	域名
dcv_method	string	当前验证方式，如 dns、file、cname、email、dns-persist；代理验证场景可能返回 dns-proxy 或 file-proxy
auth_path	string	验证记录名或文件路径，随验证方式而定；无可用路径时为空字符串
auth_val	string	验证值；尚未生成、当前不可用或不适用于当前验证方式时，可能为空字符串
status	string	域名状态，如 ca_auditing、verified，完整取值见域名状态
email	string	域名验证邮箱；为空时省略
real_val	string	代理或长效验证等场景下的实际验证值；为空时省略
validations	array[object]	各验证类型的验证详情；无记录时省略，字段见下表
created_time	string	域名创建时间，RFC 3339 格式；无记录时省略
link	string	域名验证页面链接；无链接时省略

validations 元素

参数	类型	说明
type	string	验证类型，如 ov、ev
name	string	验证名称；当前与 type 相同
description	string	验证描述；当前与 type 相同
status	string	该类型的验证状态：pending（待验证）、complete（已完成）、expired（已过期）；未提供时省略
expire_time	string	该类型的验证到期时间，RFC 3339 格式；未提供时省略

域名整体状态使用 data.status；validations[].status 表示各验证类型的状态，两者取值不同。获取到验证值不代表验证已通过。

请求示例

将域名 ID 和鉴权值替换为当前账户下的实际值。

curl -X GET 'https://api.certcloud.cn/openapi/v3/domains/8tnsIUXQ' \
  -H 'X-CC-Auth-Key: your-auth-key' \
  -H 'X-CC-Key-ID: your-key-id'

const response = await fetch('https://api.certcloud.cn/openapi/v3/domains/8tnsIUXQ', {
  method: 'GET',
  headers: {
    'X-CC-Auth-Key': 'your-auth-key',
    'X-CC-Key-ID': 'your-key-id',
  },
})
const data = await response.json()
console.log(response.status, data)

package main

import (
  "io"
  "net/http"
  "os"
  "time"
)

func main() {
  req, err := http.NewRequest("GET", "https://api.certcloud.cn/openapi/v3/domains/8tnsIUXQ", nil)
  if err != nil {
    panic(err)
  }
  req.Header.Set("X-CC-Auth-Key", "your-auth-key")
  req.Header.Set("X-CC-Key-ID", "your-key-id")

  client := &http.Client{Timeout: 30 * time.Second}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  if _, err := io.Copy(os.Stdout, resp.Body); err != nil {
    panic(err)
  }
}

import requests

response = requests.get(
    'https://api.certcloud.cn/openapi/v3/domains/8tnsIUXQ',
    headers={
        'X-CC-Auth-Key': 'your-auth-key',
        'X-CC-Key-ID': 'your-key-id',
    },
    timeout=30,
)
data = response.json()
print(response.status_code, data)

响应示例

以下为 DNS 验证场景的示例，记录名、验证值和时间以实际返回为准。

200成功

{
  "code": "success",
  "data": {
    "id": "8tnsIUXQ",
    "domain": "example.com",
    "dcv_method": "dns",
    "auth_path": "_dnsauth.example.com",
    "auth_val": "example-validation-token",
    "status": "ca_auditing",
    "validations": [
      {
        "type": "ov",
        "name": "ov",
        "description": "ov",
        "status": "pending"
      }
    ],
    "created_time": "2026-10-29T09:00:00+08:00"
  }
}

错误说明

API Key 缺少订单访问权限，或域名不属于当前账户时，返回 HTTP 403 和 permission_denied。域名 ID 不存在时也可能返回此错误，请检查是否使用了当前账户创建域名时返回的 ID。

其他错误及响应格式参见错误码说明。查询时请遵守调用频率限制。

相关文档

• 创建域名
• 更新域名验证方式
• 刷新域名验证值
• 域名验证完成
• 域名续期