Data Types

Last updated: 2021-03-19 16:45:25

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 31536000.
FileExtensions Array of String Yes File extension list settings determining if authentication should be performed
If it contains an asterisk (*), this indicates all files.
FilterType String Yes allowlist: indicates that all file types apart from the FileExtensions list are authenticated
blacklist: indicates that only the file types in the FileExtensions list are authenticated

AuthenticationTypeB

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

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

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

AuthenticationTypeC

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

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

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

AuthenticationTypeD

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

Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

Name Type Required Description
SecretKey String Yes The key for signature calculation
Only digits, upper and lower-case letters are allowed. Length limit: 6-32 characters.
Note: this field may return null, indicating that no valid values can be obtained.
ExpireTime Integer Yes Signature expiration time
Unit: second. The maximum value is 31536000.
FileExtensions Array of