Data Types

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-06-29 17:13:44

Download PDF

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	Whether to cache the header and body on cache nodes if the origin server returns the header `Set-Cookie`. on: Enable; do not cache the header and body. off: Disable; follow the custom cache rules of cache nodes. It 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 630720000.
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 630720000.
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 630720000.
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 630720000.
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	Whether to ignore the header and body on cache nodes if the origin server returns the header `Set-Cookie`. `on`: Ignore; do not cache the header and body. `off`: Do not ignore; follow the custom cache rules of cache nodes. It is disabled by default. Note: This field may return `null`, indicating that no valid value can be 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.
PostMaxSize	PostSize	POST request configuration item Note: this field may return `null`, indicating that no valid values can be obtained.
Quic	Quic	QUIC configuration 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 `set`: sets a value for an existing header parameter, a new header parameter, or multiple header parameters. Multiple header parameters will be merged into one. `del`: deletes a header parameter. `add`: adds a header parameter. By default, you can repeat the same action to add the same header parameter, which may affect browser response. Please consider the set operation first. 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 field may return null, indicating that no valid values can be obtained.

IpStatus

Node IP information

Used by actions: DescribeIpStatus.

Name	Type	Description
Ip	String	Node IP
District	String	Node region
Isp	String	Node ISP
City	String	Node city
Status	String	Node status online: the node is online; scheduling service running offline: the node is offline

Ipv6

IPv6 activation configurations, which cannot be changed.

Used by actions: AddCdnDomain, DescribeDomainsConfig.

Name	Type	Description
Switch	String	Whether to enable the IPv6 feature for a domain name. Values include `on` or `off`. Note: this field may return null, indicating that no valid values can be obtained.

Ipv6Access

IPv6 access configuration

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable the IPv6 access feature for a domain name. Valid values: `on` and `off`. Note: this field may return `null`, indicating that no valid values can be obtained.

KeyRule

Path-based cache key configuration

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
RulePaths	Array of String	Yes	Content for each CacheType: 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 `index`, enter a backslash (/). Note: this field may return null, indicating that no valid value is obtained.
RuleType	String	Yes	Rule types: `file`: effective for specified file suffixes `directory`: effective for specified paths `path`: effective for specified absolute paths `index`: home page Note: this field may return null, indicating that no valid value is obtained.
FullUrlCache	String	Yes	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) Note: this field may return null, indicating that no valid value is obtained.
IgnoreCase	String	Yes	Whether caches are case insensitive Note: this field may return null, indicating that no valid value is obtained.
QueryString	RuleQueryString	Yes	Request parameter contained in `CacheKey` Note: this field may return null, indicating that no valid value is obtained.
RuleTag	String	Yes	Path cache key tag, the value "user" is passed. Note: this field may return null, indicating that no valid value is obtained.

LogSetInfo

Logset information

Used by actions: ListClsLogTopics.

Name	Type	Description
AppId	Integer	Developer ID
Channel	String	Channel Note: this field may return null, indicating that no valid values can be obtained.
LogsetId	String	Logset ID
LogsetName	String	Logset name
IsDefault	Integer	Whether it is the default logset
LogsetSavePeriod	Integer	Log retention period in days
CreateTime	Timestamp	Creation date
Region	String	Region

MainlandConfig

Specific configuration for domain names in the mainland China by region. UpdateDomainConfig API only supports modification of certain region configurations. A list of differences that may exist for older configurations will be provided for a compatibility check. The supported configuration list is as follows:

Authentication
BandwidthAlert
ErrorPage
IpFilter
Origin
Referer

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Authentication	Authentication	No	Timestamp hotlink protection configuration. Note: this field may return null, indicating that no valid values can be obtained.
BandwidthAlert	BandwidthAlert	No	Bandwidth cap configuration. Note: this field may return null, indicating that no valid values can be obtained.
Cache	Cache	No	Cache rules configuration. Note: this field may return null, indicating that no valid values can be obtained.
CacheKey	CacheKey	No	Cache configurations. Note: this field may return null, indicating that no valid values can be obtained.
Compression	Compression	No	Smart compression configuration. Note: this field may return null, indicating that no valid values can be obtained.
DownstreamCapping	DownstreamCapping	No	Download speed limit configuration. Note: this field may return null, indicating that no valid values can be obtained.
ErrorPage	ErrorPage	No	Error code redirect configuration. Note: this field may return null, indicating that no valid values can be obtained.
FollowRedirect	FollowRedirect	No	301 and 302 automatic origin-pull follow-redirect configuration. Note: this field may return null, indicating that no valid values can be obtained.
ForceRedirect	ForceRedirect	No	Access protocol forced redirect configuration. Note: this field may return null, indicating that no valid values can be obtained.
Https	Https	No	HTTPS configuration. Note: this field may return null, indicating that no valid values can be obtained.
IpFilter	IpFilter	No	IP blocklist/allowlist configuration. Note: this field may return null, indicating that no valid values can be obtained.
IpFreqLimit	IpFreqLimit	No	IP access limit configuration. Note: this field may return null, indicating that no valid values can be obtained.
MaxAge	MaxAge	No	Browser cache rules configuration. Note: this field may return null, indicating that no valid values can be obtained.
Origin	Origin	No	Origin server configuration. Note: this field may return null, indicating that no valid values can be obtained.
OriginPullOptimization	OriginPullOptimization	No	Cross-border optimization configuration. Note: this field may return null, indicating that no valid values can be obtained.
RangeOriginPull	RangeOriginPull	No	Range GETs configuration. Note: this field may return null, indicating that no valid values can be obtained.
Referer	Referer	No	Hotlink protection configuration. Note: this field may return null, indicating that no valid values can be obtained.
RequestHeader	RequestHeader	No	Origin-pull request header configuration. Note: this field may return null, indicating that no valid values can be obtained.
ResponseHeader	ResponseHeader	No	Origin server response header configuration. Note: this field may return null, indicating that no valid values can be obtained.
ResponseHeaderCache	ResponseHeaderCache	No	Follows origin server cache header configuration. Note: this field may return null, indicating that no valid values can be obtained.
Seo	Seo	No	SEO configuration. Note: this field may return null, indicating that no valid values can be obtained.
ServiceType	String	No	Domain name service type. `web`: static acceleration; `download`: download acceleration; `media`: streaming media acceleration. Note: this field may return null, indicating that no valid values can be obtained.
StatusCodeCache	StatusCodeCache	No	Status code cache configuration. Note: this field may return null, indicating that no valid values can be obtained.
VideoSeek	VideoSeek	No	Video dragging configuration. Note: this field may return null, indicating that no valid values can be obtained.

MapInfo

Mapping between a name and an ID

Used by actions: DescribeMapInfo.

Name	Type	Description
Id	Integer	Object ID
Name	String	Object name

MaxAge

Browser cache rule configuration. This is used to set the MaxAge default value and 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	Browser cache configuration switch on: enabled off: disabled Note: this field may return null, indicating that no valid values can be obtained.
MaxAgeRules	Array of MaxAgeRule	No	MaxAge rule Note: this field may return null, indicating that no valid values can be obtained.

MaxAgeRule

MaxAge rules configuration

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
MaxAgeType	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. `index`: effective for specified homepages.
MaxAgeContents	Array of String	Yes	Content for each `MaxAgeType`: For `all`, enter a wildcard `*`. For `file`, enter a suffix, e.g., `jpg` or `txt`. For `directory`, enter a path, e.g., `/xxx/test/`. For `path`, enter an absolute path, e.g., `/xxx/test.html`. For `index`, enter a forward slash `/`. Note: the rule `all` cannot be deleted. It follows origin by default and can be modified.
MaxAgeTime	Integer	Yes	MaxAge time (in seconds) Note: the value `0` means not to cache.
FollowOrigin	String	No	Whether to follow the origin server. Valid values: `on` and `off`. If it's on, `MaxAgeTime` is ignored. Note: this field may return `null`, indicating that no valid values can be obtained.

OfflineCache

Whether to enable offline cache

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable offline cache. Valid values: `on` and `off`.

Origin

Complex origin server configurations. The following configurations are supported:

Origin server specified as a single domain name
Origin server specified as multiple IPs. Supported port range: 1-65535; Supported weight range: 1-100. Format: IP:Port:Weight.
Origin-pull domain name configuration
Cloud Object Storage (COS) specified as origin server
Hot backup origin server specified as a single domain name
Hot backup origin server specified as multiple IPs. Supported port range: 1-65535. At present, weight configuration is not supported.
Hot backup origin server origin-pull domain name configuration

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

Name	Type	Required	Description
Origins	Array of String	No	Master origin server list When modifying the origin server, you need to enter the corresponding OriginType. Note: this field may return null, indicating that no valid values can be obtained.
OriginType	String	No	Master origin server type The following types are supported for input parameters: domain: domain name type cos: COS origin ip: IP list used as origin server ipv6: origin server list is a single IPv6 address ip_ipv6: origin server list is multiple IPv4 addresses and an IPv6 address The following types of output parameters are added: image: Cloud Infinite origin ftp: legacy FTP origin, which is no longer maintained. When modifying `Origins`, you need to enter the corresponding OriginType. The IPv6 feature is not generally available yet. Please send in a whitelist application to use this feature. Note: this field may return null, indicating that no valid values can be obtained.
ServerName	String	No	Host header used when accessing the master origin server. If left empty, the acceleration domain name will be used by default. If a wildcard domain name is accessed, then the sub-domain name during the access will be used by default. Note: this field may return null, indicating that no valid values can be obtained.
CosPrivateAccess	String	No	When OriginType is COS, you can specify if access to private buckets is allowed. Note: to enable this configuration, you need to first grant CDN access to the private bucket. Note: this field may return null, indicating that no valid values can be obtained.
OriginPullProtocol	String	No	Origin-pull protocol configuration http: forced HTTP origin-pull follow: protocol follow origin-pull https: forced HTTPS origin-pull. This only supports origin server port 443 for origin-pull. Note: this field may return null, indicating that no valid values can be obtained.
BackupOrigins	Array of String	No	Backup origin server list When modifying the backup origin server, you need to enter the corresponding BackupOriginType. Note: this field may return null, indicating that no valid values can be obtained.
BackupOriginType	String	No	Backup origin server type, which supports the following types: domain: domain name type ip: IP list used as origin server When modifying BackupOrigins, you need to enter the corresponding BackupOriginType. Note: this field may return null, indicating that no valid values can be obtained.
BackupServerName	String	No	Host header used when accessing the backup origin server. If left empty, the ServerName of master origin server will be used by default. Note: this field may return null, indicating that no valid values can be obtained.
BasePath	String	No
PathRules	Array of PathRule	No	Origin URL rewrite rule configuration Note: this field may return `null`, indicating that no valid values can be obtained.
PathBasedOrigin	Array of PathBasedOriginRule	No	Path-based origin-pull configurations Note: this field may return `null`, indicating that no valid values can be obtained.

OriginAuthentication

Origin-pull authentication advanced configuration

Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	Authentication switch, which can be on or off. Note: this field may return `null`, indicating that no valid values can be obtained.
TypeA	OriginAuthenticationTypeA	No	Authentication type configuration A Note: this field may return `null`, indicating that no valid values can be obtained.

OriginAuthenticationTypeA

Origin-pull authentication advanced configuration TypeA

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.

OriginCombine

Merging pull requests configurations

Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable the merging pull requests feature. Valid values: `on` and `off`.

OriginIp

IP information of CDN intermediate nodes

Used by actions: DescribeCdnOriginIp.

Name	Type	Description
Ip	String	Intermediate IP range/intermediate IP. The IP range information is returned by default.

OriginPullOptimization

Cross-border origin-pull optimization 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	Cross-border origin-pull optimization configuration switch on: enabled off: disabled
OptimizationType	String	No	Cross-border types OVToCN: origin-pull from outside mainland China to inside mainland China CNToOV: origin-pull from inside mainland China to outside mainland China Note: this field may return null, indicating that no valid values can be obtained.

OriginPullTimeout

Origin-pull timeout configuration

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
ConnectTimeout	Integer	Yes	The origin-pull connection timeout (in seconds). Valid range: 5-60. Note: this field may return null, indicating that no valid values can be obtained.
ReceiveTimeout	Integer	Yes	The origin-pull receipt timeout (in seconds). Valid range: 10-60. Note: this field may return null, indicating that no valid values can be obtained.

OverseaConfig

Specific configuration for domain names outside mainland China. UpdateDomainConfig API only supports modification of some region configurations. A list of differences that may exist for older configurations will be provided for a compatibility check. The supported configuration list is as follows:

Authentication
BandwidthAlert
ErrorPage
IpFilter
Origin
Referer

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Authentication	Authentication	No	Timestamp hotlink protection configuration. Note: this field may return null, indicating that no valid values can be obtained.
BandwidthAlert	BandwidthAlert	No	Bandwidth cap configuration. Note: this field may return null, indicating that no valid values can be obtained.
Cache	Cache	No	Cache rules configuration. Note: this field may return null, indicating that no valid values can be obtained.
CacheKey	CacheKey	No	Cache configurations. Note: this field may return null, indicating that no valid values can be obtained.
Compression	Compression	No	Smart compression configuration. Note: this field may return null, indicating that no valid values can be obtained.
DownstreamCapping	DownstreamCapping	No	Download speed limit configuration. Note: this field may return null, indicating that no valid values can be obtained.
ErrorPage	ErrorPage	No	Error code redirect configuration. Note: this field may return null, indicating that no valid values can be obtained.
FollowRedirect	FollowRedirect	No	301 and 302 automatic origin-pull follow-redirect configuration. Note: this field may return null, indicating that no valid values can be obtained.
ForceRedirect	ForceRedirect	No	Access protocol forced redirect configuration. Note: this field may return null, indicating that no valid values can be obtained.
Https	Https	No	HTTPS configuration. Note: this field may return null, indicating that no valid values can be obtained.
IpFilter	IpFilter	No	IP blocklist/allowlist configuration. Note: this field may return null, indicating that no valid values can be obtained.
IpFreqLimit	IpFreqLimit	No	IP access limit configuration. Note: this field may return null, indicating that no valid values can be obtained.
MaxAge	MaxAge	No	Browser cache rules configuration. Note: this field may return null, indicating that no valid values can be obtained.
Origin	Origin	No	Origin server configuration. Note: this field may return null, indicating that no valid values can be obtained.
OriginPullOptimization	OriginPullOptimization	No	Cross-border optimization configuration. Note: this field may return null, indicating that no valid values can be obtained.
RangeOriginPull	RangeOriginPull	No	Range GETs configuration. Note: this field may return null, indicating that no valid values can be obtained.
Referer	Referer	No	Hotlink protection configuration. Note: this field may return null, indicating that no valid values can be obtained.
RequestHeader	RequestHeader	No	Origin-pull request header configuration. Note: this field may return null, indicating that no valid values can be obtained.
ResponseHeader	ResponseHeader	No	Origin server response header configuration. Note: this field may return null, indicating that no valid values can be obtained.
ResponseHeaderCache	ResponseHeaderCache	No	Follows origin server cache header configuration. Note: this field may return null, indicating that no valid values can be obtained.
Seo	Seo	No	SEO configuration. Note: this field may return null, indicating that no valid values can be obtained.
ServiceType	String	No	Domain name service type. `web`: static acceleration; `download`: download acceleration; `media`: streaming media acceleration. Note: this field may return null, indicating that no valid values can be obtained.
StatusCodeCache	StatusCodeCache	No	Status code cache configuration. Note: this field may return null, indicating that no valid values can be obtained.
VideoSeek	VideoSeek	No	Video dragging configuration. Note: this field may return null, indicating that no valid values can be obtained.

PathBasedOriginRule

Path-based origin-pull rules

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

Name	Type	Required	Description
RuleType	String	Yes	Rule types: `file`: effective for files with specified suffixes. `directory`: effective for specified paths. `path`: effective for specified absolute paths. `index`: effective for specified homepages.
RulePaths	Array of String	Yes	Content for each `RuleType`: For `file`, enter a suffix, e.g., `jpg` or `txt`. For `directory`, enter a path, e.g., `/xxx/test/`. For `path`, enter an absolute path, e.g., `/xxx/test.html`. For `index`, enter a forward slash `/`.
Origin	Array of String	Yes	Origin server list. Domain names and IPv4 addresses are supported.

PathRule

Path-based origin-pull configuration rules

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

Name	Type	Required	Description
Regex	Boolean	Yes	Whether to enable wildcard match (`*`). false: disable true: enable Note: this field may return `null`, indicating that no valid values can be obtained.
Path	String	Yes	Matched URL. Only URLs are supported, while parameters are not. The exact match is used by default. If wildcard match is enabled, up to 5 wildcards are supported. The URL can contain up to 1,024 characters. Note: this field may return `null`, indicating that no valid values can be obtained.
Origin	String	No	Origin server when the path matches. COS origin with private read/write is not supported. The default origin server will be used by default when this field is left empty. Note: this field may return `null`, indicating that no valid values can be obtained.
ServerName	String	No	Origin server host header when the path matches. The default `ServerName` will be used by default when this field is left empty. Note: this field may return `null`, indicating that no valid values can be obtained.
OriginArea	String	No	Origin server region. Valid values: `CN` and `OV`. CN: the Chinese mainland OV: outside the Chinese mainland Default value: `CN`. Note: this field may return `null`, indicating that no valid values can be obtained.
ForwardUri	String	No	Origin server URI path when the path matches, starting with `/` and excluding parameters. The path can contain up to 1,024 characters. The wildcards in the match path can be respectively captured using `$1`, `$2`, `$3`, `$4`, and `$5`. Up to 10 values can be captured. Note: this field may return `null`, indicating that no valid values can be obtained.
RequestHeaders	Array of HttpHeaderRule	No	Origin-pull header setting when the path matches. Note: this field may return `null`, indicating that no valid value is obtained.

PostSize

Maximum size of the file uploaded for streaming via a POST request

Used by actions: DescribeDomainsConfig.

Name	Type	Required	Description
Switch	String	Yes	Limit the size of a POST request. The default value is 32 MB. off: Disable on: Enable
MaxSize	Integer	No	Maximum size. Value range: 1 MB to 200 MB.

PurgeTask

Purge task details.

Used by actions: DescribePurgeTasks.

Name	Type	Description
TaskId	String	Purge task ID
Url	String	Purged URL
Status	String	Purge task status `fail`: purge failed `done`: purge succeeded `process`: purge in progress
PurgeType	String	Purge type `url`: URL purge `path`: directory purge
FlushType	String	Purge method `flush`: purges updated resources; this type is available only for directory purges `delete`: purges all resources
CreateTime	Timestamp	Purge task submission time

PushTask

Prefetch task details.

Used by actions: DescribePushTasks.

Name	Type	Description
TaskId	String	Prefetch task ID
Url	String	Prefetched URL
Status	String	Prefetch task status `fail`: prefetch failed `done`: prefetch succeeded `process`: prefetch in progress
Percent	Integer	Prefetch progress in percentage
CreateTime	Timestamp	Prefetch task submission time
Area	String	Prefetch region `mainland`: within Mainland China `overseas`: outside Mainland China `global`: global
UpdateTime	Timestamp	Prefetch task update time Note: this field may return null, indicating that no valid values can be obtained.

QueryStringKey

A part of CacheKey

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	Whether to use `QueryString` as part of `CacheKey`. Valid values: on, off Note: this field may return null, indicating that no valid values can be obtained.
Reorder	String	No	Whether to sort again Note: this field may return null, indicating that no valid values can be obtained.
Action	String	No	Include/exclude query parameters. Valid values: `includeAll`, `excludeAll`, `includeCustom`, `excludeAll` Note: this field may return null, indicating that no valid values can be obtained.
Value	String	No	Array of included/excluded URL parameters (separated by ';') Note: this field may return null, indicating that no valid values can be obtained.

Quic

QUIC configuration item

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable QUIC

Quota

Purge/Prefetch available usage and quota

Used by actions: DescribePurgeQuota, DescribePushQuota.

Name	Type	Description
Batch	Integer	Quota limit for one batch submission request.
Total	Integer	Daily submission quota limit.
Available	Integer	Remaining daily submission quota.
Area	String	Quota region.

RangeOriginPull

Range GETs configuration which is enabled by default

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	Range GETs configuration switch on: enabled off: disabled

Referer

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

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	Referer blocklist/allowlist configuration switch on: enabled off: disabled
RefererRules	Array of RefererRule	No	Referer blocklist/allowlist configuration rule Note: this field may return null, indicating that no valid values can be obtained.

RefererRule

Referer blocklist/allowlist configuration rules, which is effective for specific resources.

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.
RefererType	String	Yes	Referer configuration types whitelist: allowlist blacklist: blocklist
Referers	Array of String	Yes	Referer content list
AllowEmpty	Boolean	Yes	Whether to allow empty referer true: allow empty referer false: do not allow empty referer

RegionMapRelation

Association between a region ID and sub-region IDs.

Used by actions: DescribeMapInfo.

Name	Type	Description
RegionId	Integer	Region ID
SubRegionIdList	Array of Integer	List of sub-region IDs

ReportData

CDN report data

Used by actions: DescribeReportData.

Name	Type	Description
ResourceId	String	Project ID/domain name ID.
Resource	String	Project name/domain name.
Value	Integer	Total traffic/max bandwidth in bytes and bps, respectively.
Percentage	Float	Percentage of individual resource out of all resources.
BillingValue	Integer	Total billable traffic/max billable bandwidth in bytes and bps, respectively.
BillingPercentage	Float	Percentage of billable amount out of total amount.

RequestHeader

Custom request header configuration. This is disabled by default.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	Custom request header configuration switch on: enabled off: disabled
HeaderRules	Array of HttpHeaderPathRule	No	Custom request header configuration rules Note: this field may return null, indicating that no valid values can be obtained.

ResourceBillingData

Billing data details

Used by actions: DescribeBillingData.

Name	Type	Description
Resource	String	Resource name, which is categorized as follows based on different query conditions: Specific domain name: domain name details multiDomains: aggregated details of multiple domain names Project ID: displays the ID of the specified project to be queried all: the details at the account level
BillingData	Array of CdnData	Billing data details

ResourceData

This API is used to query an object and its access details

Used by actions: DescribeCdnData, DescribeIpVisit.

Name	Type	Description
Resource	String	Resource name, which is classified as follows based on different query conditions: A specific domain name: This indicates the details of this domain name multiDomains: This indicates the aggregate details of multiple domain names Project ID: This displays the ID of the specifically queried project all: This indicates the details at the account level
CdnData	Array of CdnData	Data details of a resource

ResourceOriginData

This API is used to query an object and its origin-pull details

Used by actions: DescribeOriginData.

Name	Type	Description
Resource	String	Resource name, which is classified as follows based on different query conditions: A specific domain name: This indicates the details of this domain name multiDomains: This indicates the aggregate details of multiple domain names Project ID: This displays the ID of the specifically queried project all: This indicates the details at the account level
OriginData	Array of CdnData	Origin-pull data details

ResponseHeader

Custom response header configuration. This is disabled by default.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	Custom response header switch on: enabled off: disabled
HeaderRules	Array of HttpHeaderPathRule	No	Custom response header rules Note: this field may return null, indicating that no valid values can be obtained.

ResponseHeaderCache

Origin server header cache configuration. This is enabled by default and caches all the header information.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	Origin server header cache switch on: enabled off: disabled

Revalidate

Whether to forward to the origin server for verification

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	Whether to always forward to the origin server for verification. Valid values: on, off Note: this field may return null, indicating that no valid values can be obtained.
Path	String	No	Forwards to the origin server for verification only for specific request path Note: this field may return null, indicating that no valid values can be obtained.

RuleCache

Path-based cache rule configuration
The cache expiration time for all files is 30 days by default.
Static acceleration type domain names .php, .jsp, .asp, and .aspx are not cached by default.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
RulePaths	Array of String	Yes	Content for each `CacheType`: For `all`, enter a wildcard `*`. For `file`, enter the suffix, e.g., `jpg` or `txt`. For `directory`, enter the path, e.g., `/xxx/test/`. For `path`, enter the absolute path, e.g., `/xxx/test.html`. For `index`, enter a forward slash `/`. 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. `index`: homepage. Note: This field may return `null`, indicating that no valid values can be obtained.
CacheConfig	RuleCacheConfig	Yes	Cache configuration Note: this field may return null, indicating that no valid value is obtained.

RuleCacheConfig

Path cache configuration, choose one from the following three cache modes.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Cache	CacheConfigCache	Yes	Cache configuration Note: this field may return `null`, indicating that no valid value is obtained.
NoCache	CacheConfigNoCache	Yes	No cache configuration Note: this field may return null, indicating that no valid value is obtained.
FollowOrigin	CacheConfigFollowOrigin	Yes	Follows the origin server configuration Note: this field may return null, indicating that no valid value is obtained.

RuleQueryString

Configuration to retain query strings for this path

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	Whether to use `QueryString` as part of `CacheKey`. Valid values: on, off Note: this field may return null, indicating that no valid value is obtained.
Action	String	Yes	`includeCustom` will retain partial query strings Note: this field may return null, indicating that no valid value is obtained.
Value	String	Yes	Array of included/excluded query strings (separated by ';') Note: this field may return null, indicating that no valid value is obtained.

ScdnAclConfig

SCDN access control

Used by actions: UpdateScdnDomain.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable. Valid values: `on` and `off`.
ScriptData	Array of ScdnAclGroup	No	ACL rule group, which is required when the access control is on. Note: this field may return `null`, indicating that no valid values can be obtained.
ErrorPage	ScdnErrorPage	No	Error page configuration Note: this field may return `null`, indicating that no valid values can be obtained.

ScdnAclGroup

SCDN precise access control configuration

Used by actions: UpdateScdnDomain.

Name	Type	Required	Description
RuleName	String	Yes	Rule name
Configure	Array of ScdnAclRule	Yes	Specific configurations
Result	String	Yes	Rule action, which is generally `refuse`.
Status	String	No	Whether the rule is effective. Valid values: `active` and `inactive`.

ScdnAclRule

Precise access control match rule

Used by actions: UpdateScdnDomain.

Name	Type	Required	Description
MatchKey	String	Yes	Match keywords. Valid values: `params`, `url`, `ip`, `referer`, and `user-agent`.
LogiOperator	String	Yes	Logical operator. Valid values: `exclude`, `include`, `notequal`, `equal`, `len-less`, `len-equal`, and `len-more`.
MatchValue	String	Yes	Match value

ScdnBotConfig

Bot configuration

Used by actions: UpdateScdnDomain.

Name	Type	Required	Description
Switch	String	Yes	Valid values: `on` and `off`.
BotCookie	Array of BotCookie	No	Bot cookie policy Note: this field may return `null`, indicating that no valid values can be obtained.
BotJavaScript	Array of BotJavaScript	No	Bot JS policy Note: this field may return `null`, indicating that no valid values can be obtained.

ScdnCCRules

SCDN custom CC rules

Used by actions: UpdateScdnDomain.

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. `index`: effective for web homepages and root directories.
RuleValue	Array of String	Yes	Rule value (blocking condition)
Qps	Integer	No	IP access limit rule
DetectionTime	Integer	No	Detection granularity Note: this field may return `null`, indicating that no valid values can be obtained.
FrequencyLimit	Integer	No	Frequency threshold Note: this field may return `null`, indicating that no valid values can be obtained.
PunishmentSwitch	String	No	Whether to block or redirect requests from suspicious IPs. Valid values: `on` and `off`. Note: this field may return `null`, indicating that no valid values can be obtained.
PunishmentTime	Integer	No	Suspicious IP restriction duration Note: this field may return `null`, indicating that no valid values can be obtained.
Action	String	No	Action. Valid values: `intercept` and `redirect`. Note: this field may return `null`, indicating that no valid values can be obtained.
RedirectUrl	String	No	The redirection target URL used when the `Action` is `redirect` Note: this field may return `null`, indicating that no valid values can be obtained.

ScdnConfig

CC attack defense configuration

Used by actions: UpdateScdnDomain.

Name	Type	Required	Description
Switch	String	Yes	Valid values: `on` and `off`.
Rules	Array of ScdnCCRules	No	Custom CC attack defense rule Note: this field may return `null`, indicating that no valid values can be obtained.

ScdnDdosConfig

DDoS configuration

Used by actions: UpdateScdnDomain.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable DDoS defense. Valid values: `on` and `off`.

ScdnErrorPage

ACL error page

Used by actions: UpdateScdnDomain.

Name	Type	Required	Description
RedirectCode	Integer	Yes	Status code
RedirectUrl	String	Yes	Redirection URL

ScdnWafConfig

WAF configuration

Used by actions: UpdateScdnDomain.

Name	Type	Required	Description
Switch	String	Yes	Whether to enable WAF. Valid values: `on` and `off`.
Mode	String	No	WAF protection mode. Valid values: `intercept` and `observe`. Default value: `intercept`. Note: this field may return `null`, indicating that no valid values can be obtained.
ErrorPage	ScdnErrorPage	No	Redirection error page Note: this field may return `null`, indicating that no valid values can be obtained.
WebShellSwitch	String	No	Whether to enable Web shell blocking. Valid values: `on` and `off`. Default value: `off`. Note: this field may return `null`, indicating that no valid values can be obtained.
Rules	Array of ScdnWafRule	No	Attack blocking rules Note: this field may return `null`, indicating that no valid values can be obtained.
Level	Integer	No	WAF rule level. Valid values: 100, 200, and 300. Note: this field may return `null`, indicating that no valid values can be obtained.
SubRuleSwitch	Array of WafSubRuleStatus	No	WAF sub-rule switch Note: this field may return `null`, indicating that no valid values can be obtained.

ScdnWafRule

WAF rule information

Used by actions: UpdateScdnDomain.

Name	Type	Required	Description
AttackType	String	Yes	Attack type
Operate	String	Yes	Defense action. Valid value: `observe`.

SchemeKey

A part of CacheKey

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	Whether to use the scheme as part of the cache key. Valid values: on, off Note: this field may return null, indicating that no valid values can be obtained.

SecurityConfig

SCDN configuration

Used by actions: DescribeDomainsConfig.

Name	Type	Description
Switch	String	on\|off

Seo

SEO configuration. This is disabled by default.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	SEO configuration switch on: enabled off: disabled Note: this field may return null, indicating that no valid values can be obtained.

ServerCert

HTTPS acceleration server certificate configuration:

Supports deployment with certificates that are being hosted by the SSL Certificate Services
Supports uploading certificates of PEM format for deployment
Note: when uploading certificates of PEM format, the Base64 encoding is required.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
CertId	String	No	Server certificate ID This is auto-generated when the certificate is being hosted by the SSL Certificate Service Note: this field may return null, indicating that no valid values can be obtained.
CertName	String	No	Server certificate name This is auto-generated when the certificate is being hosted by the SSL Certificate Service Note: this field may return null, indicating that no valid values can be obtained.
Certificate	String	No	Server certificate information This is required when uploading an external certificate, which should contain the complete certificate chain. Note: this field may return null, indicating that no valid values can be obtained.
PrivateKey	String	No	Server key information This is required when uploading an external certificate. Note: this field may return null, indicating that no valid values can be obtained.
ExpireTime	Timestamp	No	Certificate expiration time Can be left blank when used as an input parameter Note: this field may return null, indicating that no valid values can be obtained.
DeployTime	Timestamp	No	Certificate issuance time Can be left blank when used as an input parameter Note: this field may return null, indicating that no valid values can be obtained.
Message	String	No	Certificate remarks Note: this field may return null, indicating that no valid values can be obtained.

SimpleCache

Cache configuration basic version
The cache expiration time for all files is 30 days by default.
Static acceleration type domain names .php, .jsp, .asp, and .aspx are not cached by default
Note: this version does not support setting cache expiration rules if the origin server does not return max-age

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
CacheRules	Array of SimpleCacheRule	Yes	Cache expiration time rules Note: this field may return null, indicating that no valid values can be obtained.
FollowOrigin	String	Yes	Follows origin server Cache-Control: max-age configurations on: enabled off: disabled If this is enabled, resources that do not match CacheRules rules will be cached by the node according to the max-age value returned by the origin server. Resources that match CacheRules rules will be cached on the node according to the cache expiration time set in CacheRules. This conflicts with CompareMaxAge. The two cannot be enabled at the same time. Note: this field may return null, indicating that no valid values can be obtained.
IgnoreCacheControl	String	Yes	Forced 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 values can be obtained.
IgnoreSetCookie	String	Yes	Ignores the Set-Cookie header of the 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.
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: enabled off: disabled This is disabled by default Note: this field may return null, indicating that no valid values can be obtained.
Revalidate	Revalidate	No	Always forwards to the origin server for verification Note: this field may return null, indicating that no valid values can be obtained.

SimpleCacheRule

Cache expiration rules configuration

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 index: home page
CacheContents	Array of String	Yes	Content for each CacheType: Enter `*` for `all` Enter an extension for `file`, such as `jpg` or `txt` Enter a path for `directory`, such as `/xxx/test` Enter an absolute path for `path`, such as `/xxx/test.html` Enter `/` for `index`
CacheTime	Integer	Yes	Cache expiration time settings Unit: second. The maximum value is 365 days.

Sort

Sorting conditions for query results.

Used by actions: DescribeDomainsConfig.

Name	Type	Required	Description
Key	String	No	Fields that can be sorted. Currently supports: `createTime`: domain name creation time. `certExpireTime`: certificate expiration time. Default value: createTime.
Sequence	String	No	`asc` or `desc`. Default: `desc`.

SpecificConfig

Specific configuration for domain names inside and outside mainland China by regions.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Mainland	MainlandConfig	No	Specific configuration for domain name inside mainland China. Note: this field may return null, indicating that no valid values can be obtained.
Overseas	OverseaConfig	No	Specific configuration for domain name outside mainland China. Note: this field may return null, indicating that no valid values can be obtained.

StatusCodeCache

Status code cache expiration configuration. 404 status codes are cached for 10 seconds by default

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

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

StatusCodeCacheRule

Status code cache expiration time rule configuration

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
StatusCode	String	Yes	HTTP status code Supports 403 and 404 status codes
CacheTime	Integer	Yes	Status code cache expiration time (in seconds)

SummarizedData

Aggregate values of details; each metric has different aggregation methods based on its characteristics

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

Name	Type	Description
Name	String	Aggregation method, which can be: sum: aggregate summation max: maximum value; in bandwidth mode, the peak bandwidth is calculated based on the aggregate data with 5-minute granularity. avg: average value
Value	Float	Aggregate data value

Tag

Domain name tag configuration

Used by actions: AddCdnDomain, DescribeDomainsConfig.

Name	Type	Required	Description
TagKey	String	Yes	Tag key Note: this field may return null, indicating that no valid value is obtained.
TagValue	String	Yes	Tag value. Note: this field may return null, indicating that no valid value is obtained.

TimestampData

Timestamp and its corresponding value

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

Name	Type	Description
Time	Timestamp	Statistical point in time in forward rounding mode Taking the 5-minute granularity as an example, 13:35:00 indicates that the statistical interval is between 13:35:00 and 13:39:59.
Value	Float	Data value

TopData

Data structure of sorted data

Used by actions: ListTopData.

Name	Type	Description
Resource	String	Resource name, which is classified as follows based on different query conditions: A specific domain name: This indicates the details of this domain name multiDomains: This indicates the aggregate details of multiple domain names Project ID: This displays the ID of the specifically queried project all: This indicates the details at the account level
DetailData	Array of TopDetailData	Detailed sorting results

TopDetailData

Data structure of sorted data

Used by actions: ListTopData.

Name	Type	Description
Name	String	Datatype name
Value	Float	Data value

TopicInfo

CLS topic information

Used by actions: ListClsLogTopics.

Name	Type	Description
TopicId	String	Topic ID
TopicName	String	Topic name
Enabled	Integer	Whether to enable publishing
CreateTime	Timestamp	Creation time Note: this field may return null, indicating that no valid values can be obtained.

TpgAdapter

Image optimization - TpgAdapter 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.

UrlRecord

Details of the blocked URLs

Used by actions: GetDisableRecords.

Name	Type	Description
Status	String	Status (disable: blocked; enable: unblocked) Note: This field may return null, indicating that no valid values can be obtained.
RealUrl	String	Corresponding URL Note: This field may return null, indicating that no valid values can be obtained.
CreateTime	String	Creation time Note: This field may return null, indicating that no valid values can be obtained.
UpdateTime	String	Update time Note: This field may return null, indicating that no valid values can be obtained.

UrlRedirect

URL redirect configuration

Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	URL redirect configuration switch on: enabled off: disabled
PathRules	Array of UrlRedirectRule	No	URL redirect rule, which is required if `Switch` is `on`. There can be up to 10 rules. Note: this field may return null, indicating that no valid values can be obtained.

UrlRedirectRule

URL redirect rule configuration

Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
RedirectStatusCode	Integer	Yes	Redirect status code. Valid values: 301, 302
Pattern	String	Yes	URL to be matched. Only URLs are supported, while parameters are not. The exact match is used by default. In regex match, up to 5 wildcards `*` are supported. The URL can contain up to 1,024 characters.
RedirectUrl	String	Yes	Target URL, starting with `/` and excluding parameters. The path can contain up to 1,024 characters. The wildcards in the matching path can be respectively captured using `$1`, `$2`, `$3`, `$4`, and `$5`. Up to 10 values can be captured.
RedirectHost	String	No	Target host. It should be a standard domain name starting with `http://` or `https://`. If it is left empty, “http://[current domain name]” will be used by default. Note: this field may return `null`, indicating that no valid values can be obtained.

UserAgentFilter

UserAgent blocklist/allowlist configuration

Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	Switch. Valid values: on, off Note: this field may return null, indicating that no valid values can be obtained.
FilterRules	Array of UserAgentFilterRule	No	UA blocklist/allowlist effect rule list Note: this field may return null, indicating that no valid values can be obtained.

UserAgentFilterRule

UserAgent blocklist/allowlist rule configuration

Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
RuleType	String	Yes	Effective access path type all: all access paths are effective file: effective by file extension directory: effective by directory path: effective by full access path Note: this field may return null, indicating that no valid values can be obtained.
RulePaths	Array of String	Yes	Effective access paths Note: this field may return null, indicating that no valid values can be obtained.
UserAgents	Array of String	Yes	`UserAgent` list Note: this field may return null, indicating that no valid values can be obtained.
FilterType	String	Yes	blocklist or allowlist. Valid values: blacklist, whitelist Note: this field may return null, indicating that no valid values can be obtained.

VideoSeek

Video dragging configuration. This is disabled by default.

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name	Type	Required	Description
Switch	String	Yes	Video dragging switch on: enabled off: disabled

ViolationUrl

Details of URLs in violation

Used by actions: DescribeUrlViolations.

Name	Type	Description
Id	Integer	ID
RealUrl	String	Origin access URL of the resource in violation
DownloadUrl	String	Snapshot path. This is used to display a snapshot of the content in violation on the console.
UrlStatus	String	Current status of the resources in violation forbid: blocked release: unblocked delay: processing delayed reject: appeal dismissed. The status is still blocked. complain: appeal in process
CreateTime	Timestamp	Creation time
UpdateTime	Timestamp	Update time

WafSubRuleStatus

WAF sub-rule switch status

Used by actions: UpdateScdnDomain.

Name	Type	Required	Description
Switch	String	Yes	Sub-rule status. Valid values: `on` and `off`.
SubIds	Array of Integer	Yes	List of rule IDs

WebpAdapter

Image optimization - WebpAdapter 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.

About Tencent Cloud
Help & Support
User Center
Resources
7x24 Hotline
- Hong Kong, China
  +852 800-964-163 (Toll Free)
- +852 800 906 020 (Toll Free)
- United States
  +1 888-652-2736 (Toll Free)
- +1 844 606 0804 (Toll Free)
- Canada
  +1 888 605 7930 (Toll Free)
- England
  +44 808 196 4551 (Toll Free)
- Australia
  +61 1300 986 386 (Toll Free)
- Korea
  +82 080-899-3166 (Toll Free; local time: 9:00—12:00, 13:00-18:00)
- Local hotline to be supported for more regions

Sign Up

Log in

Recent Pages

Data Types

AccessControl

AccessControlRule

AdvanceCacheRule

AdvanceConfig

AdvancedAuthentication

AdvancedAuthenticationTypeA

AdvancedAuthenticationTypeB

AdvancedAuthenticationTypeC

AdvancedAuthenticationTypeD

AdvancedAuthenticationTypeE

AdvancedAuthenticationTypeF

AdvancedCache

Authentication

AuthenticationTypeA

AuthenticationTypeB

AuthenticationTypeC

AuthenticationTypeD

AwsPrivateAccess

BandwidthAlert

BotCookie

BotJavaScript

BriefDomain

Cache

CacheConfigCache

CacheConfigFollowOrigin

CacheConfigNoCache

CacheKey

CacheOptResult

CacheTagKey

CappingRule

CdnData

CdnIp

CdnIpHistory

ClientCert

ClsLogObject

ClsSearchLogs

Compatibility

Compression

CompressionRule

CookieKey

DetailDomain

DomainAreaConfig

DomainFilter

DomainLog

DownstreamCapping

ErrorPage

ErrorPageRule

FollowRedirect

ForceRedirect

GuetzliAdapter

HeaderKey

Hsts

HttpHeaderPathRule

HttpHeaderRule

Https

ImageOptimization

IpFilter

IpFilterPathRule

IpFreqLimit

IpStatus

Ipv6

Ipv6Access

KeyRule

LogSetInfo

MainlandConfig

MapInfo

MaxAge

MaxAgeRule

OfflineCache

Origin

OriginAuthentication

OriginAuthenticationTypeA

OriginCombine

OriginIp

OriginPullOptimization

OriginPullTimeout