数据结构
最近更新时间: 2026-10-10 00:12:44
RecordDetail
记录详情
被如下接口引用:DescribePrivateZoneRecordList、DescribeVpcDnsRecordList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RecordId | 是 | 否 | Int64 | 记录ID 示例值: 4 |
| DomainId | 是 | 否 | Int64 | 记录对应的域名ID 示例值: 3 |
| SubDomain | 是 | 否 | String | 主机记录 示例值: www |
| RecordType | 是 | 否 | String | 记录类型:A,AAAA,MX,CNAME,TXT,PTR,SRV,SPF 示例值: A |
| Value | 是 | 否 | String | 记录值 示例值: 1.1.1.1 |
| Ttl | 是 | 否 | Int64 | TTL 示例值: 600 |
| Mx | 是 | 是 | Int64 | MX优先级 示例值: 45 |
| Enabled | 是 | 否 | Int64 | 记录是否可用,0不可用,1可用 示例值: 0 |
| Status | 是 | 否 | String | 记录状态,启用,暂停等:new,pending,enabled,disabled,lock 示例值: enabled |
| Extra | 是 | 是 | String | 其他信息 示例值: weight:100 |
| CreatedOn | 是 | 否 | Datetime | 记录创建时间 示例值: 2014-08-03 12:00:00 |
| CreatedOnIso | 是 | 否 | Datetime_iso | 记录创建时间ISO 示例值: 2024-06-04T15:30:00Z |
| UpdatedOn | 是 | 否 | Datetime | 记录最后修改时间 示例值: 2014-08-03 12:00:00 |
| UpdatedOnIso | 是 | 否 | Datetime_iso | 记录最后修改时间ISO 示例值: 2024-06-04T15:30:00Z |
| Weight | 是 | 是 | Int64 | 记录权重 示例值: 100 |
| AliveList | 否 | 是 | Array of AliveInfo | 存活状态 示例值:查看 |
| BackUpRecordList | 否 | 是 | Array of BackUpRecordInfo | 备用记录 示例值:查看 |
| EnableValue | 否 | 否 | String | 当前在用的记录值 示例值: 1.2.3.1 |
| HealthStatus | 否 | 否 | Int64 | 健康状态返回参数,0 :异常,1:健康;2 :未开通;3 :未知; 4:部分异常 示例值: 2 |
| BackUpCam | 否 | 否 | Bool | 备用记录cam状态 示例值: true |
PrivateZoneRecord
私有域信息
被如下接口引用:DescribePrivateZoneRecordList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Extra | 是 | 是 | String | 附加信息 示例值: 附加信息内容 |
| Enabled | 否 | 否 | Uint64 | 0暂停,1启用 示例值: 是否暂停 |
| Remark | 否 | 否 | String | 备注 示例值: 这是备注 |
| ZoneId | 是 | 否 | String | 私有域id: zone-xxxxxxxx 示例值: zone-pckv03qy |
| SubDomain | 是 | 否 | String | 子域名 示例值: www |
| RecordType | 是 | 否 | String | 记录类型,可选的记录类型为:"A", "AAAA", "CNAME", "MX", "TXT", "PTR" 示例值: A |
| RecordValue | 是 | 否 | String | 记录值 示例值: 1.1.1.1 |
| MX | 否 | 否 | Int64 | MX优先级:记录类型为MX时必填。取值范围:5,10,15,20,30,40,50 示例值: 0 |
| Status | 是 | 否 | String | 记录状态:ENABLED 示例值: enabled |
| RecordId | 是 | 否 | String | 记录id 示例值: 12076 |
| TTL | 是 | 否 | Int64 | 记录缓存时间,数值越小生效越快,取值1-86400s, 默认 600 示例值: 300 |
| Weight | 是 | 是 | Int64 | 记录权重,值为1-100 示例值: null |
| CreatedOn | 是 | 否 | Datetime | 记录创建时间 示例值: 2021-09-07 19:00:58 |
| CreatedOnIso | 否 | 否 | Datetime_iso | 创建时间 示例值: 2026-03-18T14:15:07+08:00 |
| UpdatedOn | 是 | 否 | Datetime | 记录更新时间 示例值: 2021-09-07 19:00:58 |
| VpcInfos | 否 | 是 | Array of VpcInfos | VPC信息 示例值:查看 |
| UpdatedOnIso | 否 | 否 | Datetime_iso | 记录更新时间 示例值: 2026-03-18T14:15:07+08:00 |
AccountVpcInfoOutput
关联的VPC出参
被如下接口引用:BindVpcDnsDomain、DescribePrivateZone、DescribePrivateZoneList、DescribeVpcDnsDomainList、ModifyPrivateZoneVpc
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UniqVpcId | 是 | 否 | String | vpcid 示例值: vpc-wdskdss1 |
| Region | 是 | 否 | String | 地域 示例值: ap-region |
| Uin | 是 | 否 | String | 关联账户的uin 示例值: 12345678 |
FlowUsage
流量包用量
被如下接口引用:DescribeDashboard
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| FlowType | 是 | 否 | String | 流量包类型:ZONE 私有域;TRAFFIC 解析流量包 示例值: zone |
| TotalQuantity | 是 | 否 | Int64 | 流量包总额度 示例值: 100 |
| AvailableQuantity | 是 | 否 | Int64 | 流量包可用额度 示例值: 100 |
DomainCountInfo
域名数量
被如下接口引用:DescribePrivateZoneList、DescribeVpcDnsDomainList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AllTotal | 否 | 否 | Int64 | 全部域名数量 示例值: 4 |
| DomainTotal | 否 | 否 | Int64 | 返回的域名数量 示例值: 4 |
RecordListCountInfo
解析记录数量
被如下接口引用:DescribePrivateZoneRecordList、DescribeVpcDnsRecordList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AllTotal | 否 | 否 | Int64 | 该域名的记录总数量 示例值: 3 |
| RecordTotal | 否 | 否 | Int64 | 本次返回的记录数量 示例值: 3 |
AliveInfo
存活信息
被如下接口引用:DescribePrivateZoneRecordList、DescribeVpcDnsRecordList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | VpcId 示例值: 6981 |
| AliveStatus | 是 | 否 | Uint64 | 存活状态0 未知, 1死亡, 2 存活 示例值: 0 |
AuditLog
操作日志
被如下接口引用:DescribeAuditLog
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Resource | 是 | 否 | String | 日志类型 示例值: all |
| Metric | 是 | 否 | String | 日志表名 示例值: request_count |
| TotalCount | 是 | 否 | Int64 | 日志总数 示例值: 12548 |
| DataSet | 是 | 否 | Array of AuditLogInfo | 日志列表 示例值:查看 |
RecordsInfoStatus
批量添加解析记录结果
被如下接口引用:DescribeCreateRecordListResult
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| MX | 是 | 是 | Int64 | MX优先级:记录类型为MX时必填。取值范围:5,10,15,20,30,40,50 示例值: 15 |
| Status | 是 | 是 | Int64 | 是否添加成功:0是失败,1是成功 示例值: 1 |
| Message | 是 | 是 | String | 若status为0,则此处为失败原因描述 示例值: 与已有解析记录冲突 |
| RecordType | 是 | 否 | String | 记录类型,可选的记录类型为:"A", "AAAA", "CNAME", "MX", "TXT", "PTR" 示例值: CNAME |
| SubDomain | 是 | 否 | String | 子域名,例如 "www", "m", "@" 示例值: www |
| RecordValue | 是 | 否 | String | 记录值,例如 IP:192.168.10.2,CNAME:cname.test.com.,MX:mail.test.com. 示例值: 8.8.8.8 |
| Weight | 是 | 是 | Int64 | 记录权重,值为1-100 示例值: 100 |
| TTL | 是 | 是 | Int64 | 记录缓存时间,数值越小生效越快,取值1-86400s, 默认 600 示例值: 600 |
RuleListFilters
转发规则列表查询
被如下接口引用:DescribeForwardRuleList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | 过滤类型 示例值: DomainName |
| Values | 是 | 否 | Array of String | 过滤值 示例值: test.com |
VpcInfo
Vpc信息
被如下接口引用:BindVpcDnsDomain、CheckDomainVpcConflict、CreatePrivateZone、DescribePrivateZone、DescribePrivateZoneList、DescribeVpcDnsDomainList、ModifyPrivateZoneVpc
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UniqVpcId | 是 | 否 | String | VpcId 示例值: vpc-dsd8ulf |
| Region | 是 | 否 | String | Vpc所属地区: ap-region, ap-region2 示例值: ap-region |
VpcInfos
VpcInfos包含VpcId与对应的RegionId
被如下接口引用:BindVpcDnsDomain、DescribePrivateZoneList、DescribePrivateZoneRecordList、DescribeVpcDnsDomainList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | Int64 | VpcId 示例值: 4 |
| RegionId | 是 | 否 | Int64 | RegionId 示例值: 4 |
| UnVpcId | 是 | 否 | String | UnVpcId 示例值: vpc-9a5ycnih |
TagInfo
标签
被如下接口引用:CreatePrivateZone、DescribePrivateZone、DescribePrivateZoneList、DescribeVpcDnsDomainList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagValue | 是 | 否 | String | 标签值 示例值: value1 |
| TagKey | 是 | 否 | String | 标签键 示例值: key1 |
ForwardRuleList
转发规则列表
被如下接口引用:DescribeForwardRuleList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DomainId | 否 | 否 | String | 域名id 示例值: 4 |
| DomainName | 否 | 否 | String | 域名 示例值: test.com |
| RuleId | 否 | 否 | String | 转发规则ID 示例值: 12 |
| ForwardAddress | 否 | 否 | Array of String | 转发地址IP 示例值: ["1.1.1.2:80", "1.2.3.4:80"] |
| Remark | 否 | 是 | String | 备注 示例值: 这是备注 |
| CreatedOn | 否 | 否 | Datetime_iso | 创建时间 示例值: 2014-08-03 12:00:00 |
| UpdatedOn | 否 | 否 | Datetime_iso | 最后修改时间 示例值: 2014-08-03 12:00:00 |
| VpcInfos | 否 | 否 | Array of VpcInfoList | VPC信息 示例值:查看 |
FailedRecordDetail
文件导入解析记录失败数据详情
被如下接口引用:ImportRecords
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Type | 否 | 是 | String | 记录类型 示例值: A |
| Subdomain | 否 | 是 | String | 主机记录 示例值: www |
| Weight | 否 | 是 | Uint64 | 权重 示例值: 100 |
| MX | 否 | 是 | Uint64 | MX值 示例值: 45 |
| Value | 否 | 是 | String | 解析记录值 示例值: 1.1.1.1 |
| Reason | 否 | 是 | String | 添加失败的原因 示例值: Record not valid |
BackUpRecordInfo
备用记录
被如下接口引用:DescribePrivateZoneRecordList、DescribeVpcDnsRecordList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RecordType | 是 | 否 | String | 记录类型(只能是A或MX) 示例值: A |
| SubDomain | 是 | 否 | String | 子域名 示例值: www |
| RecordValue | 是 | 否 | String | 记录值 示例值: 1.2.3.1 |
| AliveList | 是 | 否 | Array of AliveInfo | 存活状态 示例值:查看 |
AccountVpcInfo
私有域解析账号Vpc信息
被如下接口引用:CheckDomainVpcConflict、CreatePrivateZone、ModifyPrivateZoneVpc
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcName | 否 | 否 | String | vpc资源名称 示例值: testname |
| UniqVpcId | 是 | 否 | String | VpcId 示例值: vpc-hgje12gt |
| Region | 是 | 否 | String | Vpc所属的地区 示例值: ap-region |
| Uin | 是 | 否 | String | Vpc所属账号 示例值: 10005630010 |
VpcInfoList
VpcInfoList
被如下接口引用:DescribeForwardRuleList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| vpc_id | 否 | 否 | Int64 | VpcId 示例值: 4 |
| region_id | 否 | 否 | Int64 | RegionId 示例值: 50001 |
| un_vpc_id | 否 | 否 | String | UnVpcId 示例值: vpc-9a5ycnih |
RecordId
记录Id
被如下接口引用:CreateVpcDnsRecord
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RecordId | 是 | 否 | Int64 | 记录id 示例值: 3 |
RecordsInfo
私有域解析记录信息
被如下接口引用:CreatePrivateZoneRecordList、DescribeCreateRecordListResult
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SubDomain | 是 | 否 | String | 子域名,例如 "www", "m", "@" 示例值: www |
| RecordValue | 是 | 否 | String | 记录值,例如 IP:192.168.10.2,CNAME:cname.test.com.,MX:mail.test.com. 示例值: 8.8.8.8 |
| Weight | 否 | 是 | Int64 | 记录权重,值为1-100 示例值: 100 |
| TTL | 否 | 是 | Int64 | 记录缓存时间,数值越小生效越快,取值1-86400s, 默认 600 示例值: 600 |
| MX | 否 | 是 | Int64 | MX优先级:记录类型为MX时必填。取值范围:5,10,15,20,30,40,50 示例值: 15 |
| RecordType | 是 | 否 | String | 记录类型,可选的记录类型为:"A", "AAAA", "CNAME", "MX", "TXT", "PTR" 示例值: CNAME |
RecordsInfoResult
批量添加解析记录返回结果
被如下接口引用:DescribeCreateRecordListResult
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ZoneId | 是 | 否 | String | 私有域ID 示例值: zone-12345567 |
| Domain | 是 | 否 | String | 私有域域名 示例值: 1.com |
| RecordsStatus | 是 | 否 | Array of RecordsInfoStatus | 私有域解析记录创建结果 示例值:查看 |
| Remark | 是 | 是 | String | 备注 示例值: 无 |
ConflictVpc
返回相同域名下冲突的vpc列表
被如下接口引用:CheckDomainVpcConflict
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| UniqVpcId | 否 | 是 | String | uniqVpcId 示例值: vpc-wdskdss1 |
| ZoneId | 否 | 是 | String | zoneId 示例值: zone-b3eiq8gk |
Tag
表示一个标签键值对
被如下接口引用:CreateVpcDnsDomain
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Key | 是 | 否 | String | 标签键 示例值: a |
| Value | 是 | 否 | String | 标签值 示例值: tagValue1 |
AuditLogInfo
日志详情
被如下接口引用:DescribeAuditLog
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| OperatorUin | 是 | 否 | String | 操作人uin 示例值: 10020023500 |
| Content | 是 | 否 | String | 日志内容 示例值: 修改私有域 aabc.com(zone-nseuk90) |
| Date | 是 | 否 | Datetime | 时间 示例值: 2024-12-11 19:00:00 |
| DataIso | 否 | 否 | Datetime_iso | 时间 示例值: 2026-03-02T14:32:21+08:00 |
BackupRecord
备用记录
被如下接口引用:DescribeBackupRecordList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RecordId | 是 | 否 | Uint64 | 备用记录ID 示例值: 421 |
| DomainId | 是 | 否 | Uint64 | 域名id 示例值: 39 |
| SubDomain | 是 | 否 | String | 子域名 示例值: www |
| RecordType | 是 | 否 | String | 记录类型 示例值: A |
| Value | 是 | 否 | String | 记录值 示例值: 1.2.4.12 |
PrivateZone
私有域信息
被如下接口引用:DescribePrivateZone、DescribePrivateZoneList、DescribeVpcDnsDomainList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ZoneId | 是 | 否 | String | 私有域id: zone-xxxxxxxx 示例值: zone-xxxxxxxx |
| Domain | 是 | 否 | String | 私有域名 示例值: test.com |
| Remark | 否 | 否 | String | 备注 示例值: 备注 |
| Status | 是 | 否 | String | 私有域绑定VPC状态,未关联vpc:SUSPEND,已关联VPC:ENABLED ,关联VPC失败:FAILED 示例值: ENABLED |
| ForwardRuleName | 否 | 否 | String | 转发规则名称 示例值: 转发规则名 |
| EndPointName | 是 | 是 | String | 终端节点名称 示例值: 终端节点名 |
| DeletedVpcSet | 否 | 否 | Array of VpcInfo | 已删除的vpc 示例值:查看 |
| RecordCount | 是 | 否 | Int64 | 记录数 示例值: 0 |
| VpcSet | 是 | 否 | Array of VpcInfo | 绑定的Vpc列表 示例值:查看 |
| DnsForwardStatus | 是 | 否 | String | 域名递归解析状态:开通:ENABLED, 关闭,DISABLED 示例值: DISABLED |
| CnameSpeedupStatus | 是 | 否 | String | CNAME加速状态:开通:ENABLED, 关闭,DISABLED 示例值: DISABLED |
| OwnerUin | 是 | 否 | Int64 | 域名所有者uin 示例值: 444353877 |
| ForwardRuleType | 否 | 否 | String | 转发规则类型:云上到云下,DOWN;云下到云上,UP,目前只支持DOWN 示例值: DOWN |
| CreatedOn | 是 | 否 | Datetime | 创建时间 示例值: 2020-12-26 18:51:20 |
| CreatedOnIso | 是 | 否 | Datetime_iso | 记录创建时间ISO 示例值: 2024-06-04T15:30:00Z |
| UpdatedOn | 是 | 否 | Datetime | 修改时间 示例值: 2020-12-26 18:51:20 |
| UpdatedOnIso | 是 | 否 | Datetime_iso | 记录最后修改时间ISO 示例值: 2024-06-04T15:30:00Z |
| Tags | 是 | 否 | Array of TagInfo | 标签键值对集合 示例值:查看 |
| AccountVpcSet | 否 | 否 | Array of AccountVpcInfoOutput | 绑定的关联账号的vpc列表 示例值:查看 |
| IsCustomTld | 否 | 否 | Bool | 是否自定义TLD 示例值: false |
| ForwardAddress | 否 | 否 | String | 转发的地址 示例值: 10.0.23.41:53,10.0.23.42:53, |
| DomainId | 否 | 否 | Uint64 | 域名id 示例值: 111 |
DomainDetail
域名详情
被如下接口引用:DescribePrivateZoneList、DescribeVpcDnsDomainList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DomainId | 否 | 否 | Int64 | 域名id 示例值: 4 |
| OwnerUin | 否 | 否 | Int64 | 域名所有者uin 示例值: 909619400 |
| Domain | 否 | 否 | String | 域名 示例值: test.com |
| CreatedOn | 否 | 否 | Datetime | 创建时间 示例值: 2014-08-03 12:00:00 |
| CreatedOnIso | 否 | 否 | Datetime_iso | 创建时间ISO 示例值: 2024-06-04T15:30:00Z |
| UpdatedOn | 否 | 否 | Datetime | 最后修改时间 示例值: 2014-08-03 12:00:00 |
| UpdatedOnIso | 否 | 否 | Datetime_iso | 最后修改时间ISO 示例值: 2024-06-04T15:30:00Z |
| RecordCount | 否 | 否 | Int64 | 域名记录数量 示例值: 3 |
| Remark | 否 | 是 | String | 域名备注 示例值: 域名备注 |
| DnsForwardStatus | 否 | 否 | String | 是否开启子域名递归(“ENABLED”和“DISABLED”) 示例值: ENABLED |
| ForwardRuleStatus | 否 | 否 | String | 是否开启域名转发(1:关闭,0:开启) 示例值: 1 |
| VpcInfos | 否 | 是 | Array of VpcInfos | VPC信息 示例值:查看 |
FailedRecord
导入失败的条目
被如下接口引用:DescribeImportRecordsResult
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Type | 是 | 否 | String | 记录类型 示例值: A |
| Record | 是 | 否 | String | 主机记录 示例值: www |
| Value | 是 | 否 | String | 记录值 示例值: 1.1.1.1 |
| MX | 是 | 是 | Int64 | MX优先级 示例值: 5 |
| TTL | 是 | 否 | Int64 | 过期时间 示例值: 10 |
| Reason | 是 | 否 | String | 导入失败原因 示例值: Record not valid |
ZoneInfo
创建私有域成功后返回私有域信息
被如下接口引用:DescribeCreateZoneListResult
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Domain | 是 | 否 | String | 私有域域名 示例值: 1.com |
| Reason | 是 | 是 | String | 失败原因 示例值: 无 |
| ZoneId | 是 | 是 | String | 私有域ID 示例值: zone-1233lskd |
DomainListFilters
vpcdns域名列表模糊查询
被如下接口引用:DescribeExportFileUrl、DescribeVpcDnsDomainList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | 过滤条件: 域名查询Domain解析域; VpcInfoVPC ID或者实例ID; Account用户OwnerUin。记录查询:SubDomain子域名,Value记录值,RecordId记录ID,RecordType记录类型示例值: Domain |
| Values | 是 | 否 | Array of String | 过滤值 示例值: ["test"] |
RecordListFilters
vpcdns记录列表模糊查询
被如下接口引用:DescribeVpcDnsRecordList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | 过滤类型:SubDomain,Value,RecordId,RecordType 示例值: SubDomain |
| Values | 是 | 否 | Array of String | 过滤值 示例值: ["www"] |
Filter
筛选参数
被如下接口引用:DescribeAuditLog、DescribePrivateZoneList、DescribePrivateZoneRecordList
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | 参数名 示例值: Domain |
| Values | 是 | 否 | Array of String | 参数值数组 示例值: test.com |