tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Content Delivery Network
    Documentation
    Download PDF

    Data Types

    Last updated: 2024-12-05 15:38:05
    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 access control based on the request header and request URL. Values:
      on: Enable
      off: Disable
      AccessControlRules Array of AccessControlRule No Request header and request URL access rule
      Note: This field may return null, indicating that no valid value can be obtained.
      ReturnCode Integer No Returns status code
      Note: This field may return null, indicating that no valid value 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 value can be obtained.
      RuleContent String Yes Blocked content
      Note: This field may return null, indicating that no valid value can be obtained.
      Regex String Yes on: regular match
      off: exact match
      Note: This field may return null, indicating that no valid value 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 value can be obtained.

      AdvanceCacheRule

      Advanced cache configuration rules

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      CacheType String Yes Rule types:
      all: Apply to all files.
      file: Apply to files with the specified suffixes.
      directory: Apply to specified paths.
      path: Apply to 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 value can be obtained.
      CacheContents Array of String Yes Content for each CacheType:
      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 default, enter "no max-age".
      Note: This field may return null, indicating that no valid value 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 value can be obtained.

      AdvanceConfig

      Advanced configuration settings

      Used by actions: DescribeDomainsConfig.

      Name Type Description
      Name String Advanced configuration name
      Note: This field may return null, indicating that no valid value can be obtained.
      Value String Whether to support advanced configuration
      on: Supported
      off: Not supported
      Note: This field may return null, indicating that no valid value can be obtained.

      AdvanceHttps

      Custom HTTPS configuration for origin-pull

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

      Name Type Required Description
      CustomTlsStatus String No Custom TLS data switch
      Note: this field may return null, indicating that no valid values can be obtained.
      TlsVersion Array of String No TLS version settings. 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.
      Cipher String No Custom encryption suite
      Note: this field may return null, indicating that no valid values can be obtained.
      VerifyOriginType String No Origin-pull verification status
      off: Disables origin-pull verification
      oneWay: Only verify the origin
      twoWay: Enables two-way origin-pull verification
      Note: this field may return null, indicating that no valid values can be obtained.
      CertInfo ServerCert No Configuration information of the origin-pull certificate
      Note: this field may return null, indicating that no valid values can be obtained.
      OriginCertInfo ClientCert No Configuration information of the origin server certificate
      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 Whether to enable hot linking protection. Values:
      on: Enable
      off: Disable
      Only one advanced configuration can be enabled. Set the rests to 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.

      AdvancedCCRules

      SCDN custom CC rules

      Used by actions: UpdateScdnDomain.

      Name Type Required Description
      RuleName String No Rule name
      DetectionTime Integer No Detection duration
      Note: this field may return null, indicating that no valid values can be obtained.
      FrequencyLimit Integer No Detection frequency threshold
      Note: this field may return null, indicating that no valid values can be obtained.
      PunishmentSwitch String No Whether to enable IP blocking. Values:
      on: Enable
      off: Disable
      Note: This field may return·null, indicating that no valid values can be obtained.
      PunishmentTime Integer No IP penalty 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 A redirection URL used when Action is redirect
      Note: this field may return null, indicating that no valid values can be obtained.
      Configure Array of ScdnSevenLayerRules No Layer-7 rule configuration for CC frequency limiting
      Note: this field may return null, indicating that no valid values can be obtained.
      Switch String No Whether to enable custom CC rules. Values:
      on: Enable
      off: Disable
      Note: This field may return·null, indicating that no valid values can be obtained.

      AdvancedCache

      (Disused) Advanced cache validity configuration. You can use RuleCache instead.

      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 value can be 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.

      AdvancedScdnAclGroup

      SCDN precise access control configuration

      Used by actions: UpdateScdnDomain.

      Name Type Required Description
      RuleName String Yes Rule name
      Configure Array of AdvancedScdnAclRule Yes Specific configurations
      Result String Yes Action. Valid values: intercept and redirect.
      Status String No Whether the rule is activated. Valid values: active and inactive.
      ErrorPage ScdnErrorPage No Error page configuration

      AdvancedScdnAclRule

      Precise access control rule

      Used by actions: UpdateScdnDomain.

      Name Type Required Description
      MatchKey String Yes Keyword. Valid values:
      protocol: HTTP protocol
      httpVersion: HTTP version
      method: request method
      ip: requester IP
      ipAsn: ASN of the requester IP
      ipCountry: country/region of the requester IP
      ipArea: region of the requester IP
      xForwardFor: X-Forward-For request header
      directory: Path
      index: Homepage
      path: Full path of a file
      file: File extension
      param: Request parameter
      referer: Referer request header
      cookie: Cookie request header
      userAgent: User-Agent request header
      head: Custom request header
      LogicOperator String Yes Logical operator. Valid values:
      exclude: The keyword is not included
      include: The keyword is included
      notequal: Not the same as the keyword
      equal: The same as the keyword
      matching: The prefix is matched
      null: Empty or does not exist
      MatchValue Array of String Yes Matched value.
      When MatchKey is protocol,
      Values: HTTP and HTTPS.

      When MatchKey is httpVersion,
      Values: HTTP/1.0, HTTP/1.1, HTTP/1.2, HTTP/2, and HTTP/3.

      When MatchKey is method,
      Values: HEAD, GET, POST, PUT, OPTIONS, TRACE, DELETE, PATCH and CONNECT.

      When MatchKey is ipCountry, valid values include:
      OTHER: Other areas
      VE: Venezuela
      UY: Uruguay
      SR: Suriname
      PY: Paraguay
      PE: Peru
      GY: Guyana
      EC: Ecuador
      CO: Colombia
      CL: Chile
      BR: Brazil
      BO: Bolivia
      AR: Argentina
      NZ: New Zealand
      WS: Samoa
      VU: Vanuatu
      TV: Tuvalu
      TO: Tonga
      TK: Tokelau
      PW: Palau
      NU: Niue
      NR: Nauru
      KI: Kiribati
      GU: Guam
      FM: Micronesia
      AU: Australia
      US: United States
      PR: Puerto Rico
      DO: Dominican Republic
      CR: Costa Rica
      AS: American Samoa
      AG: Antigua and Barbuda
      PA: Panama
      NI: Nicaragua
      MX: Mexico
      JM: Jamaica
      HT: Haiti
      HN: Honduras
      GT: Guatemala
      GP: Guadeloupe
      GL: Greenland
      GD: Grenada
      CU: Cuba
      CA: Canada
      BZ: Belize
      BS: Bahamas
      BM: Bermuda
      BB: Barbados
      AW: Aruba
      AI: Anguilla
      VA: Vatican
      SK: Slovakia
      GB: United Kingdom
      CZ: Czech Republic
      UA: Ukraine
      TR: Türkiye
      SI: Slovenia
      SE: Sweden
      RS: Republic of Serbia
      RO: Romania
      PT: Portugal
      PL: Poland
      NO: Norway
      NL: Netherlands
      MT: Malta
      MK: Macedonia
      ME: Montenegro
      MD: Moldova
      MC: Monaco
      LV: Latvia
      LU: Luxembourg
      LT: Lithuania
      LI: Liechtenstein
      KZ: Kazakhstan
      IT: Italy
      IS: Iceland
      IE: Ireland
      HU: Hungary
      HR: Croatia
      GR: Greece
      GI: Gibraltar
      GG: Guernsey
      GE: Georgia
      FR: France
      FI: Finland
      ES: Spain
      EE: Estonia
      DK: Denmark
      DE: Germany
      CY: Cyprus
      CH: Switzerland
      BY: Belarus
      BG: Bulgaria
      BE: Belgium
      AZ: Azerbaijan
      AT: Austria
      AM: Armenia
      AL: Albania
      AD: Andorra
      TL: East Timor
      SY: Syria
      SA: Saudi Arabia
      PS: Palestine
      LK: Sri Lanka
      LK: Sri Lanka
      KP: North Korea
      KG: Kyrgyzstan
      HK: Hong Kong, China
      BN: Brunei
      BD: Bangladesh
      AE: United Arab Emirates
      YE: Yemen
      VN: Vietnam
      UZ: Uzbekistan
      TW: Taiwan, China
      TM: Turkmenistan
      TJ: Tajikistan
      TH: Thailand
      SG: Singapore
      QA: Qatar
      PK: Pakistan
      PH: Philippines
      OM: Oman
      NP: Nepal
      MY: Malaysia
      MV: Maldives
      MO: Macao, China
      MN: Mongolia
      MM: Myanmar
      LB: Lebanon
      KW: Kuwait
      KR: South Korea
      KH: Cambodia
      JP: Japan
      JO: Jordan
      IR: Iran
      IQ: Iraq
      IN: India
      IL: Israel
      ID: Indonesia
      CN: China
      BT: Bhutan
      BH: Bahrain
      AF: Afghanistan
      LY: Libya
      CD: Democratic Republic of the Congo
      RE: La Réunion
      SZ: Swaziland
      ZW: Zimbabwe
      ZM: Zambia
      YT: Mayotte
      UG: Uganda
      TZ: Tanzania
      TN: Tunisia
      TG: Togo
      TD: Chad
      SO: Somalia
      SN: Senegal
      SD: Sudan
      SC: Seychelles
      RW: Rwanda
      NG: Nigeria
      NE: Niger
      NA: Namibia
      MZ: Mozambique
      MW: Malawi
      MU: Mauritius
      MR: Mauritania
      ML: Mali
      MG: Madagascar
      MA: Morocco
      LS: Lesotho
      LR: Liberia
      KM: Comoros
      KE: Kenya
      GN: Guinea
      GM: Gambia
      GH: Ghana
      GA: Gabon
      ET: Ethiopia
      ER: Eritrea
      EG: Egypt
      DZ: Algeria
      DJ: Djibouti
      CM: Cameroon
      CG: Republic of the Congo
      BW: Botswana
      BJ: Benin
      BI: Burundi
      AO: Angola

      When MatchKey is ipArea, valid values include:
      OTHER: Other areas
      AS: Asia
      EU: Europe
      AN: Antarctica
      AF: Africa
      OC: Oceania
      NA: North America
      SA: South America

      When MatchKey is index,
      valid value is /;/index.html.
      CaseSensitive Boolean No Whether to distinguish uppercase or lowercase letters. true: case sensitive; false: case insensitive.
      MatchKeyParam String No This field is required when MatchKey is param or cookie. For param, it indicates a key value of the request parameter if MatchKey is param, while a key value of the Cookie request header if MatchKey is cookie.

      Authentication

      Timestamp hotlink protection configuration

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable hot linking protection. Values:
      on: Enable
      off: Disable
      Only one advanced configuration can be enabled. Set the rests to null.
      AuthAlgorithm String No Authentication algorithm. Values:
      md5: Calculate the hash using MD5.
      sha256: Calculate the hash using SHA-256.
      Default value: md5.
      Note: This field may return·null, indicating that no valid values can be obtained.
      TypeA AuthenticationTypeA No Timestamp hotlink protection mode A configuration
      Note: This field may return null, indicating that no valid value 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 value can be obtained.
      TypeC AuthenticationTypeC No Timestamp hotlink protection mode C configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      TypeD AuthenticationTypeD No Timestamp hotlink protection mode D configuration
      Note: This field may return null, indicating that no valid value 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
      6-32 characters. Only digits and letters are allowed.
      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 whitelist: All file types apart from the FileExtensions list are authenticated.
      blacklist: Only the file types in the FileExtensions list are authenticated.
      BackupSecretKey String No Backup key, which is used to calculate a signature.
      6-32 characters. Only digits and letters are allowed.
      Note: This field may return null, indicating that no valid value can be obtained.

      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
      6-32 characters. Only digits and letters are allowed.
      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 whitelist: 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
      BackupSecretKey String No Backup key, which is used to calculate a signature.
      6-32 characters. Only digits and letters are allowed.
      Note: This field may return null, indicating that no valid value can be obtained.

      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
      6-32 characters. Only digits and letters are allowed.
      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 whitelist: All file types apart from the FileExtensions list are authenticated.
      blacklist: 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 can be obtained.
      BackupSecretKey String No Backup key, which is used to calculate a signature.
      6-32 characters. Only digits and letters are allowed.
      Note: This field may return null, indicating that no valid value can be 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
      6-32 characters. Only digits and letters are allowed.
      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 whitelist: All file types apart from the FileExtensions list are authenticated.
      blacklist: 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
      BackupSecretKey String No Backup key, which is used to calculate a signature.
      6-32 characters. Only digits and letters are allowed.
      Note: This field may return null, indicating that no valid value can be obtained.

      AvifAdapter

      AVIF adapter, used for image optimization

      Used by actions: DescribeDomainsConfig.

      Name Type Required Description
      Switch String No Whether to enable AvifAdapter for image optimization. Values:
      on: Enable
      off: Disable
      Note: This field may return·null, indicating that no valid values can be obtained.

      AwsPrivateAccess

      Origin access authentication for S3 bucket.

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable origin-pull authentication for S3 buckets.
      on: Enable
      off: Disable
      AccessKey String No Access ID.
      Note: This field may return null, indicating that no valid value can be obtained.
      SecretKey String No Key.
      Note: This field may return null, indicating that no valid value can be obtained.
      Region String No Region.
      Note: This field may return null, indicating that no valid value can be obtained.
      Bucket String No BucketName
      Note: This field may return null, indicating that no valid value 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 Whether to enable usage limit. Values:
      on: Enable
      off: Disable
      BpsThreshold Integer No The upper limit of bandwidth usage (in bps) or traffic usage (in bytes).
      Note: this field may return null, indicating that no valid values can be obtained.
      CounterMeasure String No Action taken when threshold is reached
      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 when the usage upper limit in the Chinese mainland was reached
      Note: this field may return null, indicating that no valid values can be obtained.
      AlertSwitch String No Whether to enable alerts for usage limit. Values:
      on: Enable
      off: Disable
      Note: This field may return null, indicating that no valid values can be obtained.
      AlertPercentage Integer No Triggers alarms when the ratio of bandwidth or traffic usage to the usage upper limit reaches the specified value
      Note: this field may return null, indicating that no valid values can be obtained.
      LastTriggerTimeOverseas Timestamp No The last time when the usage outside the Chinese mainland reached the upper limit
      Note: this field may return null, indicating that no valid values can be obtained.
      Metric String No Dimension of the usage limit
      bandwidth: Bandwidth
      flux: Traffic
      Note: This field may return null, indicating that no valid value can be obtained.
      StatisticItems Array of StatisticItem No Usage limit configuration
      Note: This field may return null, indicating that no valid value can be obtained.

      BotCookie

      Bot cookie policy

      Used by actions: UpdateScdnDomain.

      Name Type Required Description
      Switch String Yes Whether to enable bot cookie policies. Values:
      on: Enable
      off: Disable
      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 Whether to enable bot JS policies. Values:
      on: Enable
      off: Disable
      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
      closing: Disabling
      online: Enabled
      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 media VOD acceleration
      CreateTime Timestamp Domain name creation time.
      UpdateTime Timestamp Domain name update time.
      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 inside the Chinese mainland
      overseas: Acceleration outside the Chinese mainland
      global: Acceleration over the globe
      Readonly String Domain name lock status
      normal: Not locked
      mainland: Locked in the Chinese mainland
      overseas: Locked outside the Chinese mainland
      global: Locked globally
      Product String Product of the domain name, either cdn or ecdn.
      ParentHost String Primary domain name

      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 (Disused) Advanced cache validity configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      RuleCache Array of RuleCache No Advanced path cache configuration
      Note: This field may return null, indicating that no valid value can be obtained.

      CacheConfig

      Heuristic cache validity configuration

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      HeuristicCacheTimeSwitch String Yes Whether to enable heuristic cache validity. Values:
      on: Enable
      off: Disable
      Note: This field may return·null, indicating that no valid values can be obtained.
      HeuristicCacheTime Integer Yes Unit: Second
      Note: This field may return·null, indicating that no valid values can be obtained.

      CacheConfigCache

      Path cache configuration

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable path cache. Values:
      on: Enable
      off: Disable
      Note: This field may return null, indicating that no valid values can be 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 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: Enable
      off: Disable
      This is disabled by default.
      Note: This field may return null, indicating that no valid value can be 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 can be 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 Whether to follow the origin configuration for path cache. Values:
      on: Enable
      off: Disable
      HeuristicCache HeuristicCache No Heuristic cache configuration
      Note: This field may return null, indicating that no valid value can be obtained.

      CacheConfigNoCache

      Path cache/no cache configuration.

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable no-caching at the path. Values:
      on: Enable
      off: Disable
      Note: This field may return null, indicating that no valid values can be obtained.
      Revalidate String Yes Always forwards to the origin server for verification
      on: Enable
      off: Disable
      It is disabled by default.
      Note: This field may return null, indicating that no valid value can be obtained.

      CacheKey

      Cache key configuration (Ignore Query String 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 Ignore Query String)
      off: Disable full-path cache (i.e., enable Ignore Query String)
      IgnoreCase String No Specifies whether the cache key is case sensitive
      Note: This field may return null, indicating that no valid value can be obtained.
      QueryString QueryStringKey No Request parameter contained in CacheKey
      Note: This field may return null, indicating that no valid value can be obtained.
      Cookie CookieKey No Cookie contained in CacheKey
      Note: This field may return null, indicating that no valid value can be obtained.
      Header HeaderKey No Request header contained in CacheKey
      Note: This field may return null, indicating that no valid value can be obtained.
      CacheTag CacheTagKey No Custom string contained in CacheKey
      Note: This field may return null, indicating that no valid value can be obtained.
      Scheme SchemeKey No Request protocol contained in CacheKey
      Note: This field may return null, indicating that no valid value can be obtained.
      KeyRules Array of KeyRule No Path-specific cache key configuration
      Note: This field may return null, indicating that no valid value can be 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 value can be obtained.
      FailUrls Array of String List of failed URLs
      Note: This field may return null, indicating that no valid value can be obtained.

      CacheTagKey

      A part of CacheKey

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to include CacheTag as part of CacheKey. Values:
      on: Yes
      off: No
      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 value 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: Apply to all files.
      file: Apply to files with the specified suffixes.
      directory: Apply to specified paths.
      path: Apply to specified absolute paths.
      RulePaths Array of String Yes Content for each RuleType:
      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.
      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 by 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)
      You can also 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 Activation and deactivation history of the node.
      Area String Node region
      mainland: Acceleration nodes inside the Chinese mainland
      overseas: Acceleration nodes outside the Chinese mainland
      unknown: Service region unknown
      City String City where the nodes reside
      Note: This field may return null, indicating that no valid value can be obtained.

      CdnIpHistory

      CDN node activation and deactivation history

      Used by actions: DescribeCdnIp.

      Name Type Description
      Status String Operation type
      online: Nodes activated
      offline: Nodes deactivated
      Datetime Timestamp Operation time corresponding to operation type
      If its value is null, it means there is no status change record.
      Note: This field may return null, indicating that no valid value can be obtained.

      ClientCert

      HTTPS client certificate configuration

      Used by actions: AddCdnDomain, DescribeDomains, 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 value can be obtained.
      CertName String No Client certificate name
      Note: This field may return null, indicating that no valid value 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 value 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 value 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 value 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 Whether to enable smart compression. Values:
      on: Enable
      off: Disable
      CompressionRules Array of CompressionRule No Compression rules array
      Note: This field may return null, indicating that no valid value can be obtained.

      CompressionRule

      Intelligent compression rule configuration

      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.
      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 value can be obtained.
      Algorithms Array of String Yes File compression algorithm
      gzip: Gzip compression
      brotli: Brotli compression
      Note: This field may return null, indicating that no valid value can be obtained.
      FileExtensions Array of String No Compress based on file suffix.
      File suffixes such as jpg and txt are supported.
      Note: This field may return null, indicating that no valid value can be obtained.
      RuleType String No Rule types:
      all: Apply to all files.
      file: Apply to files with the specified suffixes.
      directory: Apply to specified paths.
      path: Apply to specified absolute paths.
      contentType: Apply when the ContentType is specified.
      If this field is specified, FileExtensions does not take effect.
      Note: This field may return null, indicating that no valid value can be obtained.
      RulePaths Array of String No Content for each CacheType:
      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 contentType, enter text/html.
      Note: This field may return null, indicating that no valid value can be obtained.

      CookieKey

      A part of CacheKey

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to include Cookie as part of CacheKey. Values:
      on: Yes
      off: No
      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 value 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 Accelerated 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
      closing: Disabling
      online: Enabled
      offline: Disabled
      ProjectId Integer Project ID, which can be viewed on the Tencent Cloud project management page
      ServiceType String Acceleration domain name service type
      web: Webpage file downloads
      download: Large file downloads
      media: Audio and video on demand acceleration
      hybrid: Dynamic and static content acceleration
      dynamic: Dynamic content acceleration
      CreateTime Timestamp Domain name creation time
      UpdateTime Timestamp Domain name update time
      Origin Origin Origin server configuration.
      IpFilter IpFilter IP blocklist/allowlist configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      IpFreqLimit IpFreqLimit IP access limit configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      StatusCodeCache StatusCodeCache Status code cache configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      Compression Compression Smart compression configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      BandwidthAlert BandwidthAlert Bandwidth cap configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      RangeOriginPull RangeOriginPull Range GETs configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      FollowRedirect FollowRedirect 301/302 origin-pull follow-redirect configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      ErrorPage ErrorPage Custom error page configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      RequestHeader RequestHeader Custom request header configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      ResponseHeader ResponseHeader Custom response header configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      DownstreamCapping DownstreamCapping Single-link downstream speed limit configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      CacheKey CacheKey Configuration of cache with/without parameter
      Note: This field may return null, indicating that no valid value can be obtained.
      ResponseHeaderCache ResponseHeaderCache Origin server header cache configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      VideoSeek VideoSeek Video dragging configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      Cache Cache Node cache expiration rule configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      OriginPullOptimization OriginPullOptimization Cross-border linkage optimization configuration (in beta)
      Note: This field may return null, indicating that no valid value can be obtained.
      Https Https HTTPS Acceleration Configuration Guide
      Note: This field may return null, indicating that no valid value can be obtained.
      Authentication Authentication Timestamp hotlink protection configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      Seo Seo SEO configuration
      Note: This field may return null, indicating that no valid value 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 value can be obtained.
      ForceRedirect ForceRedirect Access protocol forced redirect configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      Referer Referer Referer configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      MaxAge MaxAge Browser cache expiration rule configuration (in beta)
      Note: This field may return null, indicating that no valid value can be obtained.
      Ipv6 Ipv6 IPv6 origin-pull configuration (in beta)
      Note: This field may return null, indicating that no valid value can be obtained.
      Compatibility Compatibility Backwards compatibility configuration (compatibility field for internal use)
      Note: This field may return null, indicating that no valid value can be obtained.
      SpecificConfig SpecificConfig Region-specific configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      Area String Acceleration region
      mainland: Acceleration inside the Chinese mainland
      overseas: Acceleration outside the Chinese mainland
      global: Acceleration over the globe
      Note: This field may return null, indicating that no valid value can be obtained.
      Readonly String Domain name lock status
      normal: Not locked
      mainland: Locked in the Chinese mainland
      overseas: Locked outside the Chinese mainland
      global: Locked globally
      Note: This field may return null, indicating that no valid value can be obtained.
      OriginPullTimeout OriginPullTimeout Origin-pull timeout configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      AwsPrivateAccess AwsPrivateAccess S3 bucket origin access authentication configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      SecurityConfig SecurityConfig SCDN configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      ImageOptimization ImageOptimization Image optimization configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      UserAgentFilter UserAgentFilter UA blocklist/allowlist configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      AccessControl AccessControl Access control
      Note: This field may return null, indicating that no valid value can be obtained.
      Advance String Whether to support advanced configuration items
      on: Supported
      off: Not supported
      Note: This field may return null, indicating that no valid value can be obtained.
      UrlRedirect UrlRedirect URL redirect configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      AccessPort Array of Integer Access port configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      Tag Array of Tag Tag configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      AdvancedAuthentication AdvancedAuthentication Timestamp hotlink protection advanced configuration (allowlist feature)
      Note: This field may return null, indicating that no valid value can be obtained.
      OriginAuthentication OriginAuthentication Origin-pull authentication advanced configuration (allowlist feature)
      Note: This field may return null, indicating that no valid value can be obtained.
      Ipv6Access Ipv6Access IPv6 access configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      AdvanceSet Array of AdvanceConfig Advanced configuration settings
      Note: This field may return null, indicating that no valid value can be obtained.
      OfflineCache OfflineCache Offline cache (only available to beta users)
      Note: This field may return null, indicating that no valid value can be obtained.
      OriginCombine OriginCombine Merging origin-pull requests (only available to beta users)
      Note: This field may return null, indicating that no valid value can be obtained.
      PostMaxSize PostSize POST request configuration item
      Note: This field may return null, indicating that no valid value can be obtained.
      Quic Quic QUIC configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      OssPrivateAccess OssPrivateAccess Access authentication for OSS origin
      Note: This field may return null, indicating that no valid value can be obtained.
      WebSocket WebSocket WebSocket configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      RemoteAuthentication RemoteAuthentication Remote authentication configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      ShareCname ShareCname Shared CNAME configuration (only available to beta users)
      Note: This field may return null, indicating that no valid value can be obtained.
      RuleEngine RuleEngine Rule engine
      Note: This field may return null, indicating that no valid value can be obtained.
      ParentHost String Primary domain name
      Note: This field may return null, indicating that no valid value can be obtained.
      HwPrivateAccess HwPrivateAccess Access authentication for Huawei Cloud OBS origin
      Note: This field may return null, indicating that no valid value can be obtained.
      QnPrivateAccess QnPrivateAccess Access authentication for QiNiu Cloud Kodo origin
      Note: This field may return null, indicating that no valid value can be obtained.
      HttpsBilling HttpsBilling HTTPS (enabled by default)
      Note: This field may return null, indicating that no valid values can be obtained.
      OthersPrivateAccess OthersPrivateAccess Origin-pull authentication for other origins
      Note: this field may return null, indicating that no valid values can be obtained.

      DomainAreaConfig

      Region configuration for domain names

      Used by actions: AddCLSTopicDomains, 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 filter. Values:
      - origin: Primary origin server.
      - domain: Domain name.
      - resourceId: Domain name ID.
      - status: Domain name status. Values: online, offline, and processing.
      - serviceType: Service type. Values: web, download, media, hybrid and dynamic.
      - projectId: Project ID.
      - domainType: Primary origin type. Values: cname (customer origin), COS (COS origin), third_party (third-party object storage origin), and igtm (IGTM origin).
      - fullUrlCache: Whether to enable path cache. Values: on, off.
      - https: Whether to configure HTTPS. Values: on, off and processing.
      - originPullProtocol: Origin-pull protocol type. Value: http, follow, and https.
      - 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 the Chinese mainland
      overseas: Outside the Chinese mainland
      LogName String Log package filename
      FileSize Integer File size, in bytes.
      Note: This field may return null, indicating that no valid values can be obtained.

      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 Whether to enable downstream speed limit. Values:
      on: Enable
      off: Disable
      CappingRules Array of CappingRule No Downstream speed limiting rules
      Note: This field may return null, indicating that no valid value can be obtained.

      ErrorPage

      Status code redirect configuration, which is disabled by default.

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable status code-based redirection. Values:
      on: Enable
      off: Disable
      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 value 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.

      ExtraLogset

      Information of logsets and log topics (except those created in the Shanghai region)

      Used by actions: ListClsLogTopics.

      Name Type Description
      Logset LogSetInfo Logset information
      Note: this field may return null, indicating that no valid values can be obtained.
      Topics Array of TopicInfo Log topic information
      Note: this field may return null, indicating that no valid values can be obtained.

      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 Whether to enable origin-pull to follow the origin configuration. Values:
      on: Enable
      off: Disable
      RedirectConfig RedirectConfig No Specifies a host header for 302 redirects. This feature is only available to beta users. To join the beta, please submit a ticket.
      Note: This field may return null, indicating that no valid values can be obtained.

      ForceRedirect

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

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable forced HTTPS redirects. Values:
      on: Enable
      off: Disable
      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 value 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 value can be obtained.
      CarryHeaders String No Whether to return the newly added header during force redirection
      Note: This field may return null, indicating that no valid value can be obtained.

      GuetzliAdapter

      Image optimization - GuetzliAdapter configuration

      Used by actions: DescribeDomainsConfig.

      Name Type Required Description
      Switch String No Whether to enable AvifAdapter for image optimization. Values:
      on: Enable
      off: Disable
      Note: This field may return·null, indicating that no valid values can be obtained.

      HTTPHeader

      HTTP request header

      Used by actions: PushUrlsCache.

      Name Type Required Description
      Name String Yes Request header name
      Value String Yes Request header value

      HeaderKey

      A part of CacheKey

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String No Whether to enable Cachekey control. Values:
      on: Enable
      off: Disable
      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 value can be obtained.

      HeuristicCache

      Heuristic cache configuration

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable heuristic caching. Values:
      on: Enable
      off: Disable
      Note: This field may return·null, indicating that no valid values can be obtained.
      CacheConfig CacheConfig No Heuristic cache validity configuration
      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 HSTS. Values:
      on: Enable
      off: Disable
      MaxAge Integer No MaxAge value.
      Note: This field may return null, indicating that no valid value 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 value 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 value 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 value can be obtained.
      RuleType String Yes Rule types:
      all: Apply to all files.
      file: Apply to files with the specified suffixes.
      directory: Apply to specified paths.
      path: Apply to specified absolute paths.
      Note: This field may return null, indicating that no valid value can be obtained.
      RulePaths Array of String Yes Content for each RuleType:
      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.
      Note: This field may return null, indicating that no valid value 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 Whether to enable HTTPS. Values:
      on: Enable
      off: Disable
      Note: This field may return null, indicating that no valid values can be obtained.
      Http2 String No Whether to enable HTTP2
      on: Enable
      off: Disable
      Note: this field may return null, indicating that no valid values can be obtained.
      OcspStapling String No OCSP configuration switch
      on: Enable
      off: Disable
      It is disabled by default.
      Note: This field may return null, indicating that no valid value can be obtained.
      VerifyClient String No Client certificate authentication feature
      on: Enable
      off: Disable
      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 value can be obtained.
      CertInfo ServerCert No Server certificate configuration information
      Note: This field may return null, indicating that no valid value can be obtained.
      ClientCertInfo ClientCert No Client certificate configuration information
      Note: This field may return null, indicating that no valid value can be obtained.
      Spdy String No Spdy configuration switch
      on: Enable
      off: Disable
      It is disabled by default.
      Note: This field may return null, indicating that no valid value 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 value can be obtained.
      Hsts Hsts No HSTS configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      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 value can be obtained.

      HttpsBilling

      HTTPS. When it’s disabled, HTTPS requests are blocked.

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable HTTPS. Values:
      on: When it's enabled, HTTPS requests are allowed and incur charges. If not specified, his field uses the default value on.
      off: When it's disabled, HTTPS requests are blocked.

      HwPrivateAccess

      Origin-pull authentication for Huawei Cloud OBS origin

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable origin-pull authentication for Huawei Cloud OBS origin. Values:
      on: Enable
      off: Disable
      AccessKey String No Access ID
      Note: This field may return null, indicating that no valid value can be obtained.
      SecretKey String No Key
      Note: This field may return null, indicating that no valid value can be obtained.
      Bucket String No BucketName
      Note: This field may return null, indicating that no valid value can be obtained.

      ImageOptimization

      Image optimization configuration

      Used by actions: DescribeDomainsConfig.

      Name Type Description
      WebpAdapter WebpAdapter WebpAdapter configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      TpgAdapter TpgAdapter TpgAdapter configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      GuetzliAdapter GuetzliAdapter GuetzliAdapter configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      AvifAdapter AvifAdapter AVIF adapter configuration
      Note: This field may return null, indicating that no valid value 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 Whether to enable IP blocklist/allowlist. Values:
      on: Enable
      off: Disable
      FilterType String No IP blocklist/allowlist type
      whitelist: IP allowlist
      blacklist: IP blocklist
      Note: This field may return null, indicating that no valid value can be obtained.
      Filters Array of String No IP blocklist/allowlist
      Supports IPs in X.X.X.X format, or IP ranges in /8, /16, /24 format.
      Up to 50 whitelists or blacklists can be entered
      Note: This field may return null, indicating that no valid value 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 can be obtained.
      ReturnCode Integer No (Disused) Expected HTTP code to return when the IP allowlist/blocklist verification fails.
      The 514 code is used instead.
      Note: this field may return null, indicating that no valid values can be 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 can be 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 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 value 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 value can be 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 Whether to enable IP rate limit. Values:
      on: Enable
      off: Disable
      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 value can be obtained.

      IpStatus

      Node IP information

      Used by actions: DescribeIpStatus.

      Name Type Description
      Ip String Node IP
      District String Region of the node
      Isp String ISP of the node
      City String City of the node
      Status String Status of the node
      online: The node is active and scheduling normally.
      offline: The node is inactive.

      Ipv6

      IPv6 origin configuration (changes not allowed).

      Used by actions: AddCdnDomain, DescribeDomainsConfig.

      Name Type Required Description
      Switch String Yes Whether to enable an IPv6 address for the origin server. Values:
      on: Enable
      off: Disable
      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 IPv6 access. Values:
      on: Enable
      off: Disable
      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 a suffix, e.g., jpg or txt.
      For directory, enter the path, such as /xxx/test/.
      For path, enter an absolute path, e.g., /xxx/test.html.
      For index, enter a backslash (/).
      Note: this field may return null, indicating that no valid value can be obtained.
      RuleType String Yes Rule types:
      file: Apply to files with the specified suffixes.
      directory: Apply to specified paths.
      path: Apply to specified absolute paths.
      index: home page
      Note: This field may return null, indicating that no valid value can be obtained.
      FullUrlCache String Yes Whether to enable full-path cache
      on: Enable full-path cache (i.e., disable Ignore Query String).
      off: Disable full-path cache (i.e., enable Ignore Query String).
      Note: This field may return null, indicating that no valid value can be obtained.
      IgnoreCase String Yes Whether caches are case insensitive
      Note: This field may return null, indicating that no valid value can be obtained.
      QueryString RuleQueryString Yes Request parameter contained in CacheKey
      Note: This field may return null, indicating that no valid value can be obtained.
      RuleTag String Yes Path cache key tag, the value "user" is passed.
      Note: This field may return null, indicating that no valid value can be 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 time
      Region String Region
      Deleted String Whether the logset has been removed from CLS
      Note: This field may return null, indicating that no valid value can be obtained.
      RegionEn String Whether English is used in this region
      Note: This field may return null, indicating that no valid value can be obtained.

      MainlandConfig

      Specific configuration for domain names in the Chinese mainland. Specific configuration by region. The 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 rule configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      CacheKey CacheKey No Cache configurations.
      Note: This field may return null, indicating that no valid value can be obtained.
      Compression Compression No Smart compression configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      DownstreamCapping DownstreamCapping No Download speed limit configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      ErrorPage ErrorPage No Error code redirect configuration.
      Note: This field may return null, indicating that no valid value 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 value can be obtained.
      ForceRedirect ForceRedirect No Force redirect by access protocol.
      Note: This field may return null, indicating that no valid value can be obtained.
      Https Https No HTTPS configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      IpFilter IpFilter No IP blocklist/allowlist configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      IpFreqLimit IpFreqLimit No IP access limiting configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      MaxAge MaxAge No Browser cache rules configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      Origin Origin No Origin server configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      OriginPullOptimization OriginPullOptimization No Cross-border optimization configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      RangeOriginPull RangeOriginPull No Range GETs configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      Referer Referer No Hotlink protection configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      RequestHeader RequestHeader No Origin-pull request header configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      ResponseHeader ResponseHeader No Origin server response header configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      ResponseHeaderCache ResponseHeaderCache No Follows origin server cache header configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      Seo Seo No SEO configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      ServiceType String No Domain name service type. Values: web (static acceleration); download (download acceleration); media (streaming media acceleration).
      Note: This field may return null, indicating that no valid value can be obtained.
      StatusCodeCache StatusCodeCache No Status code cache configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      VideoSeek VideoSeek No Video dragging configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      AwsPrivateAccess AwsPrivateAccess No Access authentication for S3 origin
      Note: This field may return null, indicating that no valid value can be obtained.
      OssPrivateAccess OssPrivateAccess No Access authentication for OSS origin
      Note: This field may return null, indicating that no valid value can be obtained.
      HwPrivateAccess HwPrivateAccess No Access authentication for Huawei Cloud OBS origin
      Note: This field may return null, indicating that no valid value can be obtained.
      QnPrivateAccess QnPrivateAccess No Access authentication for QiNiu Cloud Kodo origin
      Note: This field may return null, indicating that no valid value 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, which is used to set the default value of MaxAge and is disabled by default.

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable browser caching. Values:
      on: Enable
      off: Disable
      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 value can be obtained.
      MaxAgeCodeRule MaxAgeCodeRule No MaxAge status code
      Note: This field may return null, indicating that no valid value can be obtained.

      MaxAgeCodeRule

      MaxAge status code

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Action String Yes Action to execute.
      clear: Clear the cache-control header.
      StatusCodes Array of String Yes Specifies the HTTP status code in the range 400-599.

      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 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: 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 value can be obtained.

      OfflineCache

      Offline cache feature status switch.

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable offline caching. Values:
      on: Enable
      off: Disable

      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. 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 List of primary origin servers
      When modifying the origins, you need to specify OriginType.
      Note: This field may return null, indicating that no valid values can be obtained.
      OriginType String No Primary origin server type
      This field is used together with Origins.
      Input:
      domain: Domain name
      domainv6: IPv6 domain name
      cos: COS bucket address
      third_party: Third-party object storage origin
      igtm: IGTM origin
      ip: IP address
      ipv6: One IPv6 address
      ip_ipv6: Multiple IPv4 addresses and one IPv6 address
      ip_domain: IP addresses and domain names (only available to beta users)
      ip_domainv6: Multiple IPv4 addresses and one IPv6 domain name
      ipv6_domain: Multiple IPv6 addresses and one domain name
      ipv6_domainv6: Multiple IPv6 addresses and one IPv6 domain name
      domain_domainv6: Multiple IPv4 domain names and one IPv6 domain name
      ip_ipv6_domain: Multiple IPv4 and IPv6 addresses and one domain name
      ip_ipv6_domainv6: Multiple IPv4 and IPv6 addresses and one IPv6 domain name
      ip_domain_domainv6: Multiple IPv4 addresses and IPv4 domain names and one IPv6 domain name
      ipv6_domain_domainv6: Multiple IPv4 domain names and IPv6 addresses and one IPv6 domain name
      ip_ipv6_domain_domainv6: Multiple IPv4 and IPv6 addresses and IPv4 domain names and one IPv6 domain name
      Output:
      image: Cloud Infinite origin
      ftp: FTP origin (disused)
      When modifying Origins, you need to specify OriginType.
      The IPv6 feature is now only available to beta users. Submit a ticket if you need it.
      Note: This field may return null, indicating that no valid values can be obtained.
      ServerName String No Origin-pull host header.
      This field is required when OriginType=cos/third-party.
      If not specified, this field defaults to the acceleration domain name.
      For a wildcard domain name, the sub-domain name during the access is 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. Values: on and off.
      Note: This field may return null, indicating that no valid value 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 value can be obtained.
      BackupOrigins Array of String No List of secondary origin servers
      This field is used together with BackupOriginType.
      Note: This field may return null, indicating that no valid values can be obtained.
      BackupOriginType String No Secondary origin type
      This field is used together with BackupOrigins.
      Values:
      domain: Domain name
      ip: IP address
      The following secondary origin types are only available to beta users. Submit a ticket to use it.
      ipv6_domain: Multiple IPv6 addresses and one domain name
      ip_ipv6: Multiple IPv4 addresses and one IPv6 address
      ipv6_domain: Multiple IPv6 addresses and one domain name
      ip_ipv6_domain: Multiple IPv4 and IPv6 addresses and one domain name
      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 it is left empty, the ServerName of primary origin server will be used by default.
      Note: This field may return null, indicating that no valid value can be obtained.
      BasePath String No Origin-pull path
      Note: This field may return null, indicating that no valid value can be obtained.
      PathRules Array of PathRule No Origin-pull path rewriting configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      PathBasedOrigin Array of PathBasedOriginRule No Path-based origin-pull configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      Sni OriginSni No HTTPS origin-pull SNI
      Note: This field may return null, indicating that no valid values can be obtained.
      AdvanceHttps AdvanceHttps No HTTPS advanced origin-pull configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      OriginCompany String No Third-party object storage service vendor
      This field is required when OriginType=third-party.
      Values:
      aws_s3: AWS S3
      ali_oss: Alibaba Cloud OSS
      hw_obs: Huawei Cloud OBS
      Qiniu_kodo: Qiniu Kodo
      Others: Other object storage service vendors. Only AWS signature-compatible object storage services are supported, such as Tencent Cloud COS for Finance Zone.
      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 Whether to enable advanced origin-pull authentication. Values:
      on: Enable
      off: Disable

      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 configuration item

      Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable origin-pull merge. Values:
      on: Enable
      off: Disable

      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

      (Disused) Cross-border origin-pull optimization

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable cross-MLC-border origin-pull optimization. Values:
      on: Enable
      off: Disable
      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 value 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 value can be obtained.
      ReceiveTimeout Integer Yes The origin-pull receipt timeout (in seconds). Valid range: 10-300.
      Note: This field may return null, indicating that no valid value can be obtained.

      OriginSni

      HTTPS origin-pull SNI

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

      Name Type Required Description
      Switch String Yes Whether to enable HTTPS origin-pull SNI. Values:
      on: Enable
      off: Disable
      ServerName String Yes Origin-pull domain name.
      Note: This field may return null, indicating that no valid values can be obtained.

      OssPrivateAccess

      Access authentication configuration for OSS origin

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable OSS origin-pull authentication. Values:
      on: Enable
      off: Disable
      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.
      Region String No Region
      Note: This field may return null, indicating that no valid value can be obtained.
      Bucket String No BucketName
      Note: This field may return null, indicating that no valid value can be obtained.

      OthersPrivateAccess

      Origin-pull authentication for other origins

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable origin-pull authentication for other object storage origins. Values:
      on: Enable
      off: Disable
      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.
      Region String No Region.
      Note: This field may return null, indicating that no valid values can be obtained.
      Bucket String No Bucket name
      Note: This field may return null, indicating that no valid values can be obtained.

      OverseaConfig

      Specific configuration for domain names outside the Chinese mainland. The 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 rule configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      CacheKey CacheKey No Cache configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      Compression Compression No Smart compression configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      DownstreamCapping DownstreamCapping No Download speed limit configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      ErrorPage ErrorPage No Error code redirect configuration.
      Note: This field may return null, indicating that no valid value 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 value can be obtained.
      ForceRedirect ForceRedirect No Protocol redirect configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      Https Https No HTTPS configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      IpFilter IpFilter No IP blocklist/allowlist configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      IpFreqLimit IpFreqLimit No IP access limit configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      MaxAge MaxAge No Browser cache rules configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      Origin Origin No Origin server configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      OriginPullOptimization OriginPullOptimization No Cross-border optimization configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      RangeOriginPull RangeOriginPull No Range GETs configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      Referer Referer No Hotlink protection configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      RequestHeader RequestHeader No Origin-pull request header configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      ResponseHeader ResponseHeader No Origin server response header configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      ResponseHeaderCache ResponseHeaderCache No Follows origin server cache header configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      Seo Seo No SEO configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      ServiceType String No Domain name service type. Values: web (static acceleration); download (download acceleration); media (streaming media acceleration).
      Note: This field may return null, indicating that no valid value can be obtained.
      StatusCodeCache StatusCodeCache No Status code cache configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      VideoSeek VideoSeek No Video dragging configuration.
      Note: This field may return null, indicating that no valid value can be obtained.
      AwsPrivateAccess AwsPrivateAccess No Access authentication for S3 origin
      Note: This field may return null, indicating that no valid value can be obtained.
      OssPrivateAccess OssPrivateAccess No Access authentication for OSS origin
      Note: This field may return null, indicating that no valid value can be obtained.
      HwPrivateAccess HwPrivateAccess No Access authentication for Huawei Cloud OBS origin
      Note: This field may return null, indicating that no valid value can be obtained.
      QnPrivateAccess QnPrivateAccess No Access authentication for QiNiu Cloud Kodo origin
      Note: This field may return null, indicating that no valid value can be obtained.

      PathBasedOriginRule

      Path-based origin-pull rule

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

      Name Type Required Description
      RuleType String Yes Rule types:
      file: Apply to files with the specified suffixes.
      directory: Apply to specified paths.
      path: Apply to specified absolute paths.
      index: Apply to 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 name 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: disabled
      true: enabled
      Note: this field may return null, indicating that no valid value 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 Region of the origin server. Valid values: CN and OV.
      CN: Within 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 value 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 can be obtained.
      FullMatch Boolean No When Regex is false, this parameter should be true.
      false: Disabled
      true: enabled
      Note: This field may return null, indicating that no valid value can be obtained.

      PostSize

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

      Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Maximum size of the file uploaded for streaming via a POST request. Values:
      on: Enable. When enabled, it is set to 32 MB by default.
      off: Disable
      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: Purge 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
      invalid: Invalid prefetch with 4XX/5XX status code returned from the origin server
      Percent Integer Prefetch progress in percentage
      CreateTime Timestamp Prefetch task submission time
      Area String Prefetch region
      mainland: Within the Chinese mainland
      overseas: Outside the Chinese mainland
      global: Globe
      UpdateTime Timestamp Prefetch task update time
      Note: This field may return null, indicating that no valid value can be obtained.

      QnPrivateAccess

      Access authentication for QiNiu Cloud Kodo origin

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable origin-pull authentication for QiNiu Cloud Kodo. Values:
      on: Enable
      off: Disable
      AccessKey String No Access ID
      Note: This field may return null, indicating that no valid value can be obtained.
      SecretKey String No Key

      QueryStringKey

      A part of CacheKey

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to include QueryString as part of CacheKey. Values:
      on: Enable
      off: Disable
      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 value can be obtained.
      Action String No Whether to include URL parameters. Values:
      includeAll: Include all parameters.
      excludeAll: Exclude all parameters.
      includeCustom: Include custom parameters.
      excludeCustom: Exclude custom parameters.
      Note: This field may return null, indicating that no valid values can be obtained.
      Value String No Array of included/excluded query strings (separated by ';')
      Note: This field may return null, indicating that no valid value can be obtained.

      Quic

      QUIC configuration item

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable QUIC. Values:
      on: Enable
      off: Disable

      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 Whether to enable Range GETs. Values:
      on: Enable
      off: Disable
      RangeRules Array of RangeOriginPullRule No Range GETs configuration
      Note: This field may return null, indicating that no valid value can be obtained.

      RangeOriginPullRule

      Range GETs configuration

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable Range GETs. Values:
      on: Enable
      off: Disable
      RuleType String Yes Rule types:
      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 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.
      Note: this field may return null, indicating that no valid values can be obtained.

      RedirectConfig

      Host header for 302 redirects

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable the custom origin-pull request to follow the host when a 302 code is returned. Values:
      on: Enable
      off: Disable
      FollowRedirectHost String Yes The custom host header that is sent when the primary origin server follows 302 redirects
      FollowRedirectBackupHost String No The custom host header that is sent when the secondary origin server follows 302 redirects

      Referer

      Referer blacklist/whitelist configuration. This is disabled by default.

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable referer blocklist/allowlist. Values:
      on: Enable
      off: Disable
      RefererRules Array of RefererRule No Referer blacklist/whitelist configuration rule
      Note: This field may return null, indicating that no valid value can be obtained.

      RefererRule

      Referer blacklist/whitelist configuration rules, which is effective for specific resources.

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      RuleType String Yes Rule types:
      all: Apply to all files.
      file: Apply to files with the specified suffixes.
      directory: Apply to specified paths.
      path: Apply to specified absolute paths.
      RulePaths Array of String Yes Content for each RuleType:
      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.
      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 when RefererType = whitelist.
      false: Reject empty refer when RefererType = blacklist.

      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

      RemoteAuthentication

      Configuration of remote authentication rules. Setting up multiple rules is supported.
      RemoteAuthenticationRules and Server cannot be configured at the same time.
      If only Server is configured, all parameters of RemoteAuthenticationRules will be set to the default values. The default values are described in each configuration parameter.

      Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable remote authentication. Values:
      on: Enable
      off: Disable
      Note: This field may return null, indicating that no valid values can be obtained.
      RemoteAuthenticationRules Array of RemoteAuthenticationRule No Remote authentication rule configuration
      Note: this field may return null, indicating that no valid values can be obtained.
      Server String No Remote authentication server
      Note: this field may return null, indicating that no valid values can be obtained.

      RemoteAuthenticationRule

      Remote authentication rule

      Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Server String Yes Remote authentication server
      The server configured in RemoteAutherntication is used by default.
      AuthMethod String Yes HTTP method used by the remote authentication server. Valid values: get, post, head, and all.
      all: the remote authentication server follows the client request method.
      Default: all
      RuleType String Yes Rule types:
      all: apply to all files
      file: apply to files with the specified suffixes
      directory: apply to the specified directories
      path: apply to the specified absolute paths
      Default: all.
      RulePaths Array of String Yes Content for each RuleType:
      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 /.
      Default: *
      AuthTimeout Integer Yes Timeout period of the remote authentication server. Unit: ms.
      Value range: [1, 30,000]
      Default: 20000
      AuthTimeoutAction String Yes Whether to deny or allow the request when the remote authentication server is timed out:
      RETURN_200: the request is allowed when the remote authentication server is timed out.
      RETURN_403: the request is denied when the remote authentication server is timed out.
      Default: RETURN_200

      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 Whether to enable custom request headers. Values:
      on: Enable
      off: Disable
      HeaderRules Array of HttpHeaderPathRule No Custom request header configuration rules
      Note: This field may return null, indicating that no valid value can be obtained.

      ResourceBillingData

      Billing data details

      Used by actions: DescribeBillingData.

      Name Type Description
      Resource String Resource name, which is classified as follows based on different query filters:
      When a domain name is specified: Details of the domain name
      multiDomains: Aggregated details of multiple domain names
      A specific project ID: ID of the specifically queried project
      all: 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.
      A single domain name: Queries domain name details by a domain name. The details of the domain name will be displayed when the passed parameter detail is true.
      Multiple domain names: Queries domain name details by multiple domain names. The aggregated details of the domain names will be displayed.
      Project ID: Queries domain name details by a project ID. The aggregated details of the domain names of the project will be displayed.
      all: Account-level data, which is aggregated details of all domain names of an account.
      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 filters:
      A specific domain name: Details of the domain name
      multiDomains: Aggregated details of multiple domain names
      Project ID: ID of the specifically queried project
      all: 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 Whether to enable custom response headers. Values:
      on: Enable
      off: Disable
      HeaderRules Array of HttpHeaderPathRule No Custom response header rules
      Note: This field may return null, indicating that no valid value 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 Whether to enable response header caching. Values:
      on: Enable
      off: Disable

      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 enable origin-pull authentication. Values:
      on: Enable
      off: Disable

      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 value 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 can be 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 can be obtained.
      NoCache CacheConfigNoCache Yes No cache configuration
      Note: This field may return null, indicating that no valid value can be obtained.
      FollowOrigin CacheConfigFollowOrigin Yes Follows the origin server configuration
      Note: This field may return null, indicating that no valid value can be obtained.

      RuleEngine

      Rule engine configuration

      Used by actions: DescribeDomainsConfig.

      Name Type Required Description
      Switch String Yes Whether to enable rule engine. Values:
      on: Enable
      off: Disable
      Content String No Rule
      Note: This field may return null, indicating that no valid values can be 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 include query string parameters. Values:
      on: Include QueryString as part of CacheKey.
      off: Do not include QueryString as part of CacheKey.

      Note: This field may return null, indicating that no valid values can be obtained.
      Action String Yes includeCustom will retain partial query strings
      Note: This field may return null, indicating that no valid value can be obtained.
      Value String Yes Array of included/excluded query strings (separated by ';')
      Note: This field may return null, indicating that no valid value can be obtained.

      ScdnAclConfig

      SCDN access control

      Used by actions: UpdateScdnDomain.

      Name Type Required Description
      Switch String Yes Whether to enable SCDN access. Values:
      on: Enable
      off: Disable
      ScriptData Array of ScdnAclGroup No This field is disused. Please use AdvancedScriptData instead.
      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.
      AdvancedScriptData Array of AdvancedScdnAclGroup No ACL rule group, which is required when the access control is on.
      Note: This field may return null, indicating that no valid value 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 Action. Valid values: intercept and redirect.
      Status String No Whether the rule is activated. Valid values: active and inactive.
      ErrorPage ScdnErrorPage No Error page configuration
      Note: This field may return null, indicating that no valid value can be obtained.

      ScdnAclRule

      Precise access control match rule

      Used by actions: UpdateScdnDomain.

      Name Type Required Description
      MatchKey String Yes Keyword
      LogiOperator String Yes Logical operator. Valid values:
      MatchValue String Yes Matched value

      ScdnBotConfig

      Bot configuration

      Used by actions: UpdateScdnDomain.

      Name Type Required Description
      Switch String Yes Whether to enable SCDN bot configuration. Values:
      on: Enable
      off: Disable
      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: Apply to files with the specified suffixes.
      directory: Apply to specified paths.
      path: Apply to 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 enable IP blocking. Values:
      on: Enable
      off: Disable
      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 Whether to enable SCDN CC configuration. Values:
      on: Enable
      off: Disable
      Rules Array of ScdnCCRules No Custom CC attack defense rule
      Note: this field may return null, indicating that no valid values can be obtained.
      AdvancedRules Array of AdvancedCCRules No Advanced custom CC attack defense rule
      Note: This field may return null, indicating that no valid value can be obtained.
      GlobalAdvancedRules Array of AdvancedCCRules No Global advanced CC protection rules
      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 SCDN DDoS configuration. Values:
      on: Enable
      off: Disable

      ScdnErrorPage

      ACL error page

      Used by actions: UpdateScdnDomain.

      Name Type Required Description
      RedirectCode Integer Yes Status code
      403 is passed in when the action is intercept.
      301 is passed in when the action is redirect.
      RedirectUrl String Yes URL to be redirected

      ScdnSevenLayerRules

      SCDN layer-7 rule configuration for CC frequency limiting

      Used by actions: UpdateScdnDomain.

      Name Type Required Description
      CaseSensitive Boolean Yes Whether values are case sensitive
      RuleType String Yes Rule types:
      protocol: protocol. Valid values: HTTP and HTTPS.
      method: request method. Valid values: HEAD, GET, POST, PUT, OPTIONS, TRACE, DELETE, PATCH and CONNECT.
      all: domain name. The matching content is * and cannot be edited.
      ip: IP in CIDR format.
      directory: path starting with a slash (/). You can specify a directory or specific path using up to 128 characters.
      index: default homepage, which is specified by /;/index.html and cannot be edited.
      path: full path of the file, such as /acb/test.png. Wildcard is supported, such as /abc/*.jpg.
      file: file extension, such as jpg, png and css.
      param: request parameter. The value can contain up to 512 characters.
      referer: Referer. The value can contain up to 512 characters.
      cookie: Cookie. The value can contain up to 512 characters.
      user-agent: User-Agent. The value can contain up to 512 characters.
      head: custom header. The value can contain up to 512 characters. If the matching content is blank or does not exist, enter the matching parameter directly.
      LogicOperator String Yes Logical operator, which connects the relation between RuleType and RuleValue. Valid values:
      exclude: the rule value is not contained.
      include: the rule value is contained.
      notequal: the rule value is not equal to the specified rule type.
      equal: the rule value is equal to the specified rule type.
      matching: the rule value matches with the prefix of the specified rule type.
      null: the rule value is empty or does not exist.
      RuleValue Array of String No Rule value
      Note: this field may return null, indicating that no valid values can be obtained.
      RuleParam String No Matched parameter. Only request parameters, Cookie, and custom request headers have a value.
      Note: this field may return null, indicating that no valid values can be obtained.

      ScdnWafConfig

      WAF configuration

      Used by actions: UpdateScdnDomain.

      Name Type Required Description
      Switch String Yes Whether to enable SCDN WAF configuration. Values:
      on: Enable
      off: Disable
      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 webshell blocking. Values:
      on: Enable
      off: Disable
      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 value can be obtained.
      SubRuleSwitch Array of WafSubRuleStatus No Whether to enable WAF sub-rules. Values:
      on: Enable
      off: Disable
      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 enable scheme as part of the cache key. Values:
      on: Enable
      off: Disable
      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 Whether to enable SCDN. Values:
      on: Enable
      off: Disable

      Seo

      SEO configuration. This is disabled by default.

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable SEO. Values:
      on: Enable
      off: Disable
      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

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

      Name Type Required Description
      CertId String No Server certificate ID, which is auto-generated when the certificate is being managed 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 value 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 value 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 value can be obtained.
      ExpireTime Timestamp No Time when the certificate expires
      Can be left blank when used as an input parameter
      Note: This field may return null, indicating that no valid value 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 value can be obtained.
      Message String No Certificate remarks
      Note: This field may return null, indicating that no valid value can be obtained.
      From String No Certificate source
      Note: This field may return null, indicating that no valid value can be obtained.

      ShareCname

      Shared CNAME configuration
      ShareCname is only available to beta users. Submit a ticket if you need it.

      Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable Shared CNAME. Values:
      on: Enable. When enabled, it uses a shared CNAME.
      off: Disable. When disabled, it uses a default CNAME.
      Cname String No Shared CNAME to be configured
      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 value can be obtained.
      FollowOrigin String Yes Follows origin server Cache-Control: max-age configurations
      on: Enable
      off: Disable
      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 value 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 value can be obtained.
      IgnoreSetCookie String Yes Ignores the Set-Cookie header of the origin server
      on: Enable
      off: Disable
      It is disabled by default.
      Note: This field may return null, indicating that no valid value 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: Enable
      off: Disable
      It is disabled by default.
      Note: This field may return null, indicating that no valid value can be obtained.
      Revalidate Revalidate No Always forwards to the origin server for verification
      Note: This field may return null, indicating that no valid value can be obtained.

      SimpleCacheRule

      Cache expiration rules configuration

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      CacheType String Yes Rule types:
      all: Apply to all files.
      file: Apply to files with the specified suffixes.
      directory: Apply to specified paths.
      path: Apply to specified absolute paths.
      index: home page
      CacheContents Array of String Yes Content for each CacheType:
      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 /.
      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/desc. Default value: 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 value can be obtained.
      Overseas OverseaConfig No Specific configuration for domain name outside mainland China.
      Note: This field may return null, indicating that no valid value can be obtained.

      StatisticItem

      Usage limit configuration

      Used by actions: AddCdnDomain, DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Type String No Type of usage limit. total: Cumulative usage; moment: Instantaneous usage.
      Note: This field may return null, indicating that no valid value can be obtained.
      UnBlockTime Integer No Unblocking time
      Note: This field may return null, indicating that no valid value can be obtained.
      BpsThreshold Integer No Bandwidth/Traffic threshold
      Note: This field may return null, indicating that no valid value can be obtained.
      CounterMeasure String No Specifies how to disable CDN service when the threshold is exceeded. RETURN_404: Return 404; RESOLVE_DNS_TO_ORIGIN: Forward to origin server.
      Note: This field may return null, indicating that no valid value can be obtained.
      AlertPercentage Integer No Threshold (in percentage) that triggers alarms
      Note: This field may return null, indicating that no valid value can be obtained.
      AlertSwitch String No Whether to enable alerts for cumulative usage limit. Values:
      on: Enable
      off: Disable
      Note: This field may return null, indicating that no valid values can be obtained.
      Metric String No Metric type. flux: Traffic; bandwidth: Bandwidth.
      Note: This field may return null, indicating that no valid value can be obtained.
      Cycle Integer No
      Switch String No Whether to enable cumulative usage limit. Values:
      on: Enable
      off: Disable
      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 Whether to enable status code caching. Values:
      on: Enable
      off: Disable
      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 value 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

      Aggregated value, which is aggregated from all data of each metric. Aggregation methods are used depending on the metric attributes.

      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 data aggregated in 5 minutes.
      avg: Average value
      Value Float Aggregated 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 can be obtained.
      TagValue String Yes Tag value
      Note: This field may return null, indicating that no valid value can be obtained.

      TimestampData

      Timestamp and its corresponding value

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

      Name Type Description
      Time Timestamp The start point of the sampling period.
      For example, if the time is set to 13:35:00, and interval is 5min, the data returned is collected 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 value can be obtained.
      Channel String Either cdn or ecdn.
      Note: This field may return null, indicating that no valid value can be obtained.
      Deleted String Whether the logset has been removed from CLS
      Note: This field may return null, indicating that no valid value can be obtained.

      TpgAdapter

      Image optimization - TpgAdapter configuration

      Used by actions: DescribeDomainsConfig.

      Name Type Required Description
      Switch String No Whether to enable TpgAdapter for image optimization. Values:
      on: Enable
      off: Disable
      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 value can be obtained.
      RealUrl String Corresponding URL
      Note: This field may return null, indicating that no valid value can be obtained.
      CreateTime String Creation time
      Note: This field may return null, indicating that no valid value can be obtained.
      UpdateTime String Update time.
      Note: This field may return null, indicating that no valid value can be obtained.

      UrlRedirect

      Configuration of URL rewriting

      Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable URL rewriting. Values:
      on: Enable
      off: Disable
      PathRules Array of UrlRedirectRule No Rule of URL rewriting 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 value 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 value can be obtained.
      FullMatch Boolean No Whether to use full-path matching or arbitrary matching
      Note: This field may return null, indicating that no valid value can be obtained.

      UserAgentFilter

      UserAgent blacklist/whitelist configuration

      Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable User-Agent blocklist/allowlist. Values:
      on: Enable
      off: Disable
      Note: This field may return null, indicating that no valid values can be obtained.
      FilterRules Array of UserAgentFilterRule No UA blacklist/whitelist effect rule list
      Note: This field may return null, indicating that no valid value can be obtained.

      UserAgentFilterRule

      UserAgent blacklist/whitelist 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 value can be obtained.
      RulePaths Array of String Yes Effective access paths
      Note: This field may return null, indicating that no valid value can be obtained.
      UserAgents Array of String Yes UserAgent list
      Note: This field may return null, indicating that no valid value can be obtained.
      FilterType String Yes Blocklist or allowlist. Valid values: blacklist, whitelist
      Note: This field may return null, indicating that no valid value 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 Whether to enable video dragging. Values:
      on: Enable
      off: Disable

      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 non-compliant resource
      forbid: Blocked
      release: Unblocked
      delay: Processing delayed
      reject: Appeal dismissed. It is still in forbid status.
      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 Whether to enable WAF sub-rules. Values:
      on: Enable
      off: Disable
      SubIds Array of Integer Yes List of rule IDs

      WebSocket

      WebSocket configuration.
      WebSocket is an ECDN feature. You can enable it in the ECDN domain name configuration.

      Used by actions: DescribeDomainsConfig, UpdateDomainConfig.

      Name Type Required Description
      Switch String Yes Whether to enable WebSocket connection timeout. Values:
      on: When it's enabled, the connection timeout can be configured.
      off: When it's disabled, the connection timeout is set to 15 seconds by default.
      Timeout Integer No Sets timeout period in seconds. Maximum value: 300
      Note: this field may return null, indicating that no valid values can be obtained.

      WebpAdapter

      Image optimization - WebpAdapter configuration

      Used by actions: DescribeDomainsConfig.

      Name Type Required Description
      Switch String No Whether to enable WebpAdapter for image optimization. Values:
      on: Enable
      off: Disable
      Note: This field may return·null, indicating that no valid values can be obtained.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy