tencent cloud

APIs

文档APIsPrivate DNSData Types

数据结构

Download
聚焦模式
字号
最后更新时间： 2026-07-09 21:13:28

AccountVpcInfo

私有域解析账号Vpc信息

被如下接口引用：AddSpecifyPrivateZoneVpc, CreatePrivateZone, DeleteSpecifyPrivateZoneVpc, ModifyPrivateZoneVpc。

名称 类型 必选 描述
UniqVpcId String 是 VpcId
Region String 是 Vpc所属地区
Uin String 是 Vpc所属账号
VpcName String 否 vpc资源名称

AccountVpcInfoOut

查询关联账号VPC列表出参

被如下接口引用：DescribeAccountVpcList。

名称 类型 描述
VpcId String VpcId
Region String Vpc所属地区: ap-guangzhou, ap-shanghai
Uin String Vpc所属账号: 123456789
VpcName String vpc资源名称：testname

AccountVpcInfoOutput

关联的VPC出参

被如下接口引用：DescribePrivateZoneList, ModifyPrivateZoneVpc。

名称 类型 描述
Uin String 关联账户的uin
UniqVpcId String vpcid
Region String 地域

AuditLog

操作日志

被如下接口引用：DescribeAuditLog。

名称 类型 描述
Resource String 日志类型
Metric String 日志表名
TotalCount Integer 日志总数
DataSet Array of AuditLogInfo 日志列表

AuditLogInfo

日志详情

被如下接口引用：DescribeAuditLog。

名称 类型 描述
Date Timestamp 时间
OperatorUin String 操作人uin
Content String 日志内容

DatePoint

时间统计值

被如下接口引用：DescribeRequestData。

名称 类型 描述
Date Timestamp 时间
Value Integer 值

EndPointInfo

终端节点信息

被如下接口引用：DescribeEndPointList。

名称 类型 描述
EndPointId String 终端节点ID
EndPointName String 终端节点名称
EndPointServiceId String 终端节点服务ID
EndPointVipSet Array of String 终端节点VIP列表
RegionCode String 地域编码
Tags Array of TagInfo 标签键值对集合

EndpointService

PrivateDNS出站终端节点转发IP

被如下接口引用：DescribeExtendEndpointList。

名称 类型 必选 描述
AccessType String 是 转发目标IP网路接入类型
CLB: 转发IP为内网CLBVIP
CCN: 转发IP通过CCN路由
Pip String 是 转发目标IP
Pport Integer 是 转发IP端口号
VpcId String 是 唯一 vpc id
Vip String 否 转发目标IP代理IP
Vport Integer 否 转发目标IP代理端口
Proto String 否 转发目标IP协议
SubnetId String 否 唯一子网id
接入类型为 CCN 时必填
AccessGatewayId String 否 ccn id
接入类型为 CCN 时必填
SnatVipCidr String 否 出站终端节点SNAT 网段
SnatVipSet String 否 出站终端节点SNAT IP列表
Region String 否 出站终端节点服务所属地域

Filter

筛选参数

被如下接口引用：DescribeAccountVpcList, DescribeAuditLog, DescribeEndPointList, DescribeExtendEndpointList, DescribeForwardRuleList, DescribePrivateDNSAccountList, DescribePrivateZoneList, DescribePrivateZoneRecordList, DescribeRequestData。

名称 类型 必选 描述
Name String 是 参数名
Values Array of String 是 参数值数组

FlowUsage

流量包用量

被如下接口引用：DescribeDashboard。

名称 类型 描述
FlowType String 流量包类型：ZONE 私有域；TRAFFIC 解析流量包
TotalQuantity Integer 流量包总额度
AvailableQuantity Integer 流量包可用额度

ForwardIp

PrivateDNS出站终端节点转发IP

被如下接口引用：CreateExtendEndpoint。

名称 类型 必选 描述
AccessType String 是 转发目标IP网路接入类型
CLB: 转发IP为内网CLBVIP
CCN: 转发IP通过CCN路由
Host String 是 转发目标IP
Port Integer 是 转发IP端口号
IpNum Integer 是 出站终端节点个数
最小1个，最大6个
VpcId String 是 唯一 vpc id
SubnetId String 否 唯一子网id
接入类型为 CCN 时必填
AccessGatewayId String 否 ccn id
接入类型为 CCN 时必填

ForwardRule

转发规则详情

被如下接口引用：DescribeForwardRule, DescribeForwardRuleList。

名称 类型 描述
Domain String 私有域名
RuleName String 转发规则名称
RuleId String 规则id
RuleType String 转发规则类型：云上到云下DOWN、云下到云上DOWN
CreatedAt String 创建时间
UpdatedAt String 更新时间
EndPointName String 终端节点名称
EndPointId String 终端节点ID
ForwardAddress Array of String 转发地址
VpcSet Array of VpcInfo 私有域绑定的vpc列表
ZoneId String 绑定的私有域ID
Tags Array of TagInfo 标签

MetricData

统计数据表

被如下接口引用：DescribeRequestData。

名称 类型 描述
Resource String 资源描述
Metric String 表名
DataSet Array of DatePoint 表数据
MetricCount Integer 查询范围内的请求总量

OutboundEndpoint

出站终端节点

被如下接口引用：DescribeExtendEndpointList。

名称 类型 必选 描述
EndpointId String 否 出站终端节点ID
EndpointName String 否 出站终端节点名
Region String 否 出站终端节点所属地域
Tags Array of TagInfo 否 tag标签
EndpointServiceSet Array of EndpointService 否 出站终端节点信息
仅在转发架构为 V2R的情况下返回
ForwardLinkArch String 否 转发链接架构
V2V: privatelink
V2R: jnsgw
EndPointServiceId String 否 终端节点服务ID
仅在转发架构为 V2V的情况下返回
EndPointVipSet Array of String 否 终端节点VIP列表
仅在转发架构为 V2V的情况下返回

PrivateDNSAccount

私有域解析账号

被如下接口引用：CreatePrivateDNSAccount, DescribePrivateDNSAccountList。

名称 类型 必选 描述
Uin String 是 主账号Uin
Account String 否 主账号名称
Nickname String 否 用户昵称

PrivateZone

私有域信息

被如下接口引用：DescribePrivateZoneList。

名称 类型 描述
ZoneId String 私有域id: zone-xxxxxxxx
OwnerUin Integer 域名所有者uin
Domain String 私有域名
CreatedOn Timestamp 创建时间
UpdatedOn Timestamp 修改时间
RecordCount Integer 记录数
Remark String 备注
VpcSet Array of VpcInfo 绑定的Vpc列表
Status String 私有域绑定VPC状态，未关联vpc：SUSPEND，已关联VPC：ENABLED
，关联VPC失败：FAILED
DnsForwardStatus String 域名递归解析状态：开通：ENABLED, 关闭，DISABLED
Tags Array of TagInfo 标签键值对集合
AccountVpcSet Array of AccountVpcInfoOutput 绑定的关联账号的vpc列表
IsCustomTld Boolean 是否自定义TLD
CnameSpeedupStatus String CNAME加速状态：开通：ENABLED, 关闭，DISABLED
ForwardRuleName String 转发规则名称
ForwardRuleType String 转发规则类型：云上到云下，DOWN；云下到云上，UP，目前只支持DOWN
ForwardAddress String 转发的地址
EndPointName String 终端节点名称
注意：此字段可能返回 null，表示取不到有效值。
DeletedVpcSet Array of VpcInfo 已删除的vpc

PrivateZoneRecord

私有域信息

被如下接口引用：DescribePrivateZoneRecordList。

名称 类型 描述
RecordId String 记录id
ZoneId String 私有域id: zone-xxxxxxxx
SubDomain String 子域名
RecordType String 记录类型，可选的记录类型为："A", "AAAA", "CNAME", "MX", "TXT", "PTR"
RecordValue String 记录值
TTL Integer 记录缓存时间，数值越小生效越快，取值1-86400s, 默认 600
MX Integer MX优先级：记录类型为MX时必填。取值范围：5,10,15,20,30,40,50
Status String 记录状态：ENABLED
Weight Integer 记录权重，值为1-100
注意：此字段可能返回 null，表示取不到有效值。
CreatedOn Timestamp 记录创建时间
UpdatedOn Timestamp 记录更新时间
Extra String 附加信息
注意：此字段可能返回 null，表示取不到有效值。
Enabled Integer 0暂停，1启用
Remark String 备注

RecordInfo

私有域信息

被如下接口引用：DescribeRecord。

名称 类型 描述
RecordId String 记录id
ZoneId String 私有域id: zone-xxxxxxxx
SubDomain String 子域名
RecordType String 记录类型，可选的记录类型为："A", "AAAA", "CNAME", "MX", "TXT", "PTR"
RecordValue String 记录值
TTL Integer 记录缓存时间，数值越小生效越快，取值1-86400s, 默认 600
MX Integer MX优先级：记录类型为MX时必填。取值范围：5,10,15,20,30,40,50
Weight Integer 记录权重，值为1-100
CreatedOn Timestamp 记录创建时间
UpdatedOn Timestamp 记录更新时间
Enabled Integer 0暂停，1启用
Remark String 备注

RegionInfo

地域信息

被如下接口引用：DescribeEndPointRegion。

名称 类型 描述
RegionCode String 地域编码
CnName String 地域中文名
EnName String 地域英文名
RegionId Integer 地域ID
AvailableZoneNum Integer 可用区数量

TagInfo

标签

被如下接口引用：CreatePrivateZone, DescribeEndPointList, DescribeExtendEndpointList, DescribeForwardRule, DescribeForwardRuleList, DescribePrivateZoneList。

名称 类型 必选 描述
TagKey String 是 标签键
TagValue String 是 标签值

TldQuota

Tld额度

被如下接口引用：DescribeQuotaUsage。

名称 类型 描述
Total Integer 总共额度
Used Integer 已使用额度
Stock Integer 库存
Quota Integer 用户限额

VpcInfo

Vpc信息

被如下接口引用：AddSpecifyPrivateZoneVpc, CreatePrivateZone, DeleteSpecifyPrivateZoneVpc, DescribeForwardRule, DescribeForwardRuleList, DescribePrivateZoneList, ModifyPrivateZoneVpc。

名称 类型 必选 描述
UniqVpcId String 是 VpcId
Region String 是 Vpc所属地区: ap-guangzhou, ap-shanghai
上一篇: DeletePrivateZone下一篇: Error Codes

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈