Preview Domain DNS Records

Preview the DNS records to be configured for a domain.

Request URL

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

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
domain Yes String The domain name in lowercase.
Note: The maximum character length is 200.

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 previewed DNS records.
DNS_Check_Result
Parameter Type Description
status String

The overall check status of the DNS records.

  • RESOLVED: All DNS records are resolved.
  • NOT_RESOLVED: At least one DNS record is not resolved.
  • NOT_CHECKED: The DNS records are not checked.
records Array<Record_Check_Result> The details of each DNS record.
acmeIssuer Object<Acme_Issuer> The ACME issuer.
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.
Acme_Issuer
Parameter Type Description
clusterIssuerRef String The name of the ClusterIssuer.
acmeAlias String The ACME DNS-01 delegation root domain, which is the root of the ACME CNAME target domain.

Example

Request example

POST /uc-user/api/v1/domains/regions/cn-0/dns-preview 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
{
  "domain": "claude-doc-test.example.com"
}

Response example

HTTP/1.1 200 OK
{
  "result": {
    "status": "NOT_CHECKED",
    "records": [
      {
        "recordRole": "WEB",
        "host": "claude-doc-test.example.com",
        "subDomain": "claude-doc-test",
        "rootDomain": "example.com",
        "recordType": "CNAME",
        "target": "cn-0.test.novo-one.com."
      },
      {
        "recordRole": "API",
        "host": "api.claude-doc-test.example.com",
        "subDomain": "api.claude-doc-test",
        "rootDomain": "example.com",
        "recordType": "CNAME",
        "target": "api.cn-0.test.novo-one.com."
      },
      {
        "recordRole": "SIP",
        "host": "sip.claude-doc-test.example.com",
        "subDomain": "sip.claude-doc-test",
        "rootDomain": "example.com",
        "recordType": "CNAME",
        "target": "sip.cn-0.test.novo-one.com."
      },
      {
        "recordRole": "ACCOUNT",
        "host": "account.claude-doc-test.example.com",
        "subDomain": "account.claude-doc-test",
        "rootDomain": "example.com",
        "recordType": "CNAME",
        "target": "account.cn-0.test.novo-one.com."
      },
      {
        "recordRole": "ACME",
        "host": "_acme-challenge.claude-doc-test.example.com",
        "subDomain": "_acme-challenge.claude-doc-test",
        "rootDomain": "example.com",
        "recordType": "CNAME",
        "target": "claude-doc-test.example.com.acme-alias.com."
      }
    ],
    "acmeIssuer": {
      "clusterIssuerRef": "letsencrypt-staging",
      "acmeAlias": "acme-alias.com"
    }
  },
  "requestId": "4d54a1e4465ffcc86ba5169a1e1204f9",
  "code": "200",
  "message": "SUCCESS"
}