DNSPod

API 文档
诚邀爱技术、爱分享的你，成为文档内容共建者> HOT
文档中心 > DNSPod > API 文档 > 数据结构

数据结构

最近更新时间：2022-11-25 06:30:07

我的收藏

本页目录：

AddRecordBatch

批量添加的记录

被如下接口引用：CreateRecordBatch。

名称 类型 必选 描述
RecordType String 是 记录类型, 详见 DescribeRecordType 接口。
Value String 是 记录值。
SubDomain String 否 子域名(主机记录)，默认为@。
RecordLine String 否 解析记录的线路，详见 DescribeRecordLineList 接口，RecordLine和RecordLineId都未填时，默认为「默认」线路。
RecordLineId String 否 解析记录的线路 ID，RecordLine和RecordLineId都有时，系统优先取 RecordLineId。
Weight Integer 否 记录权重值(暂未支持)。
注意：此字段可能返回 null，表示取不到有效值。
MX Integer 否 记录的 MX 记录值，非 MX 记录类型，默认为 0，MX记录则必选。
TTL Integer 否 记录的 TTL 值，默认600。
Enabled Integer 否 记录状态(暂未支持)。0表示禁用，1表示启用。默认启用。
Remark String 否 记录备注(暂未支持)。

BatchRecordInfo

批量任务中的记录信息

被如下接口引用：DescribeBatchTask, ModifyRecordBatch。

名称 类型 描述
RecordId Integer 记录 ID
注意：此字段可能返回 null，表示取不到有效值。
SubDomain String 子域名(主机记录)。
注意：此字段可能返回 null，表示取不到有效值。
RecordType String 记录类型, 详见 DescribeRecordType 接口
注意：此字段可能返回 null，表示取不到有效值。
RecordLine String 解析记录的线路，详见 DescribeRecordLineList 接口
注意：此字段可能返回 null，表示取不到有效值。
Value String 记录值
注意：此字段可能返回 null，表示取不到有效值。
TTL Integer 记录的 TTL 值
注意：此字段可能返回 null，表示取不到有效值。
Status String 记录添加状态
注意：此字段可能返回 null，表示取不到有效值。
Operation String 操作类型
注意：此字段可能返回 null，表示取不到有效值。
ErrMsg String 错误信息
注意：此字段可能返回 null，表示取不到有效值。
Id Integer 此条记录在列表中的ID
Enabled Integer 记录生效状态
注意：此字段可能返回 null，表示取不到有效值。
MX Integer 记录的MX权重
注意：此字段可能返回 null，表示取不到有效值。

CreateDomainBatchDetail

批量添加域名返回结构

被如下接口引用：CreateDomainBatch。

名称 类型 描述
RecordList Array of CreateDomainBatchRecord 见RecordInfoBatch
注意：此字段可能返回 null，表示取不到有效值。
Id Integer 任务编号
Domain String 域名
注意：此字段可能返回 null，表示取不到有效值。
DomainGrade String 域名等级
注意：此字段可能返回 null，表示取不到有效值。
ErrMsg String 错误信息
注意：此字段可能返回 null，表示取不到有效值。
Status String 该条任务运行状态
注意：此字段可能返回 null，表示取不到有效值。
Operation String 操作类型
注意：此字段可能返回 null，表示取不到有效值。

CreateDomainBatchRecord

批量添加域名任务中的记录信息

被如下接口引用：CreateDomainBatch。

名称 类型 描述
SubDomain String 子域名(主机记录)。
注意：此字段可能返回 null，表示取不到有效值。
RecordType String 记录类型, 详见 DescribeRecordType 接口
注意：此字段可能返回 null，表示取不到有效值。
RecordLine String 解析记录的线路，详见 DescribeRecordLineList 接口
注意：此字段可能返回 null，表示取不到有效值。
Value String 记录值
注意：此字段可能返回 null，表示取不到有效值。
TTL Integer 记录的 TTL 值
注意：此字段可能返回 null，表示取不到有效值。
Status String 记录添加状态
注意：此字段可能返回 null，表示取不到有效值。
Operation String 操作类型
注意：此字段可能返回 null，表示取不到有效值。
ErrMsg String 错误信息
注意：此字段可能返回 null，表示取不到有效值。
Id Integer 此条记录在列表中的ID

CreateRecordBatchDetail

批量添加记录返回结构

被如下接口引用：CreateRecordBatch。

名称 类型 描述
RecordList Array of CreateRecordBatchRecord 见RecordInfoBatch
注意：此字段可能返回 null，表示取不到有效值。
Id Integer 任务编号
Domain String 域名
注意：此字段可能返回 null，表示取不到有效值。
DomainGrade String 域名等级
注意：此字段可能返回 null，表示取不到有效值。
ErrMsg String 错误信息
注意：此字段可能返回 null，表示取不到有效值。
Status String 该条任务运行状态
注意：此字段可能返回 null，表示取不到有效值。
Operation String 操作类型
注意：此字段可能返回 null，表示取不到有效值。
DomainId Integer 域名ID
注意：此字段可能返回 null，表示取不到有效值。

CreateRecordBatchRecord

批量添加记录任务中的记录信息

被如下接口引用：CreateRecordBatch。

名称 类型 描述
SubDomain String 子域名(主机记录)。
注意：此字段可能返回 null，表示取不到有效值。
RecordType String 记录类型, 详见 DescribeRecordType 接口
注意：此字段可能返回 null，表示取不到有效值。
RecordLine String 解析记录的线路，详见 DescribeRecordLineList 接口
注意：此字段可能返回 null，表示取不到有效值。
Value String 记录值
注意：此字段可能返回 null，表示取不到有效值。
TTL Integer 记录的 TTL 值
注意：此字段可能返回 null，表示取不到有效值。
Status String 记录添加状态
注意：此字段可能返回 null，表示取不到有效值。
Operation String 操作类型
注意：此字段可能返回 null，表示取不到有效值。
ErrMsg String 错误信息
注意：此字段可能返回 null，表示取不到有效值。
Id Integer 此条记录在列表中的ID
MX Integer 记录的MX权重
注意：此字段可能返回 null，表示取不到有效值。

Deals

子订单号列表

被如下接口引用：CreateDeal。

名称 类型 描述
DealId String 子订单ID
DealName String 子订单号

DescribeBatchTaskDetail

查看任务详情返回结构

被如下接口引用：DescribeBatchTask。

名称 类型 描述
RecordList Array of BatchRecordInfo 见BatchRecordInfo
注意：此字段可能返回 null，表示取不到有效值。
Id Integer 任务编号
Domain String 域名
注意：此字段可能返回 null，表示取不到有效值。
DomainGrade String 域名等级
注意：此字段可能返回 null，表示取不到有效值。
ErrMsg String 错误信息
注意：此字段可能返回 null，表示取不到有效值。
Status String 该条任务运行状态
注意：此字段可能返回 null，表示取不到有效值。
Operation String 操作类型
注意：此字段可能返回 null，表示取不到有效值。
DomainId Integer 域名ID
注意：此字段可能返回 null，表示取不到有效值。

DomainAliasAnalyticsItem

域名别名解析量统计信息

被如下接口引用：DescribeDomainAnalytics。

名称 类型 描述
Info DomainAnalyticsInfo 域名解析量统计查询信息
Data Array of DomainAnalyticsDetail 当前统计维度解析量小计

DomainAliasInfo

域名别名信息

被如下接口引用：DescribeDomainAliasList。

名称 类型 描述
Id Integer 域名别名ID
DomainAlias String 域名别名

DomainAnalyticsDetail

当前统计维度解析量小计

被如下接口引用：DescribeDomainAnalytics, DescribeSubdomainAnalytics。

名称 类型 描述
Num Integer 当前统计维度解析量小计
DateKey String 按天统计时，为统计日期
HourKey Integer 按小时统计时，为统计的当前时间的小时数(0-23)，例：HourKey为23时，统计周期为22点-23点的解析量
注意：此字段可能返回 null，表示取不到有效值。

DomainAnalyticsInfo

域名解析量统计查询信息

被如下接口引用：DescribeDomainAnalytics。

名称 类型 描述
DnsFormat String DATE:按天维度统计 HOUR:按小时维度统计
DnsTotal Integer 当前统计周期解析量总计
Domain String 当前查询的域名
StartDate String 当前统计周期开始时间
EndDate String 当前统计周期结束时间

DomainCountInfo

列表页分页统计信息

被如下接口引用：DescribeDomainList。

名称 类型 描述
DomainTotal Integer 符合条件的域名数量
AllTotal Integer 用户可以查看的所有域名数量
MineTotal Integer 用户账号添加的域名数量
ShareTotal Integer 共享给用户的域名数量
VipTotal Integer 付费域名数量
PauseTotal Integer 暂停的域名数量
ErrorTotal Integer dns设置错误的域名数量
LockTotal Integer 锁定的域名数量
SpamTotal Integer 封禁的域名数量
VipExpire Integer 30天内即将到期的域名数量
ShareOutTotal Integer 分享给其它人的域名数量
GroupTotal Integer 指定分组内的域名数量

DomainCreateInfo

域名信息（创建域名时返回）

被如下接口引用：CreateDomain。

名称 类型 描述
Id Integer 域名ID
Domain String 域名
Punycode String 域名的punycode
GradeNsList Array of String 域名的NS列表

DomainInfo

域名详情

被如下接口引用：DescribeDomain。

名称 类型 描述
DomainId Integer 域名ID
Status String 域名状态
Grade String 域名套餐等级
GroupId Integer 域名分组ID
IsMark String 是否星标域名
TTL Integer TTL(DNS记录缓存时间)
CnameSpeedup String cname加速启用状态
Remark String 域名备注
注意：此字段可能返回 null，表示取不到有效值。
Punycode String 域名Punycode
DnsStatus String 域名DNS状态
DnspodNsList Array of String 域名的NS列表
Domain String 域名
GradeLevel Integer 域名等级代号
UserId Integer 域名所属的用户ID
IsVip String 是否为付费域名
Owner String 域名所有者的账号
GradeTitle String 域名等级的描述
CreatedOn Timestamp 域名创建时间
UpdatedOn Timestamp 最后操作时间
Uin String 腾讯云账户Uin
ActualNsList Array of String 域名实际使用的NS列表
注意：此字段可能返回 null，表示取不到有效值。
RecordCount Integer 域名的记录数量
OwnerNick String 域名所有者的账户昵称
注意：此字段可能返回 null，表示取不到有效值。

DomainListItem

域名列表元素

被如下接口引用：DescribeDomainList。

名称 类型 描述
DomainId Integer 系统分配给域名的唯一标识
Name String 域名的原始格式
Status String 域名的状态，正常：ENABLE，暂停：PAUSE，封禁：SPAM
TTL Integer 域名默认的解析记录默认TTL值
CNAMESpeedup String 是否开启CNAME加速，开启：ENABLE，未开启：DISABLE
DNSStatus String DNS 设置状态，错误：DNSERROR，正常：空字符串
Grade String 域名的套餐等级代码
GroupId Integer 域名所属的分组Id
SearchEnginePush String 是否开启搜索引擎推送优化，是：YES，否：NO
Remark String 域名备注说明
Punycode String 经过punycode编码后的域名格式
EffectiveDNS Array of String 系统为域名分配的有效DNS
GradeLevel Integer 域名套餐等级对应的序号
GradeTitle String 套餐名称
IsVip String 是否是付费套餐
VipStartAt Timestamp 付费套餐开通时间
VipEndAt Timestamp 付费套餐到期时间
VipAutoRenew String 域名是否开通VIP自动续费，是：YES，否：NO，默认：DEFAULT
RecordCount Integer 域名下的记录数量
CreatedOn Timestamp 域名添加时间
UpdatedOn Timestamp 域名更新时间
Owner String 域名所属账号

DomainShareInfo

域名共享信息

被如下接口引用：DescribeDomainShareInfo。

名称 类型 描述
ShareTo String 域名共享对象的账号
Mode String 共享模式，“rw”：可读写。 “r”:：只读
Status String 共享状态“enabled”：共享成功。“pending”：共享到的账号不存在, 等待注册

GroupInfo

域名分组列表

被如下接口引用：DescribeDomainGroupList。

名称 类型 描述
GroupId Integer 分组ID
GroupName String 分组名称
GroupType String 分组类型
Size Integer 该分组中域名个数

KeyValue

键值对

被如下接口引用：ModifyRecordFields。

名称 类型 必选 描述
Key String 是 键
Value String 否 值
注意：此字段可能返回 null，表示取不到有效值。

LineGroupInfo

线路分组信息

被如下接口引用：DescribeRecordLineList。

名称 类型 描述
LineId String 线路分组ID
Name String 线路分组名称
Type String 分组类型
LineList Array of String 线路分组包含的线路列表

LineInfo

解析线路信息

被如下接口引用：DescribeRecordLineList。

名称 类型 描述
Name String 线路名称
LineId String 线路ID

LockInfo

域名锁定信息

被如下接口引用：ModifyDomainLock。

名称 类型 描述
DomainId Integer 域名 ID
LockCode String 域名解锁码
LockEnd Date 域名自动解锁日期

ModifyRecordBatchDetail

批量添加记录返回结构

被如下接口引用：ModifyRecordBatch。

名称 类型 描述
RecordList Array of BatchRecordInfo 见RecordInfoBatchModify
注意：此字段可能返回 null，表示取不到有效值。
Id Integer 任务编号
Domain String 域名
注意：此字段可能返回 null，表示取不到有效值。
DomainGrade String 域名等级
注意：此字段可能返回 null，表示取不到有效值。
ErrMsg String 错误信息
注意：此字段可能返回 null，表示取不到有效值。
Status String 该条任务运行状态
注意：此字段可能返回 null，表示取不到有效值。
Operation String 操作类型
注意：此字段可能返回 null，表示取不到有效值。
DomainId Integer 域名ID
注意：此字段可能返回 null，表示取不到有效值。

PurviewInfo

域名权限项

被如下接口引用：DescribeDomainPurview。

名称 类型 描述
Name String 权限名称
Value String 权限值

RecordCountInfo

查询记录列表的数量统计信息

被如下接口引用：DescribeRecordList。

名称 类型 描述
SubdomainCount Integer 子域名数量
ListCount Integer 列表返回的记录数
TotalCount Integer 总的记录数

RecordGroupInfo

解析记录分组信息

被如下接口引用：DescribeRecordGroupList。

名称 类型 描述
GroupId Integer 分组 ID
GroupName String 分组名称
GroupType String 分组类型：system-系统；user-用户

RecordInfo

记录信息

被如下接口引用：DescribeRecord。

名称 类型 描述
Id Integer 记录 ID 。
SubDomain String 子域名(主机记录)。
RecordType String 记录类型, 详见 DescribeRecordType 接口。
RecordLine String 解析记录的线路，详见 DescribeRecordLineList 接口。
RecordLineId String 解析记录的线路 ID ，详见 DescribeRecordLineList 接口。
Value String 记录值。
Weight Integer 记录权重值。
注意：此字段可能返回 null，表示取不到有效值。
MX Integer 记录的 MX 记录值，非 MX 记录类型，默认为 0。
TTL Integer 记录的 TTL 值。
Enabled Integer 记录状态。0表示禁用，1表示启用。
MonitorStatus String 该记录的 D 监控状态。
"Ok" : 服务器正常。
"Warn" : 该记录有报警, 服务器返回 4XX。
"Down" : 服务器宕机。
"" : 该记录未开启 D 监控。
Remark String 记录的备注。
注意：此字段可能返回 null，表示取不到有效值。
UpdatedOn Timestamp 记录最后更新时间。
DomainId Integer 域名 ID 。

RecordListItem

记录列表元素

被如下接口引用：DescribeRecordList。

名称 类型 描述
RecordId Integer 记录Id
Value String 记录值
Status String 记录状态，启用：ENABLE，暂停：DISABLE
UpdatedOn Timestamp 更新时间
Name String 主机名
Line String 记录线路
LineId String 线路Id
Type String 记录类型
Weight Integer 记录权重，用于负载均衡记录
注意：此字段可能返回 null，表示取不到有效值。
MonitorStatus String 记录监控状态，正常：OK，告警：WARN，宕机：DOWN，未设置监控或监控暂停则为空
Remark String 记录备注说明
TTL Integer 记录缓存时间
MX Integer MX值，只有MX记录有
注意：此字段可能返回 null，表示取不到有效值。

SnapshotConfig

域名解析快照配置

被如下接口引用：DescribeSnapshotConfig。

名称 类型 描述
Config String 配置类型：空字符串-不备份，half_hour-每半小时，hourly-每小时，daily-每天，monthly-每月
CreatedOn String 添加时间
DomainId String 所属域名 ID
Id String 配置 ID
SnapshotCount Integer 快照数量
Status String 状态：enable-启用，disable-禁用
UpdatedOn String 更新时间

SnapshotInfo

快照信息

被如下接口引用：DescribeSnapshotList。

名称 类型 描述
CosUrl String 快照的对象存储地址
CreatedOn String 添加时间
Domain String 所属域名
Id String 快照记录 ID
RecordCount String 域名解析记录数
Status String 状态：normal-正常，create-备份中

SnapshotPageInfo

快照列表分页信息

被如下接口引用：DescribeSnapshotList。

名称 类型 描述
Total Integer 快照总数

SnapshotRecord

快照解析记录

被如下接口引用：CheckRecordSnapshotRollback, CheckSnapshotRollback, DescribeRecordSnapshotRollbackResult, DescribeSnapshotRollbackResult, RollbackRecordSnapshot。

名称 类型 必选 描述
SubDomain String 是 子域名
RecordType String 是 记录类型
RecordLine String 是 解析线路
Value String 是 解析值
TTL String 是 TTL(秒)
RecordId String 否 解析记录 ID
MX String 否 MX优先级
注意：此字段可能返回 null，表示取不到有效值。

SubdomainAliasAnalyticsItem

子域名别名解析量统计信息

被如下接口引用：DescribeSubdomainAnalytics。

名称 类型 描述
Info SubdomainAnalyticsInfo 子域名解析量统计查询信息
Data Array of DomainAnalyticsDetail 当前统计维度解析量小计

SubdomainAnalyticsInfo

子域名解析量统计查询信息

被如下接口引用：DescribeSubdomainAnalytics。

名称 类型 描述
DnsFormat String DATE:按天维度统计 HOUR:按小时维度统计
DnsTotal Integer 当前统计周期解析量总计
Domain String 当前查询的域名
StartDate String 当前统计周期开始时间
EndDate String 当前统计周期结束时间
Subdomain String 当前统计的子域名

UserInfo

用户信息

被如下接口引用：DescribeUserDetail。

名称 类型 描述
Nick String 用户昵称
Id Integer 用户ID
Email String 用户账号, 邮箱格式
Status String 账号状态：”enabled”: 正常；”disabled”: 被封禁
Telephone String 电话号码
EmailVerified String 邮箱是否通过验证：”yes”: 通过；”no”: 未通过
TelephoneVerified String 手机是否通过验证：”yes”: 通过；”no”: 未通过
UserGrade String 账号等级, 按照用户账号下域名等级排序, 选取一个最高等级为账号等级, 具体对应情况参见域名等级。
RealName String 用户名称, 企业用户对应为公司名称
WechatBinded String 是否绑定微信：”yes”: 通过；”no”: 未通过
Uin Integer 用户UIN
FreeNs Array of String 所属 DNS 服务器
目录
中国站