Check Domain DNS Records

Check whether the CNAME DNS records of a domain are resolved.

Request URL

POST {base_url}/uc-user/api/v1/domains/regions/{region}/dns-check

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
Path parameters
Parameter Required Type Description
region Yes String The region code associated with the desired domain.
Note: You can query the region code using Get Available Regions.
Body parameters
Parameter Required Type Description
records Yes Array<Record_To_Check> The list of DNS records to check.

Record_To_Check

Parameter Required Type Description
recordRole Yes String

The role of the DNS record.

Valid value:

  • WEB
  • API
  • SIP
  • ACCOUNT
  • ACME
host Yes String The CNAME host domain.
Note: You can query the host domain using the Search Domains interface.
recordType Yes String

The record type.

Valid value:

  • CNAME
target Yes String The CNAME target domain.
Note: You can query the host domain using the Search Domains interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<DNS_Check_Result> The DNS check result.
DNS_Check_Result
Parameter Type Description
records Array<Record_Check_Result> The details of each DNS record.

Record_Check_Result

Parameter Type Description
recordRole String

The service type of the DNS record.

  • WEB
  • API
  • SIP
  • ACCOUNT
  • ACME
host String The CNAME host domain.
subDomain String The subdomain, which is the left prefix of the host domain after the portal domain is removed.

For example, the subdomain of cn-0.dev.ymznas.cn is cn-0.dev.
rootDomain String The portal domain.
recordType String The record type.
  • CNAME
target String The CNAME target domain.
checkStatus String

The check status of the DNS record.

  • NOT_CHECKED: The DNS record is not checked.
  • CHECKING: The DNS record is being checked.
  • RESOLVED: The DNS record is resolved.
  • NOT_RESOLVED: The DNS record is not resolved.
resolvedValues Array<String> The CNAME target domains of the resolved DNS records.
lastCheckedAt Integer The time when the DNS record was last checked, in Unix timestamp format (milliseconds).
failureReason String The reason why the most recent check failed.

Example

Request example

POST /uc-user/api/v1/domains/regions/cn-0/dns-check HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTg4MDQwMCwiaWF0IjoxNzkxODU4ODAwLCJqdGkiOiJlYjczYTljNi05NGY1LTQ5MzItODcyYi0yMDUzMzVmMWE4YTkiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.hTHYgOuTSUnTMWM4NwMB6tPaChCUx2_2SNsSGTpGbIVF1goAOeUi1rbPej1t04EgzC_c6lfRAdf2mB0Uq4JP49DNYKDwbUDerQqc8WeO-RQvd466YJWsGlCJcWEzGaTXPpNG9glzn3i_zArhJN7MyzVKWz5ygKAadH7nQ5RJzLM6sOFnZ5DbTnQ4_uT_P-AdnPcTrlNvP62R58fiKjARMHPR0tHuUA3U0IiMKzH3uRVTyRXY_LccFFVys3Io5J5-ovntsTKaZ0o08kcXh1FJ5BW2Zj_6DJE_-Q1dwzQDkJ7aWJuRNSG30zXakHbuG7UqqFYRG8Y6MUDMoraKaCATKA
Content-Type: application/json
{
  "records": [
    {
      "recordRole": "WEB",
      "host": "novoone.online",
      "recordType": "CNAME",
      "target": "cn-0.test.novo-one.com."
    }
  ]
}

Response example

HTTP/1.1 200 OK
{
  "result": {
    "records": [
      {
        "recordRole": "WEB",
        "host": "novoone.online",
        "rootDomain": "novoone.online",
        "recordType": "CNAME",
        "target": "cn-0.test.novo-one.com.",
        "checkStatus": "RESOLVED",
        "resolvedValues": [
          "cn-0.test.novo-one.com."
        ],
        "lastCheckedAt": 1791859355018
      }
    ]
  },
  "requestId": "563893774b150fb11c453fe8b74c8c74",
  "code": "200",
  "message": "SUCCESS"
}