tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2023-04-27 15:39:09

AddRecordBatch

Records to be bulk added

Used by actions: CreateRecordBatch.

Name Type Required Description
RecordType String Yes Record type. For more information, see the DescribeRecordType API.
Value String Yes Record value.
SubDomain String No Subdomain (host record), which is @ by default.
RecordLine String No Split zone of the DNS record. For more information, see the DescribeRecordLineList API. If neither RecordLine nor RecordLineId is specified, the default split zone will be used.
RecordLineId String No Split zone ID of the DNS record. If both RecordLine and RecordLineId are specified, RecordLineId will be used.
Weight Integer No The record weight (not supported).
MX Integer No MX record value. It is 0 by default for non-MX records and required for MX records.
TTL Integer No TTL value of the record, which is 600 by default.
Enabled Integer No Record status (not supported). Valid values: 0 (disabled); 1 (enabled). Default value: 1.
Remark String No Record remarks (not supported).

BatchRecordInfo

Record information in the bulk task

Used by actions: ModifyRecordBatch.

Name Type Description
RecordId Integer Record ID
Note: This field may return null, indicating that no valid values can be obtained.
SubDomain String Subdomain (host record).
Note: This field may return null, indicating that no valid values can be obtained.
RecordType String Record type. For more information, see the DescribeRecordType API.
Note: This field may return null, indicating that no valid values can be obtained.
RecordLine String Split zone of the DNS record. For more information, see the DescribeRecordLineList API.
Note: This field may return null, indicating that no valid values can be obtained.
Value String Record value
Note: This field may return null, indicating that no valid values can be obtained.
TTL Integer TTL value of the record
Note: This field may return null, indicating that no valid values can be obtained.
Status String Record adding status
Note: This field may return null, indicating that no valid values can be obtained.
Operation String Operation type
Note: This field may return null, indicating that no valid values can be obtained.
ErrMsg String Error message
Note: This field may return null, indicating that no valid values can be obtained.
Id Integer ID of the record in the list
Enabled Integer Record status
Note: This field may return null, indicating that no valid values can be obtained.
MX Integer MX weight of the record
Note: This field may return null, indicating that no valid values can be obtained.
Weight Integer The record weight.
Note: This field may return null, indicating that no valid values can be obtained.

CreateDomainBatchDetail

Response structure for bulk adding domains

Used by actions: CreateDomainBatch.

Name Type Description
RecordList Array of CreateDomainBatchRecord See RecordInfoBatch.
Note: This field may return null, indicating that no valid values can be obtained.
Id Integer Task ID
Domain String Domain
Note: This field may return null, indicating that no valid values can be obtained.
DomainGrade String Domain level
Note: This field may return null, indicating that no valid values can be obtained.
ErrMsg String Error message
Note: This field may return null, indicating that no valid values can be obtained.
Status String Task running status
Note: This field may return null, indicating that no valid values can be obtained.
Operation String Operation type
Note: This field may return null, indicating that no valid values can be obtained.

CreateDomainBatchRecord

Record information in the task of bulk adding domains

Used by actions: CreateDomainBatch.

Name Type Description
SubDomain String Subdomain (host record).
Note: This field may return null, indicating that no valid values can be obtained.
RecordType String Record type. For more information, see the DescribeRecordType API.
Note: This field may return null, indicating that no valid values can be obtained.
RecordLine String Split zone of the DNS record. For more information, see the DescribeRecordLineList API.
Note: This field may return null, indicating that no valid values can be obtained.
Value String Record value
Note: This field may return null, indicating that no valid values can be obtained.
TTL Integer TTL value of the record
Note: This field may return null, indicating that no valid values can be obtained.
Status String Record adding status
Note: This field may return null, indicating that no valid values can be obtained.
Operation String Operation type
Note: This field may return null, indicating that no valid values can be obtained.
ErrMsg String Error message
Note: This field may return null, indicating that no valid values can be obtained.
Id Integer ID of the record in the list

CreateRecordBatchDetail

Response structure for bulk adding records

Used by actions: CreateRecordBatch.

Name Type Description
RecordList Array of CreateRecordBatchRecord See RecordInfoBatch.
Note: This field may return null, indicating that no valid values can be obtained.
Id Integer Task ID
Domain String Domain
Note: This field may return null, indicating that no valid values can be obtained.
DomainGrade String Domain level
Note: This field may return null, indicating that no valid values can be obtained.
ErrMsg String Error message
Note: This field may return null, indicating that no valid values can be obtained.
Status String Task running status
Note: This field may return null, indicating that no valid values can be obtained.
Operation String Operation type
Note: This field may return null, indicating that no valid values can be obtained.
DomainId Integer Domain ID
Note: This field may return null, indicating that no valid values can be obtained.

CreateRecordBatchRecord

Record information in the task of bulk adding records

Used by actions: CreateRecordBatch.

Name Type Description
SubDomain String Subdomain (host record).
Note: This field may return null, indicating that no valid values can be obtained.
RecordType String Record type. For more information, see the DescribeRecordType API.
Note: This field may return null, indicating that no valid values can be obtained.
RecordLine String Split zone of the DNS record. For more information, see the DescribeRecordLineList API.
Note: This field may return null, indicating that no valid values can be obtained.
Value String Record value
Note: This field may return null, indicating that no valid values can be obtained.
TTL Integer TTL value of the record
Note: This field may return null, indicating that no valid values can be obtained.
Status String Record adding status
Note: This field may return null, indicating that no valid values can be obtained.
Operation String Operation type
Note: This field may return null, indicating that no valid values can be obtained.
ErrMsg String Error message
Note: This field may return null, indicating that no valid values can be obtained.
Id Integer ID of the record in the list
MX Integer MX weight of the record
Note: This field may return null, indicating that no valid values can be obtained.
Weight Integer The record weight.
Note: This field may return null, indicating that no valid values can be obtained.

DeleteDomainBatchDetail

Details of batch deleting domains

Used by actions: DeleteDomainBatch.

Name Type Description
DomainId Integer The domain ID.
Domain String The domain name.
Error String The error message.
Note: This field may return null, indicating that no valid values can be obtained.
Status String The domain deletion status.
Operation String The operation.

DomainAliasInfo

Information of a domain alias

Used by actions: DescribeDomainAliasList.

Name Type Description
Id Integer Domain alias ID
DomainAlias String Domain alias

DomainAnalyticsDetail

DNS query volume in the current statistical dimension

Used by actions: DescribeSubdomainAnalytics.

Name Type Description
Num Integer DNS query volume in the current statistical dimension
DateKey String Collection date for daily collection
HourKey Integer The last hour (0–23) for hourly collection. For example, if HourKey is 23, the DNS query volume in the statistical period of 22:00–23:00 will be collected.
Note: This field may return null, indicating that no valid values can be obtained.

DomainCountInfo

List statistics by page

Used by actions: DescribeDomainList.

Name Type Description
DomainTotal Integer Number of eligible domains
AllTotal Integer Number of all domains that can be viewed by the user
MineTotal Integer Number of domains added under the user account
ShareTotal Integer Number of domains shared with the user
VipTotal Integer Number of paid domains
PauseTotal Integer Number of suspended domains
ErrorTotal Integer Number of domains with a DNS configuration error
LockTotal Integer Number of locked domains
SpamTotal Integer Number of blocked domains
VipExpire Integer Number of domains that will expire within 30 days
ShareOutTotal Integer Number of domains shared with others
GroupTotal Integer Number of domains in the specified group

DomainCreateInfo

Domain information returned during domain creation

Used by actions: CreateDomain.

Name Type Description
Id Integer Domain ID
Domain String Domain
Punycode String Domain Punycode
GradeNsList Array of String NS list of the domain

DomainInfo

Domain details

Used by actions: DescribeDomain.

Name Type Description
DomainId Integer Domain ID
Status String Domain status
Grade String DNS plan level
GroupId Integer Domain group ID
IsMark String Whether the domain is starred
TTL Integer TTL (DNS record cache time)
CnameSpeedup String Whether CNAME flattening is enabled
Remark String Domain remarks
Note: This field may return null, indicating that no valid values can be obtained.
Punycode String Domain Punycode
DnsStatus String DNS status of the domain
DnspodNsList Array of String NS list of the domain
Domain String Domain
GradeLevel Integer Domain level ID
UserId Integer Domain user ID
IsVip String Whether the domain is a VIP domain
Owner String Domain owner account
GradeTitle String Domain level description
CreatedOn Timestamp Domain creation time
UpdatedOn Timestamp Last update time
Uin String Tencent Cloud account Uin
ActualNsList Array of String NS list actually used by the domain
Note: This field may return null, indicating that no valid values can be obtained.
RecordCount Integer Number of domain records
OwnerNick String Alias of the domain account owner
Note: This field may return null, indicating that no valid values can be obtained.

DomainListItem

Element in the domain list

Used by actions: DescribeDomainList.

Name Type Description
DomainId Integer Unique ID assigned to the domain by the system
Name String Original format of the domain
Status String Domain status. Valid values: ENABLE (normal), PAUSE (suspended), SPAM (blocked).
TTL Integer Default TTL of the default DNS record of the domain
CNAMESpeedup String Whether CNAME flattening is enabled. Valid values: ENABLE (enabled); DISABLE (disabled).
DNSStatus String DNS configuration status. Valid values: DNSERROR (error), an empty string (normal).
Grade String Plan level code of the domain
GroupId Integer Group ID of the domain
SearchEnginePush String Whether search engine push optimization is enabled. Valid values: YES (yes), NO (no).
Remark String Domain remarks
Punycode String Punycode-encoded domain format
EffectiveDNS Array of String Effective DNS assigned to the domain by the system
GradeLevel Integer Number corresponding to the plan level of the domain
GradeTitle String Plan name
IsVip String Whether it is a paid plan
VipStartAt Timestamp Activation time of the paid plan
VipEndAt Timestamp Expiry time of the paid plan
VipAutoRenew String Whether VIP automatic renewal is enabled for the domain. Valid values: YES (yes); NO (no). Default value: DEFAULT.
RecordCount Integer Number of records under the domain
CreatedOn Timestamp Domain adding time
UpdatedOn Timestamp Domain update time
Owner String Account of the domain

DomainShareInfo

Domain sharing information

Used by actions: DescribeDomainShareInfo.

Name Type Description
ShareTo String Account with which the domain is shared
Mode String Sharing mode. Valid values: rw (read/write), r (read-only).
Status String Sharing status. Valid values: enabled (shared successfully); pending (the account shared to does not exist and is pending registration).

GroupInfo

List of domain groups

Used by actions: DescribeDomainGroupList.

Name Type Description
GroupId Integer Group ID
GroupName String Group name
GroupType String Group type
Size Integer Number of domains in the group

LineGroupInfo

Information of a split zone group

Used by actions: DescribeRecordLineList.

Name Type Description
LineId String Split zone group ID
Name String Split zone group name
Type String Group type
LineList Array of String List of split zones in the split zone group

LineInfo

Information of a split zone

Used by actions: DescribeRecordLineList.

Name Type Description
Name String Split zone name
LineId String Split zone ID

LockInfo

Domain lock information

Used by actions: ModifyDomainLock.

Name Type Description
DomainId Integer Domain ID
LockCode String Domain unlock code
LockEnd Date Automatic unlock date of the domain

ModifyRecordBatchDetail

Response structure for bulk adding records

Used by actions: ModifyRecordBatch.

Name Type Description
RecordList Array of BatchRecordInfo See RecordInfoBatchModify.
Note: This field may return null, indicating that no valid values can be obtained.
Id Integer Task ID
Domain String Domain
Note: This field may return null, indicating that no valid values can be obtained.
DomainGrade String Domain level
Note: This field may return null, indicating that no valid values can be obtained.
ErrMsg String Error message
Note: This field may return null, indicating that no valid values can be obtained.
Status String Task running status
Note: This field may return null, indicating that no valid values can be obtained.
Operation String Operation type
Note: This field may return null, indicating that no valid values can be obtained.
DomainId Integer Domain ID
Note: This field may return null, indicating that no valid values can be obtained.

PurviewInfo

Domain permission

Used by actions: DescribeDomainPurview.

Name Type Description
Name String Permission name
Value String Permission value

RecordCountInfo

Count info of the queried record list

Used by actions: DescribeRecordList.

Name Type Description
SubdomainCount Integer The subdomain count.
ListCount Integer The count of records returned in the list.
TotalCount Integer The total record count.

RecordGroupInfo

Information of a DNS record group

Used by actions: DescribeRecordGroupList.

Name Type Description
GroupId Integer Group ID
GroupName String Group name
GroupType String Group type. Valid values: system, user.

RecordInfo

Record information

Used by actions: DescribeRecord.

Name Type Description
Id Integer Record ID.
SubDomain String Subdomain (host record).
RecordType String Record type. For more information, see the DescribeRecordType API.
RecordLine String Split zone of the DNS record. For more information, see the DescribeRecordLineList API.
RecordLineId String Split zone ID of the DNS record. For more information, see the DescribeRecordLineList API.
Value String Record value.
Weight Integer Record weight.
Note: This field may return null, indicating that no valid values can be obtained.
MX Integer MX record value. It is 0 by default for non-MX records.
TTL Integer TTL value of the record.
Enabled Integer Record status. Valid values: 0 (disabled); 1 (enabled).
MonitorStatus String D-Monitor status of the record.
"Ok" : The server is normal.
"Warn" : There is an alarm on this record, and the server returns 4XX.
"Down" : The server is down.
"" : D-Monitor is disabled for this record.
Remark String Record remarks.
Note: This field may return null, indicating that no valid values can be obtained.
UpdatedOn Timestamp Last update time of the record.
DomainId Integer Domain ID.

RecordListItem

Record list elements

Used by actions: DescribeRecordList.

Name Type Description
RecordId Integer The record ID.
Value String The record value.
Status String The record status. Valid values: ENABLE (enabled), DISABLE (disabled).
UpdatedOn Timestamp The update time.
Name String The host name.
Line String The record split zone.
LineId String The split zone ID.
Type String The record type.
Weight Integer The record weight, which is required for round-robin DNS records.
Note: This field may return null, indicating that no valid values can be obtained.
MonitorStatus String The monitoring status of the record. Valid values: OK (normal), WARN (warning), and DOWN (downtime). It is empty if no monitoring is set or the monitoring is suspended.
Remark String The record remarks.
TTL Integer The record cache time.
MX Integer The MX value, applicable to the MX record only.
Note: This field may return null, indicating that no valid values can be obtained.
DefaultNS Boolean Whether it is a default NS record.

SubdomainAliasAnalyticsItem

DNS query volume of the subdomain alias

Used by actions: DescribeSubdomainAnalytics.

Name Type Description
Info SubdomainAnalyticsInfo Statistics on the DNS query volume of a subdomain
Data Array of DomainAnalyticsDetail DNS query volume in the current statistical dimension

SubdomainAnalyticsInfo

Statistics on the DNS query volume of a subdomain

Used by actions: DescribeSubdomainAnalytics.

Name Type Description
DnsFormat String DATE: Daily; HOUR: Hourly
DnsTotal Integer Total DNS query volume for the current statistical period
Domain String The queried domain
StartDate String Start date of the current statistical period
EndDate String End date of the current statistical period
Subdomain String Subdomain
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy