Appendix

DNS

  • API Reference
    • API function release records
    • API Service Domain Name
    • Appendix
    • Common Headers and Error Responses
    • General Description
    • Interface Overview
    • Overview
    • Private DNS Related Interfaces
      • Add resolution record
      • Associate VPC
      • Create a PrivateZone
      • Delete PrivateZone
      • Delete resolution record
      • Disassociate VPC
      • Modify resolution record
      • Query details of a PrivateZone
      • Query PrivateZone list
      • Query resolution record list
      • Set Resolution Record Status
    • Public DNS Related Interfaces
      • Domain Name Related Interfaces
      • Line Group Related Interfaces
      • Resolution Records Related Interfaces
  • FAQs
    • General FAQs
  • Function Release Records
  • Operation guide
    • Identity and access management
    • Local DNS service
      • Add Private Zone
      • Add resolution record
      • Associate VPC
      • Delete Private Zone
      • Resolver
    • Public DNS service
      • Add domain name
      • Add resolution
      • Enable Resolution Service
      • Line Grouping Function
      • Manage Resolution
      • Resolution Line Selection
      • Upgrade Domain Name to Enterprise Edition Operation Guide
    • Resolution Logging Management
  • Product Description
    • Application scenarios
    • Product advantages
    • Product functions
    • Product overview
    • Usage restrictions
  • Product pricing
  • Quick Start
    • Activate Service
    • Use Resolution Service
  • SDK
    • Golang-SDK
      • Exception handling
      • Initialization
      • Install the SDK Package
      • Overview
      • Private DNS
      • Version history
    • Java-SDK
      • Install the SDK Package
      • Overview
      • Private DNS
      • Public DNS
      • Version history
    • Python-SDK
      • Initialization
      • Install the SDK Package
      • Overview
      • Private DNS
      • Public DNS
      • Version history
  • Service Level Agreement (SLA)
    • Internal DNS Service Level Agreement SLA
    • Public DNS Service Level Agreement SLA
  • Typical Practices
    • Implement URL Forwarding via Nginx
    • Local IDC Interconnection with Cloud DNS Service via Resolver
    • Quickly Set Up Private Domain Name Resolution Service Using Terraform
All documents
menu
No results found, please re-enter

DNS

  • API Reference
    • API function release records
    • API Service Domain Name
    • Appendix
    • Common Headers and Error Responses
    • General Description
    • Interface Overview
    • Overview
    • Private DNS Related Interfaces
      • Add resolution record
      • Associate VPC
      • Create a PrivateZone
      • Delete PrivateZone
      • Delete resolution record
      • Disassociate VPC
      • Modify resolution record
      • Query details of a PrivateZone
      • Query PrivateZone list
      • Query resolution record list
      • Set Resolution Record Status
    • Public DNS Related Interfaces
      • Domain Name Related Interfaces
      • Line Group Related Interfaces
      • Resolution Records Related Interfaces
  • FAQs
    • General FAQs
  • Function Release Records
  • Operation guide
    • Identity and access management
    • Local DNS service
      • Add Private Zone
      • Add resolution record
      • Associate VPC
      • Delete Private Zone
      • Resolver
    • Public DNS service
      • Add domain name
      • Add resolution
      • Enable Resolution Service
      • Line Grouping Function
      • Manage Resolution
      • Resolution Line Selection
      • Upgrade Domain Name to Enterprise Edition Operation Guide
    • Resolution Logging Management
  • Product Description
    • Application scenarios
    • Product advantages
    • Product functions
    • Product overview
    • Usage restrictions
  • Product pricing
  • Quick Start
    • Activate Service
    • Use Resolution Service
  • SDK
    • Golang-SDK
      • Exception handling
      • Initialization
      • Install the SDK Package
      • Overview
      • Private DNS
      • Version history
    • Java-SDK
      • Install the SDK Package
      • Overview
      • Private DNS
      • Public DNS
      • Version history
    • Python-SDK
      • Initialization
      • Install the SDK Package
      • Overview
      • Private DNS
      • Public DNS
      • Version history
  • Service Level Agreement (SLA)
    • Internal DNS Service Level Agreement SLA
    • Public DNS Service Level Agreement SLA
  • Typical Practices
    • Implement URL Forwarding via Nginx
    • Local IDC Interconnection with Cloud DNS Service via Resolver
    • Quickly Set Up Private Domain Name Resolution Service Using Terraform
  • Document center
  • arrow
  • DNS
  • arrow
  • API Reference
  • arrow
  • Appendix
Table of contents on this page
  • Definition of related model object
  • PublicZone
  • TagModel
  • PublicRecord
  • Line
  • Billing
  • BillingForRenew
  • Reservation
  • LineName
  • PrivateZone
  • Vpc
  • PrivateRecord

Appendix

Updated at：2025-11-11

Definition of related model object

PublicZone

Parameter name Types Description
id String Zone ID.
name String Domain name.
status String Status of the domain name, including: normal (running), unregistered (unregistered), NS not changed (nsunchanged), service failed (failed), and unrecorded (to-renew).
productVersion String Product version, which can include: basic version (free), discount version (discount), and enterprise version (flagship).
createTime String Creation time (Beijing Time), e.g., "04/28/2022 17:05:45".
expireTime String Expiration time (Beijing Time), e.g., "04/28/2023 17:05:44".
tags List<TagModel> A list of tag key-value pairs.

TagModel

Parameter name Types Description
tagKey String The key of the tag, which can include uppercase and lowercase letters, numbers, Chinese characters, and special characters such as -_ /. with a length of 1-65.
tagValue String The value of the tag, which can include uppercase and lowercase letters, numbers, Chinese characters, and special characters such as -_ /. with a length of 0-65.

PublicRecord

Parameter name Types Description
id String Resolution record ID.
rr String Host record.
status String Domain name status options: normal (running), paused (stopped), or service failed (failed).
type String Resolution record types, including: "A", "CNAME", "MX", "TXT", "NS", "AAAA", "SRV".
value String Record value, e.g., IP: 192.168.1.1, CNAME: cname.baidu.com, MX: mail.baidu.com.
ttl int The cache time of the resolution record on the local DNS server (unit: seconds). Defaults are 300 seconds for the basic version, 120 seconds for the discount version, and 1 second for the enterprise version. The value must be a positive integer.
line String Resolution line or line group name, default is "default", options include: default (default), China Telecom (ct), China Mobile (cmnet), China Unicom (cnc), Education Network (edu), or Search Engine (Baidu) (search).
description String Description, with a maximum length of 255 characters.
priority int Priority of MX record, value range: [0, 50]. Returned when the record type is MX.

Line

Parameter name Types Description
id String Line group ID.
name String Line group name.
lines List Line name, refer to LineName for available values.
relatedZoneCount int Number of associated zones.
relatedRecordCount int Number of associated resolution records.

Billing

Parameter name Types Required or not Description
paymentTiming String Yes Payment time: Prepaid and Postpaid. Currently, only Prepaid is supported.
reservation Reservation Yes Reserved information, not needed when the payment method is Postpay, but required for Prepay.

BillingForRenew

Parameter name Types Required or not Description
reservation Reservation Yes Reserved information.

Reservation

Parameter name Types Required or not Description
reservationLength int Yes Purchase duration in years, [1,2,3].

LineName

English name Name in Chinese
yunnan.ct Yunnan Branch of China Telecom
henan.ct Henan Branch of China Telecom
zhejiang.ct Zhejiang Branch of China Telecom
shanghai.ct Shanghai Branch of China Telecom
shanxi.ct Shanxi Branch of China Telecom
hubei.ct Hubei Branch of China Telecom
beijing.ct Beijing Branch of China Telecom
jiangxi.ct Jiangxi Branch of China Telecom
hebei.ct Hebei Branch of China Telecom
hainan.ct Hainan Branch of China Telecom
gansu.ct Gansu Branch of China Telecom
jilin.ct Jilin Branch of China Telecom
liaoning.ct Liaoning Branch of China Telecom
heilongjiang.ct Heilongjiang Branch of China Telecom
fujian.ct Fujian Branch of China Telecom
chongqing.ct Chongqing Branch of China Telecom
neimenggu.ct Inner Mongolia Branch of China Telecom
xizang.ct Tibet Branch of China Telecom
ningxia.ct Ningxia Branch of China Telecom
guizhou.ct Guizhou Branch of China Telecom
guangxi.ct Guangxi Branch of China Telecom
tianjin.ct Tianjin Branch of China Telecom
guangdong.ct Guangdong Branch of China Telecom
qinghai.ct Qinghai Branch of China Telecom
shaanxi.ct Shaanxi Branch of China Telecom
shandong.ct Shandong Branch of China Telecom
sichuan.ct Sichuan Branch of China Telecom
hunan.ct Hunan Branch of China Telecom
anhui.ct Anhui Branch of China Telecom
xinjiang.ct Xinjiang Branch of China Telecom
jiangsu.ct Jiangsu Branch of China Telecom
yunnan.cnc Yunnan Branch of China Unicom
henan.cnc Henan Branch of China Unicom
zhejiang.cnc Zhejiang Branch of China Unicom
shanghai.cnc Shanghai Branch of China Unicom
shanxi.cnc Shanxi Branch of China Unicom
hubei.cnc Hubei Branch of China Unicom
beijing.cnc Beijing Branch of China Unicom
jiangxi.cnc Jiangxi Branch of China Unicom
hebei.cnc Hebei Branch of China Unicom
hainan.cnc Hainan Branch of China Unicom
gansu.cnc Gansu Branch of China Unicom
jilin.cnc Jilin Branch of China Unicom
liaoning.cnc Liaoning Branch of China Unicom
heilongjiang.cnc Heilongjiang Branch of China Unicom
fujian.cnc Fujian Branch of China Unicom
chongqing.cnc Chongqing Branch of China Unicom
neimenggu.cnc Inner Mongolia Branch of China Unicom
xizang.cnc Tibet Branch of China Unicom
ningxia.cnc Ningxia Branch of China Unicom
guizhou.cnc Guizhou Branch of China Unicom
guangxi.cnc Guangxi Branch of China Unicom
tianjin.cnc Tianjin Branch of China Unicom
guangdong.cnc Guangdong Branch of China Unicom
qinghai.cnc Qinghai Branch of China Unicom
shaanxi.cnc Shaanxi Branch of China Unicom
shandong.cnc Shandong Branch of China Unicom
sichuan.cnc Sichuan Branch of China Unicom
hunan.cnc Hunan Branch of China Unicom
anhui.cnc Anhui Branch of China Unicom
xinjiang.cnc Xinjiang Branch of China Unicom
jiangsu.cnc Jiangsu Branch of China Unicom
yunnan.cmnet Yunnan Branch of China Mobile
henan.cmnet Henan Branch of China Mobile
zhejiang.cmnet Zhejiang Branch of China Mobile
shanghai.cmnet Shanghai Branch of China Mobile
shanxi.cmnet Shanxi Branch of China Mobile
hubei.cmnet Hubei Branch of China Mobile
beijing.cmnet Beijing Branch of China Mobile
jiangxi.cmnet Jiangxi Branch of China Mobile
hebei.cmnet Hebei Branch of China Mobile
hainan.cmnet Hainan Branch of China Mobile
gansu.cmnet Gansu Branch of China Mobile
jilin.cmnet Jilin Branch of China Mobile
liaoning.cmnet Liaoning Branch of China Mobile
heilongjiang.cmnet Heilongjiang Branch of China Mobile
fujian.cmnet Fujian Branch of China Mobile
chongqing.cmnet Chongqing Branch of China Mobile
neimenggu.cmnet Inner Mongolia Branch of China Mobile
xizang.cmnet Tibet Branch of China Mobile
ningxia.cmnet Ningxia Branch of China Mobile
guizhou.cmnet Guizhou Branch of China Mobile
guangxi.cmnet Guangxi Branch of China Mobile
tianjin.cmnet Tianjin Branch of China Mobile
guangdong.cmnet Guangdong Branch of China Mobile
qinghai.cmnet Qinghai Branch of China Mobile
shaanxi.cmnet Shaanxi Branch of China Mobile
shandong.cmnet Shandong Branch of China Mobile
sichuan.cmnet Sichuan Branch of China Mobile
hunan.cmnet Hunan Branch of China Mobile
anhui.cmnet Anhui Branch of China Mobile
xinjiang.cmnet Xinjiang Branch of China Mobile
jiangsu.cmnet Jiangsu Branch of China Mobile
xinan.cmnet Southwest China Branch of China Mobile
huanan.ctt South China Branch of China Tietong
xibei.ctt Northwest China Branch of China Tietong
dongbei.ctt Northeast China Branch of China Tietong
huazhong.ctt Central China Branch of China Tietong
huadong.ctt East China Branch of China Tietong
huabei.ctt North China Branch of China Tietong
xinan.ctt Southwest China Branch of China Tietong
huanan.pbs South China Branch of Dr. Peng
xibei.pbs Northwest China Branch of Dr. Peng
dongbei.pbs Northeast China Branch of Dr. Peng
huazhong.pbs Central China Branch of Dr. Peng
huadong.pbs East China Branch of Dr. Peng
huabei.pbs North China Branch of Dr. Peng
xinan.pbs Southwest China Branch of Dr. Peng
shanghai.oc Shanghai - North China Radio and Television
hangzhou.wasu Hangzhou - Shanghai Wasu
hongkong.any Hong Kong
macao.any Macau
taiwan.any Taiwan
mexico.any Mexico
brazil.any Brazil
argentina.any Argentina
usa.any United States
ukraine.any Ukraine
uk.any United Kingdom
spain.any Spain
italy.any Italy
france.any France
australia.any Australia
turkey.any Turkey
saudi.any Saudi Arabia
vietnam.any Vietnam
singapore.any Singapore
thailand.any Thailand
philippines.any Philippines
malaysia.any Malaysia
indonesia.any Indonesia
korea.any South Korea
canada.any Canada
russia.any Russia
germany.any Germany
india.any India
japan.any Japan

PrivateZone

Parameter name Types Description
zoneId String Zone ID
zoneName String Zone name
recordCount Integer Number of resolution records
createTime String Creation time
updateTime String Update time

Vpc

Parameter name Types Description
vpcId String ID of VPC
vpcName String VPC name
vpcRegion String VPC region

PrivateRecord

Parameter name Types Description
recordId String Resolution record ID
rr String Host record
value String Record value
status String Resolution record status
type String Type of resolution record
ttl Integer Time to Live (TTL), defaulting to 60
priority Integer MX record priority, 0 for other types
description String Description

Previous
API Service Domain Name
Next
Common Headers and Error Responses