Data Types

Last updated: 2021-01-18 11:49:49

AccessControl

Request header and request URL access control

Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes Whether to enable request header and request URL access control. Valid values: on, off
AccessControlRules Array of AccessControlRule No Request header and request URL access rule
Note: this field may return null, indicating that no valid values can be obtained.
ReturnCode Integer No Returned status code
Note: this field may return null, indicating that no valid values can be obtained.

AccessControlRule

Access control rule

Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
RuleType String Yes requestHeader: access control over request header
url: access control over access URL
Note: this field may return null, indicating that no valid values can be obtained.
RuleContent String Yes Blocked content
Note: this field may return null, indicating that no valid values can be obtained.
Regex String Yes on: regular match
off: exact match
Note: this field may return null, indicating that no valid values can be obtained.
RuleHeader String No This parameter is required only if RuleType is requestHeader
Note: this field may return null, indicating that no valid values can be obtained.

AdvanceCacheRule

Advanced cache configuration rules

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
CacheType String Yes Rule types:
all: effective for all files
file: effective for specified file suffixes
directory: effective for specified paths
path: effective for specified absolute paths
default: the cache rules when the origin server has not returned max-age
Note: this field may return null, indicating that no valid values can be obtained.
CacheContents Array of String Yes Content for each CacheType:
For all, enter an asterisk (*).
For file, enter the suffix, such as jpg, txt.
For directory, enter the path, such as /xxx/test/.
For path, enter the corresponding absolute path, such as /xxx/test.html.
For default, enter "no max-age".
Note: this field may return null, indicating that no valid values can be obtained.
CacheTime Integer Yes Cache expiration time
Unit: second. The maximum value is 365 days.
Note: this field may return null, indicating that no valid values can be obtained.

AdvanceConfig

Advanced configuration set

Used by actions: DescribeDomainsConfig.

Name Type Description
Name String Advanced configuration name
Note: this field may return null, indicating that no valid values can be obtained.
Value String Whether advanced configuration is supported:
on: support
off: do not support
Note: this field may return null, indicating that no valid values can be obtained.

AdvancedAuthentication

Timestamp hotlink protection advanced configuration (allowlist feature)

Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes Hotlink protection configuration switch (which can be on or off). If it is enabled, only one mode can and must be configured, while other modes are null.
TypeA AdvancedAuthenticationTypeA No Timestamp hotlink protection advanced configuration mode A
Note: this field may return null, indicating that no valid values can be obtained.
TypeB AdvancedAuthenticationTypeB No Timestamp hotlink protection advanced configuration mode B
Note: this field may return null, indicating that no valid values can be obtained.
TypeC AdvancedAuthenticationTypeC No Timestamp hotlink protection advanced configuration mode C
Note: this field may return null, indicating that no valid values can be obtained.
TypeD AdvancedAuthenticationTypeD No Timestamp hotlink protection advanced configuration mode D
Note: this field may return null, indicating that no valid values can be obtained.
TypeE AdvancedAuthenticationTypeE No Timestamp hotlink protection advanced configuration mode E
Note: this field may return null, indicating that no valid values can be obtained.
TypeF AdvancedAuthenticationTypeF No Timestamp hotlink protection advanced configuration mode F
Note: this field may return null, indicating that no valid values can be obtained.

AdvancedAuthenticationTypeA

Timestamp hotlink protection advanced configuration mode A

Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
SecretKey String Yes Key used for signature calculation, allowing 6 to 32 bytes of letters and digits.
SignParam String Yes Signature field name in the URI string, starting with a letter, and consisting of letters, digits, and underscores.
TimeParam String Yes Time field name in the URI string, starting with a letter, and consisting of letters, digits, and underscores.
ExpireTime Integer Yes Expiration time in seconds
ExpireTimeRequired Boolean Yes Whether the expiration time parameter is required
Format String Yes URL composition, e.g., ${private_key}${schema}${host}${full_uri}.
TimeFormat String Yes Time format. Valid values: dec (decimal), hex (hexadecimal).
FailCode Integer Yes Status code returned when the authentication failed
ExpireCode Integer Yes Status code returned when the URL expired
RulePaths Array of String Yes List of URLs to be authenticated
Transformation Integer No Reserved field

AdvancedAuthenticationTypeB

Timestamp hotlink protection advanced configuration mode B

Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
KeyAlpha String Yes Alpha key name
KeyBeta String Yes Beta key name
KeyGamma String Yes Gamma key name
SignParam String Yes Signature field name in the URI string, starting with a letter, and consisting of letters, digits, and underscores.
TimeParam String Yes Time field name in the URI string, starting with a letter, and consisting of letters, digits, and underscores.
ExpireTime Integer Yes Expiration time in seconds
TimeFormat String Yes Time format. Valid values: dec (decimal), hex (hexadecimal).
FailCode Integer Yes Status code returned when the authentication failed
ExpireCode Integer Yes Status code returned when the URL expired
RulePaths Array of String Yes List of URLs to be authenticated

AdvancedAuthenticationTypeC

Timestamp hotlink protection advanced configuration mode C

Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
AccessKey String Yes Access key
SecretKey String Yes Authentication key

AdvancedAuthenticationTypeD

Timestamp hotlink protection advanced configuration mode D

Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
SecretKey String Yes Key used for signature calculation, allowing 6 to 32 bytes of letters and digits.
BackupSecretKey String Yes Alternative key used for authentication after the authentication key (SecretKey) failed
SignParam String Yes Signature field name in the URI string, starting with a letter, and consisting of letters, digits, and underscores.
TimeParam String Yes Time field name in the URI string, starting with a letter, and consisting of letters, digits, and underscores.
ExpireTime Integer Yes Expiration time in seconds
TimeFormat String Yes Time format. Valid values: dec (decimal), hex (hexadecimal).

AdvancedAuthenticationTypeE

Timestamp hotlink protection advanced configuration mode E

Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
SecretKey String Yes Key used for signature calculation, allowing 6 to 32 bytes of letters and digits.
Note: this field may return null, indicating that no valid values can be obtained.
SignParam String Yes Signature field name in the URI string, starting with a letter, and consisting of letters, digits, and underscores.
Note: this field may return null, indicating that no valid values can be obtained.
AclSignParam String Yes ACL signature field name in the URI string, starting with a letter, and consisting of letters, digits, and underscores.
Note: this field may return null, indicating that no valid values can be obtained.
StartTimeParam String Yes Start time field name in the URI string, starting with a letter, and consisting of letters, digits, and underscores.
Note: this field may return null, indicating that no valid values can be obtained.
ExpireTimeParam String Yes Expiration time field name in the URI string, starting with a letter, and consisting of letters, digits, and underscores.
Note: this field may return null, indicating that no valid values can be obtained.
TimeFormat String Yes Time format (dec)
Note: this field may return null, indicating that no valid values can be obtained.

AdvancedAuthenticationTypeF

Timestamp hotlink protection advanced authentication configuration mode F (TypeF)

Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
SignParam String Yes Signature field name in the URI string, starting with a letter, and consisting of letters, digits, and underscores.
Note: this field may return null, indicating that no valid values can be obtained.
TimeParam String Yes Time field name in the URI string, starting with a letter, and consisting of letters, digits, and underscores.
Note: this field may return null, indicating that no valid values can be obtained.
TransactionParam String Yes Transaction field name in the URI string, starting with a letter, and consisting of letters, digits, and underscores.
Note: this field may return null, indicating that no valid values can be obtained.
SecretKey String Yes CMK used for signature calculation, allowing 6 to 32 bytes of letters and digits.
Note: this field may return null, indicating that no valid values can be obtained.
BackupSecretKey String No Alternative key used for signature calculation, which is used after the CMK fails in authentication. It allows 6 to 32 bytes of letters and digits.
Note: this field may return null, indicating that no valid values can be obtained.

AdvancedCache

Advanced cache expiration configuration (This feature is in beta and not generally available yet.)
Note: this version does not support setting homepage cache rules.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
CacheRules Array of AdvanceCacheRule Yes Cache expiration rule
Note: this field may return null, indicating that no valid values can be obtained.
IgnoreCacheControl String Yes Forced cache configuration
on: enabled
off: disabled
When this is enabled, if the origin server returns no-cache, no-store headers, node caching will still be performed according to the cache expiration rules.
This is disabled by default
Note: this field may return null, indicating that no valid values can be obtained.
IgnoreSetCookie String Yes Ignore the Set-Cookie header of an origin server
on: enabled
off: disabled
This is disabled by default
Note: this field may return null, indicating that no valid values can be obtained.

Authentication

Timestamp hotlink protection configuration

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes Hotlink protection configuration switch
on: enabled
off: disabled
When this is enabled, one mode needs to be configured. Other modes need to be set to null.
TypeA AuthenticationTypeA No Timestamp hotlink protection mode A configuration
Note: this field may return null, indicating that no valid values can be obtained.
TypeB AuthenticationTypeB No Timestamp hotlink protection mode B configuration (mode B is being upgraded and is currently not supported)
Note: this field may return null, indicating that no valid values can be obtained.
TypeC AuthenticationTypeC No Timestamp hotlink protection mode C configuration
Note: this field may return null, indicating that no valid values can be obtained.
TypeD AuthenticationTypeD No Timestamp hotlink protection mode D configuration
Note: this field may return null, indicating that no valid values can be obtained.

AuthenticationTypeA

Timestamp hotlink protection mode A configuration
The access URL format of timestamp hotlink protection mode A is as follows: http://DomainName/Filename?sign=timestamp-rand-uid-md5hash
Here, timestamp is a decimal timestamp in Unix format;
rand is a random string composed of 0-100 characters, including digits, upper and lower-case letters.
uid is 0;
md5hash: MD5 (file path-timestamp-rand-uid-custom key)

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
SecretKey String Yes The key for signature calculation
Only digits, upper and lower-case letters are allowed. Length limit: 6-32 characters.
Note: this field may return null, indicating that no valid values can be obtained.
SignParam String Yes Signature parameter name
Only upper and lower-case letters, digits, and underscores (_) are allowed. It cannot start with a digit. Length limit: 1-100 characters.
ExpireTime Integer Yes Signature expiration time
Unit: second. The maximum value is 31536000.
FileExtensions Array of String Yes File extension list settings determining if authentication should be performed
If it contains an asterisk (*), this indicates all files.
FilterType String Yes allowlist: indicates that all file types apart from the FileExtensions list are authenticated
blacklist: indicates that only the file types in the FileExtensions list are authenticated

AuthenticationTypeB

Timestamp hotlink protection mode B configuration (mode B is being upgraded and is currently not supported)

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
SecretKey String Yes The key for signature calculation
Only digits, upper and lower-case letters are allowed. Length limit: 6-32 characters.
Note: this field may return null, indicating that no valid values can be obtained.
ExpireTime Integer Yes Signature expiration time
Unit: second. The maximum value is 31536000.
FileExtensions Array of String Yes File extension list settings determining if authentication should be performed
If it contains an asterisk (*), this indicates all files.
FilterType String Yes allowlist: indicates that all file types apart from the FileExtensions list are authenticated
blacklist: indicates that only the file types in the FileExtensions list are authenticated

AuthenticationTypeC

Timestamp hotlink protection mode C configuration
The access URL format of timestamp hotlink protection mode C is as follows: http://DomainName/md5hash/timestamp/FileName
Here, timestamp is a hexadecimal timestamp in Unix format;
md5hash: MD5 (custom key + file path + timestamp)

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
SecretKey String Yes The key for signature calculation
Only digits, upper and lower-case letters are allowed. Length limit: 6-32 characters.
Note: this field may return null, indicating that no valid values can be obtained.
ExpireTime Integer Yes Signature expiration time
Unit: second. The maximum value is 31536000.
FileExtensions Array of String Yes File extension list settings determining if authentication should be performed
If it contains an asterisk (*), this indicates all files.
FilterType String Yes allowlist: indicates that all file types apart from the FileExtensions list are authenticated
blacklist: indicates that only the file types in the FileExtensions list are authenticated
TimeFormat String No Timestamp settings
dec: decimal
hex: hexadecimal
Note: this field may return null, indicating that no valid value is obtained.

AuthenticationTypeD

Timestamp hotlink protection mode D configuration
The access URL format of timestamp hotlink protection mode D is as follows: http://DomainName/FileName?sign=md5hash&t=timestamp
Here, timestamp is a decimal or hexadecimal timestamp in Unix format;
md5hash: MD5 (custom key + file path + timestamp)

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
SecretKey String Yes The key for signature calculation
Only digits, upper and lower-case letters are allowed. Length limit: 6-32 characters.
Note: this field may return null, indicating that no valid values can be obtained.
ExpireTime Integer Yes Signature expiration time
Unit: second. The maximum value is 31536000.
FileExtensions Array of String Yes File extension list settings determining if authentication should be performed
If it contains an asterisk (*), this indicates all files.
FilterType String Yes allowlist: indicates that all file types apart from the FileExtensions list are authenticated
blacklist: indicates that only the file types in the FileExtensions list are authenticated
SignParam String Yes Signature parameter name
Only upper and lower-case letters, digits, and underscores (_) are allowed. It cannot start with a digit. Length limit: 1-100 characters.
TimeParam String Yes Timestamp parameter name
Only upper and lower-case letters, digits, and underscores (_) are allowed. It cannot start with a digit. Length limit: 1-100 characters.
TimeFormat String Yes Timestamp settings
dec: decimal
hex: hexadecimal

AwsPrivateAccess

Origin access authentication for S3 bucket.

Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes Switch, which can be set to on or off.
AccessKey String No Access ID.
Note: this field may return null, indicating that no valid values can be obtained.
SecretKey String No Key.
Note: this field may return null, indicating that no valid values can be obtained.

BandwidthAlert

Bandwidth cap configuration. This is disabled by default.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes Bandwidth cap configuration switch
on: enabled
off: disabled
BpsThreshold Integer No Bandwidth cap threshold (in bps)
Note: this field may return null, indicating that no valid values can be obtained.
CounterMeasure String No Action taken when threshold is reached
RESOLVE_DNS_TO_ORIGIN: requests will be forwarded to the origin server. This is only supported for domain names of external origin.
RETURN_404: a 404 error will be returned for all requests.
Note: this field may return null, indicating that no valid values can be obtained.
LastTriggerTime Timestamp No The last time the bandwidth cap threshold was triggered
Note: this field may return null, indicating that no valid values can be obtained.

BotCookie

Bot cookie policy

Used by actions: UpdateScdnDomain.

Name Type Required Description
Switch String Yes Valid values: on and off.
RuleType String Yes Rule type, which can only be all currently.
RuleValue Array of String Yes Rule value. Valid value: *.
Action String Yes Action. Valid values: monitor, intercept, redirect, and captcha.
RedirectUrl String No Redirection target page
Note: this field may return null, indicating that no valid values can be obtained.
UpdateTime Timestamp No Update time
Note: this field may return null, indicating that no valid values can be obtained.

BotJavaScript

Bot JS policy

Used by actions: UpdateScdnDomain.

Name Type Required Description
Switch String Yes Valid values: on and off.
RuleType String Yes Rule type, which can only be file currently.
RuleValue Array of String Yes Rule value. Valid values: html and htm.
Action String Yes Action. Valid values: monitor, intercept, redirect, and captcha.
RedirectUrl String No Redirection target page
Note: this field may return null, indicating that no valid values can be obtained.
UpdateTime Timestamp No Update time
Note: this field may return null, indicating that no valid values can be obtained.

BriefDomain

Basic domain configuration information, including CNAME, status, service type, acceleration region, creation time, last modified time, and origin server configuration.

Used by actions: DescribeDomains.

Name Type Description
ResourceId String Domain name ID
AppId Integer Tencent Cloud account ID
Domain String Acceleration domain name
Cname String CNAME address of domain name
Status String Acceleration service status
rejected: the domain name is rejected due to expiration/deregistration of its ICP filing
processing: deploying
online: activated
offline: disabled
ProjectId Integer Project ID, which can be viewed on the Tencent Cloud project management page
ServiceType String Domain name service type
web: static acceleration
download: download acceleration
media: streaming VOD acceleration
CreateTime Timestamp Domain name creation time
UpdateTime Timestamp Last modified time of domain name
Origin Origin Origin server configuration details
Disable String Domain name block status
normal: normal
overdue: the domain name has been disabled due to account arrears. The acceleration service can be resumed after the account is topped up.
malicious: the acceleration service has been forcibly disabled due to detection of malicious behavior.
ddos: the acceleration service has been disabled due to large-scale DDoS attacks to the domain name
idle: no operations or data has been detected for more than 90 days. The domain name is determined to be inactive which automatically disables the acceleration service. You can restart the service.
unlicensed: the acceleration service has been automatically disabled as the domain name has no ICP filing or its ICP filing is deregistered. Service can be resumed after an ICP filing is obtained.
capping: the configured upper limit for bandwidth has been reached.
readonly: the domain name has a special configuration and has been locked.
Area String Acceleration region
mainland: acceleration in Mainland China
overseas: acceleration outside Mainland China
global: global acceleration
Readonly String Domain name lock status
normal: not locked
mainland: locked in Mainland China
overseas: locked outside Mainland China
global: locked globally

Cache

Node cache expiration time configuration. There are two types of configuration:

  • Basic cache expiration rules configuration
  • Advanced cache expiration rules configuration

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
SimpleCache SimpleCache No Basic cache expiration time configuration
Note: this field may return null, indicating that no valid values can be obtained.
AdvancedCache AdvancedCache No Advanced cache expiration configuration (This feature is in beta and not generally available yet.)
Note: this field may return null, indicating that no valid values can be obtained.
RuleCache Array of RuleCache No Advanced path cache configuration
Note: this field may return null, indicating that no valid value is obtained.

CacheConfigCache

Path cache configuration

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes Cache configuration switch
on: enable
off: disable
Note: this field may return null, indicating that no valid value is obtained.
CacheTime Integer Yes Cache expiration time settings
Unit: second. The maximum value is 365 days.
Note: this field may return null, indicating that no valid value is obtained.
CompareMaxAge String Yes Advanced cache expiration configuration. If this is enabled, the max-age value returned by the origin server will be compared with the cache expiration time set in CacheRules, and the smallest value will be cached on the node.
on: enable
off: disable
This is disabled by default.
Note: this field may return null, indicating that no valid value is obtained.
IgnoreCacheControl String Yes Force cache
on: enable
off: disable
This is disabled by default. If enabled, the no-store and no-cache resources returned from the origin server will be cached according to CacheRules rules.
Note: this field may return null, indicating that no valid value is obtained.
IgnoreSetCookie String Yes Ignore the Set-Cookie header of an origin server.
on: enable
off: disable
This is disabled by default.
Note: this field may return null, indicating that no valid value is obtained.

CacheConfigFollowOrigin

Path cache configuration follows the origin server configuration.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes Follow origin server switch configuration
on: enable
off: disable

CacheConfigNoCache

Path cache/no cache configuration.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes No cache configuration switch
on: enable
off: disable
Note: this field may return null, indicating that no valid value is obtained.
Revalidate String Yes Always forwards to the origin server for verification
on: enable
off: disable
This is disabled by default.
Note: this field may return null, indicating that no valid value is obtained.

CacheKey

Cache key configuration (filter parameter configuration)

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
FullUrlCache String No Whether to enable full-path cache
on: enable full-path cache (i.e., disable parameter filter)
off: disable full-path cache (i.e., enable parameter filter)
IgnoreCase String No Whether caches are case insensitive
Note: this field may return null, indicating that no valid values can be obtained.
QueryString QueryStringKey No Request parameter contained in CacheKey
Note: this field may return null, indicating that no valid values can be obtained.
Cookie CookieKey No Cookie contained in CacheKey
Note: this field may return null, indicating that no valid values can be obtained.
Header HeaderKey No Request header contained in CacheKey
Note: this field may return null, indicating that no valid values can be obtained.
CacheTag CacheTagKey No Custom string contained in CacheKey
Note: this field may return null, indicating that no valid values can be obtained.
Scheme SchemeKey No Request protocol contained in CacheKey
Note: this field may return null, indicating that no valid values can be obtained.
KeyRules Array of KeyRule No Path-based cache key configuration
Note: this field may return null, indicating that no valid value is obtained.

CacheOptResult

Result of blocking/unblocking URLs

Used by actions: DisableCaches, EnableCaches.

Name Type Description
SuccessUrls Array of String List of succeeded URLs
Note: This field may return null, indicating that no valid values can be obtained.
FailUrls Array of String List of failed URLs
Note: This field may return null, indicating that no valid values can be obtained.

CacheTagKey

A part of CacheKey

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes Whether to use CacheTag as part of CacheKey
Note: this field may return null, indicating that no valid values can be obtained.
Value String No Value of custom CacheTag
Note: this field may return null, indicating that no valid values can be obtained.

CappingRule

Downstream speed limit configuration rules. Up to 100 entries can be configured.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
RuleType String Yes Rule types:
all: effective for all files
file: effective for specified file suffixes
directory: effective for specified paths
path: effective for specified absolute paths
RulePaths Array of String Yes Content for each RuleType:
For all, enter an asterisk (*).
For file, enter the suffix, such as jpg, txt.
For directory, enter the path, such as /xxx/test/.
For path, enter the corresponding absolute path, such as /xxx/test.html.
KBpsThreshold Integer Yes Downstream speed value settings (in KB/s)

CdnData

Detailed access data

Used by actions: DescribeBillingData, DescribeCdnData, DescribeIpVisit, DescribeOriginData.

Name Type Description
Metric String Queries the specified metric:
flux: traffic (in bytes)
bandwidth: bandwidth (in bps)
request: number of requests
fluxHitRate: traffic hit rate (in %)
statusCode: status code. The aggregate data for 2xx, 3xx, 4xx, and 5xx status codes will be returned (in entries)
2XX: Returns the aggregate list of 2xx status codes and the data for status codes starting with 2 (in entries)
3XX: Returns the aggregate list of 3xx status codes and the data for status codes starting with 3 (in entries)
4XX: Returns the aggregate list of 4xx status codes and the data for status codes starting with 4 (in entries)
5XX: Returns the aggregate list of 5xx status codes and the data for status codes starting with 5 (in entries)
Alternatively, you can specify a status code for querying.
DetailData Array of TimestampData Detailed data combination
SummarizedData SummarizedData Aggregate data combination

CdnIp

IP attribute information

Used by actions: DescribeCdnIp.

Name Type Description
Ip String IP to be queried
Platform String IP ownership:
yes: Tencent Cloud CDN node
no: non-Tencent Cloud CDN node
Location String Node district/country
unknown: unknown node location
History Array of CdnIpHistory Node activation and deactivation history
Area String Node region
mainland: cache node in Mainland China
overseas: cache node outside Mainland China
unknown: service region unknown
City String City where the node resides
Note: this field may return null, indicating that no valid value is obtained.

CdnIpHistory

CDN node activation and deactivation history

Used by actions: DescribeCdnIp.

Name Type Description
Status String Operation type
online: node is online
offline: node is offline
Datetime Timestamp Operation time corresponding to operation type
If this value is null, there are no status change records
Note: this field may return null, indicating that no valid values can be obtained.

ClientCert

HTTPS client certificate configuration

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Certificate String Yes Client Certificate
PEM format, requires Base64 encoding.
Note: this field may return null, indicating that no valid values can be obtained.
CertName String No Client certificate name
Note: this field may return null, indicating that no valid values can be obtained.
ExpireTime Timestamp No Certificate expiration time
When this is used as an input parameter, it can be left blank.
Note: this field may return null, indicating that no valid values can be obtained.
DeployTime Timestamp No Certificate issuance time
When this is used as an input parameter, it can be left blank.
Note: this field may return null, indicating that no valid values can be obtained.

ClsLogObject

CLS log search object

Used by actions: SearchClsLog.

Name Type Description
TopicId String Topic ID
TopicName String Topic name
Timestamp String Log time
Content String Log content
Filename String Capture path
Source String Log source device

ClsSearchLogs

CLS log search result

Used by actions: SearchClsLog.

Name Type Description
Context String Cursor for more search results
Listover Boolean Whether all search results have been returned
Results Array of ClsLogObject Log content information

Compatibility

Old configuration compatibility check

Used by actions: DescribeDomainsConfig.

Name Type Description
Code Integer Compatibility flag status code.
Note: this field may return null, indicating that no valid values can be obtained.

Compression

Smart compression configuration. By default, Gzip compression is performed for files with js, html, css, xml, json, shtml, and htm suffixes, and with sizes between 256 and 2097152 bytes.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes Smart compression configuration switch
on: enabled
off: disabled
CompressionRules Array of CompressionRule No Compression rules array
Note: this field may return null, indicating that no valid values can be obtained.

CompressionRule

Compression rules configuration. Up to 100 entries can be set.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Compress Boolean Yes true: must be set as true, enables compression
Note: this field may return null, indicating that no valid values can be obtained.
FileExtensions Array of String Yes Compress according to the file suffix type
Such as: jpg, txt
Note: this field may return null, indicating that no valid values can be obtained.
MinLength Integer Yes The minimum file size to trigger compression (in bytes)
Note: this field may return null, indicating that no valid values can be obtained.
MaxLength Integer Yes The maximum file size to trigger compression (in bytes)
The maximum value is 30 MB
Note: this field may return null, indicating that no valid values can be obtained.
Algorithms Array of String Yes File compression algorithm
gzip: specifies Gzip compression
brotli: specifies Brotli compression
Note: this field may return null, indicating that no valid values can be obtained.

CookieKey

A part of CacheKey

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes Whether to use Cookie as part of CacheKey. Valid values: on, off
Note: this field may return null, indicating that no valid values can be obtained.
Value String No Used cookies (separated by ';')
Note: this field may return null, indicating that no valid values can be obtained.

DetailDomain

Complete acceleration domain configuration information

Used by actions: DescribeDomainsConfig.

Name Type Description
ResourceId String Domain name ID
AppId Integer Tencent Cloud account ID
Domain String Acceleration domain name
Cname String CNAME address of domain name
Note: this field may return null, indicating that no valid values can be obtained.
Status String Acceleration service status
rejected: the domain name is rejected due to expiration/deregistration of its ICP filing
processing: deploying
online: activated
offline: disabled
ProjectId Integer Project ID, which can be viewed on the Tencent Cloud project management page
ServiceType String Domain name service type
web: static acceleration
download: download acceleration
media: streaming VOD acceleration
CreateTime Timestamp Domain name creation time
UpdateTime Timestamp Last modified time of domain name
Origin Origin Origin server configuration
IpFilter IpFilter IP blacklist/whitelist configuration
Note: this field may return null, indicating that no valid values can be obtained.
IpFreqLimit IpFreqLimit IP access frequency limit configuration
Note: this field may return null, indicating that no valid values can be obtained.
StatusCodeCache StatusCodeCache Status code cache configuration
Note: this field may return null, indicating that no valid values can be obtained.
Compression Compression Smart compression configuration
Note: this field may return null, indicating that no valid values can be obtained.
BandwidthAlert BandwidthAlert Bandwidth cap configuration
Note: this field may return null, indicating that no valid values can be obtained.
RangeOriginPull RangeOriginPull Range GETs configuration
Note: this field may return null, indicating that no valid values can be obtained.
FollowRedirect FollowRedirect 301/302 origin-pull follow-redirect configuration
Note: this field may return null, indicating that no valid values can be obtained.
ErrorPage ErrorPage Custom error page configuration (in beta)
Note: this field may return null, indicating that no valid values can be obtained.
RequestHeader RequestHeader Custom request header configuration
Note: this field may return null, indicating that no valid values can be obtained.
ResponseHeader ResponseHeader Custom response header configuration
Note: this field may return null, indicating that no valid values can be obtained.
DownstreamCapping DownstreamCapping Single-link downstream speed limit configuration
Note: this field may return null, indicating that no valid values can be obtained.
CacheKey CacheKey Configuration of cache with/without parameter
Note: this field may return null, indicating that no valid values can be obtained.
ResponseHeaderCache ResponseHeaderCache Origin server header cache configuration
Note: this field may return null, indicating that no valid values can be obtained.
VideoSeek VideoSeek Video dragging configuration
Note: this field may return null, indicating that no valid values can be obtained.
Cache Cache Node cache expiration rule configuration
Note: this field may return null, indicating that no valid values can be obtained.
OriginPullOptimization OriginPullOptimization Cross-border linkage optimization configuration (in beta)
Note: this field may return null, indicating that no valid values can be obtained.
Https Https HTTPS acceleration configuration
Note: this field may return null, indicating that no valid values can be obtained.
Authentication Authentication Timestamp hotlink protection configuration
Note: this field may return null, indicating that no valid values can be obtained.
Seo Seo SEO configuration
Note: this field may return null, indicating that no valid values can be obtained.
Disable String Domain name block status
normal: normal
overdue: the domain name has been disabled due to account arrears. The acceleration service can be resumed after the account is topped up.
malicious: the acceleration service has been forcibly disabled due to detection of malicious behavior.
ddos: the acceleration service has been disabled due to large-scale DDoS attacks to the domain name
idle: no operations or data has been detected for more than 90 days. The domain name is determined to be inactive which automatically disables the acceleration service. You can restart the service.
unlicensed: the acceleration service has been automatically disabled as the domain name has no ICP filing or its ICP filing is deregistered. Service can be resumed after an ICP filing is obtained.
capping: the configured upper limit for bandwidth has been reached.
readonly: the domain name has a special configuration and has been locked.
Note: this field may return null, indicating that no valid values can be obtained.
ForceRedirect ForceRedirect Access protocol forced redirect configuration
Note: this field may return null, indicating that no valid values can be obtained.
Referer Referer Referer hotlink protection configuration
Note: this field may return null, indicating that no valid values can be obtained.
MaxAge MaxAge Browser cache expiration rule configuration (in beta)
Note: this field may return null, indicating that no valid values can be obtained.
Ipv6 Ipv6 IPv6 origin-pull configuration (in beta)
Note: this field may return null, indicating that no valid values can be obtained.
Compatibility Compatibility Backwards compatibility configuration (compatibility field for internal use)
Note: this field may return null, indicating that no valid values can be obtained.
SpecificConfig SpecificConfig Region-specific configuration
Note: this field may return null, indicating that no valid values can be obtained.
Area String Acceleration region
mainland: acceleration in Mainland China
overseas: acceleration outside Mainland China
global: global acceleration
Note: this field may return null, indicating that no valid values can be obtained.
Readonly String Domain name lock status
normal: not locked
mainland: locked in Mainland China
overseas: locked outside Mainland China
global: locked globally
Note: this field may return null, indicating that no valid values can be obtained.
OriginPullTimeout OriginPullTimeout Origin-pull timeout configuration
Note: this field may return null, indicating that no valid values can be obtained.
AwsPrivateAccess AwsPrivateAccess S3 bucket origin access authentication configuration
Note: this field may return null, indicating that no valid values can be obtained.
SecurityConfig SecurityConfig SCDN configuration
ImageOptimization ImageOptimization Image Optimization configuration
UserAgentFilter UserAgentFilter UA blocklist/allowlist configuration
AccessControl AccessControl Access control
Advance String Whether to support advanced configuration items
on: supported
off: not supported
Note: this field may return null, indicating that no valid values can be obtained.
UrlRedirect UrlRedirect URL redirect configuration
Note: this field may return null, indicating that no valid values can be obtained.
AccessPort Array of Integer Access port configuration
Note: this field may return null, indicating that no valid values can be obtained.
Tag Array of Tag Tag configuration
Note: this field may return null, indicating that no valid value is obtained.
AdvancedAuthentication AdvancedAuthentication Timestamp hotlink protection advanced configuration (allowlist feature)
Note: this field may return null, indicating that no valid values can be obtained.
OriginAuthentication OriginAuthentication Origin-pull authentication advanced configuration (allowlist feature)
Note: this field may return null, indicating that no valid values can be obtained.
Ipv6Access Ipv6Access IPv6 access configuration
Note: this field may return null, indicating that no valid values can be obtained.
AdvanceSet Array of AdvanceConfig Advanced configuration set
Note: this field may return null, indicating that no valid values can be obtained.
OfflineCache OfflineCache Offline cache
Note: this field may return null, indicating that no valid values can be obtained.
OriginCombine OriginCombine Merging pull requests
Note: this field may return null, indicating that no valid values can be obtained.

DomainAreaConfig

Domain name region configuration

Used by actions: CreateClsLogTopic, ListClsTopicDomains, ManageClsTopicDomains.

Name Type Required Description
Domain String Yes Domain name
Area Array of String Yes Region list, where the element can be mainland/overseas

DomainFilter

Filter conditions for domain name query.

Used by actions: DescribeDomains, DescribeDomainsConfig.

Name Type Required Description
Name String Yes Filter field name, the list supported is as follows:
- origin: primary origin server.
- domain: domain name.
- resourceId: domain name id.
- status: domain name status. Values include online, offline, or processing.
- serviceType: service type. Values include web, download, or media.
- projectId: project ID.
- domainType: primary origin server type, cname indicates external origin, COS indicates COS origin.
- fullUrlCache: full-path cache, which can be on or off.
- https: whether to configure HTTPS, which can be on, off or processing.
- originPullProtocol: origin-pull protocol type. HTTP, follow, or HTTPS are supported.
- tagKey: tag key.
Value Array of String Yes Filter field value.
Fuzzy Boolean No Whether to enable fuzzy query. Only origin or domain is supported for the filter field name.
When fuzzy query is enabled, the maximum Value length is 1. When fuzzy query is disabled, the maximum Value length is 5.

DomainLog

Details about a log package download link

Used by actions: DescribeCdnDomainLogs.

Name Type Description
StartTime Timestamp Starting time of the log package
EndTime Timestamp End time of the log package
LogPath String Log package download link
Area String Acceleration region corresponding to the log package
mainland: within Mainland China
overseas: outside Mainland China
LogName String Log package filename

DownstreamCapping

Single link downstream speed limit configuration. This is disabled by default.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes Downstream speed configuration switch
on: enabled
off: disabled
CappingRules Array of CappingRule No Downstream speed limiting rules
Note: this field may return null, indicating that no valid values can be obtained.

ErrorPage

Status code redirect configuration. This is disabled by default. (This feature is in beta and not generally available yet.)

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes Status code redirect configuration switch
on: enabled
off: disabled
Note: this field may return null, indicating that no valid values can be obtained.
PageRules Array of ErrorPageRule No Status code redirect rules configuration
Note: this field may return null, indicating that no valid values can be obtained.

ErrorPageRule

Status code redirect rules configuration

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
StatusCode Integer Yes Status code
Supports 400, 403, 404, 500.
RedirectCode Integer Yes Redirect status code settings
Supports 301 or 302.
RedirectUrl String Yes Redirect URL
Requires a full redirect path, such as https://www.test.com/error.html.

FollowRedirect

301/302 automatic origin-pull follow-redirect configuration. It is disabled by default.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes Origin-pull follow-redirect switch
on: enabled
off: disabled

ForceRedirect

Access protocol forced redirect configuration. This is disabled by default.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes Access forced redirect configuration switch
on: enabled
off: disabled
Note: this field may return null, indicating that no valid values can be obtained.
RedirectType String No Access forced redirect types
http: forced HTTP redirect
https: forced HTTPS redirect
Note: this field may return null, indicating that no valid values can be obtained.
RedirectStatusCode Integer No Status code returned for forced redirect
Supports 301, 302.
Note: this field may return null, indicating that no valid values can be obtained.
CarryHeaders String No Whether to return the added header in forced redirection.
Note: this field may return null, indicating that no valid values can be obtained.

GuetzliAdapter

Image optimization - GuetzliAdapter configuration

Used by actions: DescribeDomainsConfig.

Name Type Required Description
Switch String No Switch. Valid values: on, off
Note: this field may return null, indicating that no valid values can be obtained.

HeaderKey

A part of CacheKey

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String No Whether to use it as part of CacheKey
Note: this field may return null, indicating that no valid values can be obtained.
Value String No Array of headers that make up the CacheKey (separated by ';')
Note: this field may return null, indicating that no valid values can be obtained.

Hsts

HSTS configuration.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes Whether to enable. Valid values: on, off.
MaxAge Integer No MaxAge value.
Note: this field may return null, indicating that no valid values can be obtained.
IncludeSubDomains String No Whether to include subdomain names. Valid values: on, off.
Note: this field may return null, indicating that no valid values can be obtained.

HttpHeaderPathRule

HTTP header setting rules. Up to 100 entries can be set.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
HeaderMode String Yes HTTP header setting methods
add: add header. If a header already exists, then there will be a duplicated header.
del: delete header.
Note: This field may return null, indicating that no valid values can be obtained.
HeaderName String Yes HTTP header name. Up to 100 characters can be set.
Note: this field may return null, indicating that no valid values can be obtained.
HeaderValue String Yes HTTP header value. Up to 1000 characters can be set.
Not required when Mode is del
Required when Mode is add/set
Note: this field may return null, indicating that no valid values can be obtained.
RuleType String Yes Rule types:
all: effective for all files
file: effective for specified file suffixes
directory: effective for specified paths
path: effective for specified absolute paths
Note: this field may return null, indicating that no valid values can be obtained.
RulePaths Array of String Yes Content for each RuleType:
For all, enter an asterisk (*).
For file, enter the suffix, such as jpg, txt.
For directory, enter the path, such as /xxx/test/.
For path, enter the corresponding absolute path, such as /xxx/test.html.
Note: this field may return null, indicating that no valid values can be obtained.

HttpHeaderRule

HTTP header setting rules.

Used by actions: AddCdnDomain, DescribeDomains, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
HeaderMode String Yes HTTP header setting method. Valid values: add (add header), set (set header) or del (delete header).
HeaderName String Yes HTTP header name
HeaderValue String Yes HTTP header value

Https

Domain name HTTPS acceleration configuration. This is disabled by default.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes HTTPS configuration switch
on: enabled
off: disabled
Note: this field may return null, indicating that no valid values can be obtained.
Http2 String No HTTP2 configuration switch
on: enabled
off: disabled
Enabling HTTPS acceleration for the first time will enable HTTP2 configuration by default.
Note: this field may return null, indicating that no valid values can be obtained.
OcspStapling String No OCSP configuration switch
on: enabled
off: disabled
This is disabled by default
Note: this field may return null, indicating that no valid values can be obtained.
VerifyClient String No Client certificate authentication feature
on: enabled
off: disabled
This is disabled by default. The client certificate information is needed when enabled. This is still in beta and not generally available yet.
Note: this field may return null, indicating that no valid values can be obtained.
CertInfo ServerCert No Server certificate configuration information
Note: this field may return null, indicating that no valid values can be obtained.
ClientCertInfo ClientCert No Client certificate configuration information
Note: this field may return null, indicating that no valid values can be obtained.
Spdy String No Spdy configuration switch
on: enabled
off: disabled
This is disabled by default
Note: this field may return null, indicating that no valid values can be obtained.
SslStatus String No HTTPS certificate deployment status
closed: already closed
deploying: in deployment
deployed: successfully deployed
failed: deployment failed
Note: this field may return null, indicating that no valid values can be obtained.
Hsts Hsts No HSTS configuration
TlsVersion Array of String No TLS version settings, which only support certain advanced domain names. Valid values: TLSv1, TLSV1.1, TLSV1.2, and TLSv1.3. Only consecutive versions can be enabled at the same time.
Note: this field may return null, indicating that no valid values can be obtained.

ImageOptimization

ImageOptimization configuration

Used by actions: DescribeDomainsConfig.

Name Type Description
WebpAdapter WebpAdapter WebpAdapter configuration
Note: this field may return null, indicating that no valid values can be obtained.
TpgAdapter TpgAdapter TpgAdapter configuration
Note: this field may return null, indicating that no valid values can be obtained.
GuetzliAdapter GuetzliAdapter GuetzliAdapter configuration
Note: this field may return null, indicating that no valid values can be obtained.

IpFilter

IP blocklist/allowlist configuration. This is disabled by default.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes IP blocklist/allowlist configuration switch
on: enabled
off: disabled
FilterType String No IP blocklist/allowlist type
whitelist: allowlist
blacklist: blocklist
Note: this field may return null, indicating that no valid values can be obtained.
Filters Array of String No IP blocklist/allowlist list
Supports IPs in X.X.X.X format, or /8, /16, /24 format IP ranges.
Up to 50 allowlists or blocklists can be entered
Note: this field may return null, indicating that no valid values can be obtained.
FilterRules Array of IpFilterPathRule No IP blocklist/allowlist path-based configuration. This feature is only available to selected beta customers.
Note: this field may return null, indicating that no valid value is obtained.

IpFilterPathRule

IP blocklist/allowlist path-based configuration

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
FilterType String Yes IP blocklist/allowlist type
whitelist: allowlist IPs
blacklist: blocklist IPs
Note: this field may return null, indicating that no valid value is obtained.
Filters Array of String Yes IP blocklist/allowlist list
Supports IPs in X.X.X.X format, or /8, /16, /24 format IP ranges.
Up to 50 allowlists or blocklists can be entered.
Note: this field may return null, indicating that no valid value is obtained.
RuleType String Yes Rule types:
all: effective for all files
file: effective for specified file suffixes
directory: effective for specified paths
path: effective for specified absolute paths
Note: this field may return null, indicating that no valid value is obtained.
RulePaths Array of String Yes Content for each RuleType:
For all, enter an asterisk (*).
For file, enter the suffix, such as jpg, txt.
For directory, enter the path, such as /xxx/test/.
For path, enter the corresponding absolute path, such as /xxx/test.html.
Note: this field may return null, indicating that no valid value is obtained.

IpFreqLimit

Access limit configuration for a single IP of a single node. This is disabled by default.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
Switch String Yes IP access limit configuration switch
on: enabled
off: disabled
Qps Integer No Sets the limited number of requests per second
514 will be returned for requests that exceed the limit
Note: this f