Data Types

Last updated: 2021-09-30 14:42:49

AccountVpcInfo

VPC information of a Private DNS account

Used by actions: CreatePrivateZone, ModifyPrivateZoneVpc.

Name Type Required Description
UniqVpcId String Yes VpcId: vpc-xadsafsdasd
Region String Yes VPC region: ap-guangzhou, ap-shanghai
Note: this field may return null, indicating that no valid values can be obtained.
Uin String Yes VPC account: 123456789
Note: this field may return null, indicating that no valid values can be obtained.
VpcName String Yes VPC name: testname
Note: this field may return null, indicating that no valid values can be obtained.

AccountVpcInfoOutput

Output parameters of the associated VPC

Used by actions: DescribePrivateZone, DescribePrivateZoneList, ModifyPrivateZoneVpc.

Name Type Description
Uin String UIN of the VPC account
UniqVpcId String VPC ID
Region String Region

AuditLog

Operation log

Used by actions: DescribeAuditLog.

Name Type Description
Resource String Log type
Metric String Log table name
TotalCount Integer Total number of logs
DataSet Array of AuditLogInfo List of logs

AuditLogInfo

Log details

Used by actions: DescribeAuditLog.

Name Type Description
Date Timestamp Time
OperatorUin String Operator UIN
Content String Log content

DatePoint

Time statistics

Used by actions: DescribeRequestData.

Name Type Description
Date Timestamp Time
Value Integer Value

Filter

Filter parameter

Used by actions: DescribeAuditLog, DescribePrivateDNSAccountList, DescribePrivateZoneList, DescribePrivateZoneRecordList, DescribeRequestData.

Name Type Required Description
Name String Yes Parameter name
Values Array of String Yes Array of parameter values

FlowUsage

Traffic package usage

Used by actions: DescribeDashboard.

Name Type Description
FlowType String Traffic package type, Valid values: ZONE (private domain); TRAFFIC (DNS traffic package)
TotalQuantity Integer Traffic package quota
AvailableQuantity Integer Available quota of traffic package

MetricData

Statistics table

Used by actions: DescribeRequestData.

Name Type Description
Resource String Resource description
Metric String Table name
DataSet Array of DatePoint Table data

PrivateDNSAccount

Private DNS account

Used by actions: DescribePrivateDNSAccountList.

Name Type Required Description
Uin String Yes Root account UIN
Account String No Root account name
Nickname String No Account name

PrivateZone

Private domain information

Used by actions: DescribePrivateZone, DescribePrivateZoneList.

Name Type Description
ZoneId String Private domain ID: zone-xxxxxxxx
OwnerUin Integer Domain name owner UIN
Domain String Private domain
CreatedOn Timestamp Creation time
UpdatedOn Timestamp Modification time
RecordCount Integer Number of results
Remark String Remarks
Note: this field may return null, indicating that no valid values can be obtained.
VpcSet Array of VpcInfo List of bound VPCs
Status String Private domain status. Valid values: ENABLED (DNS enabled); SUSPEND (DNS paused); FROZEN (locked)
DnsForwardStatus String Subdomain recursive DNS status. Valid values: ENABLED, DISABLED
Tags Array of TagInfo Set of tag key-value pairs
AccountVpcSet Array of AccountVpcInfoOutput List of authorized accounts' VPCs associated with the private domain
Note: this field may return null, indicating that no valid values can be obtained.

PrivateZoneRecord

Private domain information

Used by actions: DescribePrivateZoneRecordList.

Name Type Description
RecordId String Record ID
ZoneId String Private domain ID: zone-xxxxxxxx
SubDomain String Subdomain
RecordType String Record type. Valid values: "A", "AAAA", "CNAME", "MX", "TXT", "PTR"
RecordValue String Record value
TTL Integer Record cache time. The smaller the value, the faster the record will take effect. Value range: 1–86400s. Default value: 600
MX Integer MX priority, which is required when the record type is MX. Valid values: 5, 10, 15, 20, 30, 40, 50
Note: this field may return null, indicating that no valid values can be obtained.
Status String Record status: ENABLED
Weight Integer Record weight. Value range: 1–100
Note: this field may return null, indicating that no valid values can be obtained.
CreatedOn Timestamp Record creation time
UpdatedOn Timestamp Record update time
Extra String Additional information
Note: this field may return null, indicating that no valid values can be obtained.

TagInfo

Tag

Used by actions: CreatePrivateZone, DescribePrivateZone, DescribePrivateZoneList.

Name Type Required Description
TagKey String Yes Tag key
TagValue String Yes Tag value

VpcInfo

VPC information

Used by actions: CreatePrivateZone, DescribePrivateZone, DescribePrivateZoneList, ModifyPrivateZoneVpc.

Name Type Required Description
UniqVpcId String Yes VpcId: vpc-xadsafsdasd
Region String Yes VPC region: ap-guangzhou, ap-shanghai