Tenant Cloud Domain Name Service VPC DNS Data structure

Data structure

Last Updated At: 2026-10-29 00:01:11

Tag

A tag key-value pair.

Referenced by the following interfaces: CreateVpcDnsDomain

name required NULL allowed type description
Key yes no String Tag key
Example: a
Value yes no String Tag value
Example: tagValue1

VpcInfos

VpcInfos includes the VPC ID and region ID.

Referenced by the following interfaces: BindVpcDnsDomain, DescribeForwardRuleList, DescribeVpcDnsDomainList

name required NULL allowed type description
VpcId yes no Int64 VpcId
Example: 4
RegionId yes no Int64 RegionId
Example: 4
UnVpcId yes no String UnVpcId
Example: vpc-9a5ycnih

BackUpRecordInfo

Backup record.

Referenced by the following interfaces: DescribeVpcDnsRecordList

name required NULL allowed type description
RecordType yes no String Record type. It can only be A or MX.
Example: A
SubDomain yes no String The subdomain name.
Example: www
RecordValue yes no String The record value.
Example: 1.2.3.1
AliveList yes no Array of AliveInfo Liveness status
Example:View

DomainDetail

The domain name details.

Referenced by the following interfaces: DescribeVpcDnsDomainList

name required NULL allowed type description
DomainId no no Int64 Domain ID.
Example: 4
OwnerUin no no Int64 The UIN of the domain name owner.
Example: 909619400
Domain no no String Domain name.
Example: test.com
CreatedOn no no Datetime Creation time.
Example: 2014-08-03 12:00:00
UpdatedOn no no Datetime Last modification time.
Example: 2014-08-03 12:00:00
RecordCount no no Int64 The number of domain name records.
Example: 3
Remark no yes String The domian name remarks.
Example: Remarks
DnsForwardStatus no no String Whether to enable the sub-domain name recursion. Valid values: “ENABLED” and “DISABLED”.
Example: ENABLED
ForwardRuleStatus no no String Whether domain name forwarding is enabled (1: disabled, 0: enabled).
Example: 1
VpcInfos no yes Array of VpcInfos VPC information.
Example:View

RuleListFilters

Query the forwarding rule list.

Referenced by the following interfaces: DescribeForwardRuleList

name required NULL allowed type description
Name yes no String Filter type.
Example: DomainName
Values yes no Array of String Filter value.
Example: test.com

RecordDetail

Record details.

Referenced by the following interfaces: DescribeVpcDnsRecordList

name required NULL allowed type description
RecordId yes no Int64 The record ID.
Example: 4
DomainId yes no Int64 The ID of the domain name corresponding to the record.
Example: 3
SubDomain yes no String The host record.
Example: www
RecordType yes no String Record types: A, AAAA, MX, CNAME, TXT, PTR, SRV, SPF
Example: A
Value yes no String The record value.
Example: 1.1.1.1
Ttl yes no Int64 TTL
Example: 600
Mx yes yes Int64 The MX priority.
Example: 45
Enabled yes no Int64 Whether the record is available. 0: unavailable; 1: available.
Example: 0
Status yes no String Record status, enabled, suspended or other. Valid values: new, pending, enabled, disabled and lock.
Example: enabled
Extra yes yes String Other information.
Example: weight:100
CreatedOn yes no Datetime Creation time of the record.
Example: 2014-08-03 12:00:00
UpdatedOn yes no Datetime Last modification time of the record.
Example: 2014-08-03 12:00:00
Weight yes yes Int64 The weight of the record.
Example: 100
AliveList no yes Array of AliveInfo Liveness status
Example:View
BackUpRecordList no yes Array of BackUpRecordInfo Backup record.
Example:View
EnableValue no no String Record value that is being used currently.
Example: 1.2.3.1
HealthStatus no no Int64 Response parameter of the health status. 0: abnormal; 1: healthy; 2: not enabled; 3: unknown; 4: partially abnormal.
Example: 2
BackUpCam no no Bool Backup record CAM status.
Example: true

RecordListCountInfo

The number of resolution records.

Referenced by the following interfaces: DescribeVpcDnsRecordList

name required NULL allowed type description
AllTotal no no Int64 The total number of domain name records.
Example: 3
RecordTotal no no Int64 The number of returned records.
Example: 3

RecordListFilters

The fuzzy query of the VPC DNS record list.

Referenced by the following interfaces: DescribeVpcDnsRecordList

name required NULL allowed type description
Name yes no String Filter types: SubDomain, Value, RecordId, RecordType
Example: SubDomain
Values yes no Array of String Filter value.
Example: ["www"]

ForwardRuleList

Forwarding rule list.

Referenced by the following interfaces: DescribeForwardRuleList

name required NULL allowed type description
DomainId no no String Domain ID.
Example: 4
DomainName no no String Domain name.
Example: test.com
RuleId no no String Forwarding rule ID
Example: 12
ForwardAddress no no Array of String Forwarding IP address.
Example: ["1.1.1.2:80", "1.2.3.4:80"]
Remark no yes String Description.
Example: This is a remark.
CreatedOn no no Datetime_iso Creation time.
Example: 2014-08-03 12:00:00
UpdatedOn no no Datetime_iso Last modification time.
Example: 2014-08-03 12:00:00
VpcInfos no yes Array of VpcInfos VPC information.
Example:View

BackupRecord

Backup record.

Referenced by the following interfaces: DescribeBackupRecordList

name required NULL allowed type description
RecordId yes no Uint64 Backup record ID.
Example: 421
DomainId yes no Uint64 Domain ID.
Example: 39
SubDomain yes no String The subdomain name.
Example: www
RecordType yes no String The record type.
Example: A
Value yes no String The record value.
Example: 1.2.4.12

DomainCountInfo

Number of domain names.

Referenced by the following interfaces: DescribeVpcDnsDomainList

name required NULL allowed type description
AllTotal no no Int64 Total number of domain names.
Example: 4
DomainTotal no no Int64 The number of returned domain names.
Example: 4

AliveInfo

Liveness information.

Referenced by the following interfaces: DescribeVpcDnsRecordList

name required NULL allowed type description
VpcId yes no String VpcId
Example: 6981
AliveStatus yes no Uint64 Liveness status. 0: unknown; 1: dead; 2: live.
Example: 0

RecordId

Record ID.

Referenced by the following interfaces: CreateVpcDnsRecord

name required NULL allowed type description
RecordId yes no Int64 Record ID.
Example: 3

DomainListFilters

The fuzzy query of VPC DNS domain names.

Referenced by the following interfaces: DescribeExportFileUrl, DescribeVpcDnsDomainList

name required NULL allowed type description
Name yes no String Filter criteria: Domain query Domain parsing domain; VpcInfo VPC ID or instance ID; Account user OwnerUin. Record query: SubDomain subdomain, Value record value, RecordId record ID, RecordType record type
Example: Domain
Values yes no Array of String Filter value.
Example: ["test"]

FailedRecordDetail

Details of the failed file import parse record

Referenced by the following interfaces: ImportRecords

name required NULL allowed type description
Type no yes String The record type.
Example: A
Subdomain no yes String The host record.
Example: www
Weight no yes Uint64 Weight
Example: 100
MX no yes Uint64 MX value
Example: 45
Value no yes String Parse record value
Example: 1.1.1.1
Reason no yes String Reason for addition failure
Example: Record not valid