1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. cdn
  5. getDomain
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
bytepluscc logo
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus

    Data Source schema for Byteplus::CDN::Domain

    Using getDomain

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDomain(args: GetDomainArgs, opts?: InvokeOptions): Promise<GetDomainResult>
    function getDomainOutput(args: GetDomainOutputArgs, opts?: InvokeOptions): Output<GetDomainResult>
    def get_domain(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDomainResult
    def get_domain_output(id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDomainResult]
    func LookupDomain(ctx *Context, args *LookupDomainArgs, opts ...InvokeOption) (*LookupDomainResult, error)
    func LookupDomainOutput(ctx *Context, args *LookupDomainOutputArgs, opts ...InvokeOption) LookupDomainResultOutput

    > Note: This function is named LookupDomain in the Go SDK.

    public static class GetDomain 
    {
        public static Task<GetDomainResult> InvokeAsync(GetDomainArgs args, InvokeOptions? opts = null)
        public static Output<GetDomainResult> Invoke(GetDomainInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
    public static Output<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
    
    fn::invoke:
      function: bytepluscc:cdn/getDomain:getDomain
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getDomain Result

    The following output properties are available:

    AreaAccessRule Byteplus.GetDomainAreaAccessRule
    Indicates the configuration module for the 'regional access control' feature. This feature is disabled by default.
    BackupOrigins List<string>
    Indicates the backup origin server list configured for this domain. If no backup origin server is configured for this domain, the parameter value is null.
    BrowserCaches List<Byteplus.GetDomainBrowserCach>
    Indicates the configuration module for the 'browser cache' feature. This feature is disabled by default. The parameter value is a list of rules, described as follows: Each list element is a cache rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The rule at the top of the list has the highest priority. If you create multiple rules, pay attention to whether there are containment relationships between rules. If containment exists, rules with a broader scope should appear after those with a narrower scope.
    CacheHost Byteplus.GetDomainCacheHost
    Specifies the configuration module for the 'shared cache' feature. This feature is disabled by default.
    CacheKeys List<Byteplus.GetDomainCacheKey>
    Indicates the configuration module for the 'cache key' feature. This feature is disabled by default. The parameter value is a list of rules, described as follows: Each list element is a cache key rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The rules in the list have the highest priority. If you create multiple rules, pay attention to whether there is any inclusion relationship between rules. If inclusion exists, rules with a broader scope should appear after those with a narrower scope.
    CacheShared string
    Indicates the role of this domain in the 'shared cache' configuration. The parameter has the following values: targethost: indicates the 'target domain'. cacheshared_on: indicates the 'configured domain'. If this domain is not included in any 'shared cache' configuration, the parameter value is an empty string ('').
    CacheSharedTargetHost string
    If CacheShared is cachesharedon, this parameter indicates the 'Target Domain' in the 'Shared Cache' configuration for this domain name. If CacheShared is target_host, this parameter is empty ("").
    Caches List<Byteplus.GetDomainCach>
    Represents the configuration module for the 'Cache Rule' feature. This feature is disabled by default, meaning no custom rules are created. The list can contain up to 50 rules. The order of rules in the list defines their priority, with the first rule having the highest priority. The filter in each rule specifies the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope.
    Cname string
    Indicates the CNAME assigned by the content delivery network to the acceleration domain name.
    Compression Byteplus.GetDomainCompression
    Represents the configuration module for the 'Smart Compression' feature. This feature is disabled by default.
    ConditionalOrigin Byteplus.GetDomainConditionalOrigin
    Specifies the configuration module for the 'Conditional Origin' feature.
    CreatedTime int
    Indicates the creation time of this accelerated domain name, in Unix timestamp format.
    CustomErrorPage Byteplus.GetDomainCustomErrorPage
    Indicates the configuration module for the "Custom Error Page" feature. This feature is disabled by default.
    CustomizeAccessRule Byteplus.GetDomainCustomizeAccessRule
    Represents the configuration module for the 'Custom Header Allowlist and Blocklist' feature. This feature is disabled by default.
    Domain string
    Indicates the acceleration domain name.
    DomainLock Byteplus.GetDomainDomainLock
    Indicates the lock status of this domain name.
    DownloadSpeedLimit Byteplus.GetDomainDownloadSpeedLimit
    Represents the configuration module for the 'Download Speed Limit' feature. This feature is disabled by default.
    FollowRedirect bool
    Specifies whether to enable the 'origin redirect follow' feature. The parameter values are: true: enable the feature; false: disable the feature. The default value is false.
    HttpForcedRedirect Byteplus.GetDomainHttpForcedRedirect
    Represents the configuration module for the 'Force HTTPS Redirect to HTTP' feature. This feature is disabled by default.
    Https Byteplus.GetDomainHttps
    Indicates the HTTPS configuration module. This feature is disabled by default.
    IPv6 Byteplus.GetDomainIPv6
    Indicates the configuration module for the IPv6 feature.
    Id string
    Uniquely identifies the resource.
    IpAccessRule Byteplus.GetDomainIpAccessRule
    Specifies the configuration module for the 'IP allowlist and blocklist' feature. This feature is disabled by default. There are two configuration methods: Standard configuration: Specify RuleType and Ip to configure the current domain. Global configuration: Specify SharedConfig to use a global configuration. The global configuration is the allowlist feature. You can only choose one configuration method.
    IsConflictDomain bool
    Indicates whether the domain is a conflicting domain. In CDN, each domain is unique. If you need to add a domain that already exists under another primary account, you must submit a ticket. If you successfully add the domain under your primary account, it becomes a conflicting domain. This parameter has the following values: true: the domain is a conflicting domain. false: the domain is not a conflicting domain.
    LockStatus string
    Indicates whether the configuration for this domain name can be changed. The parameter values are: on: Allowed. off: Not allowed.
    MethodDeniedRule Byteplus.GetDomainMethodDeniedRule
    Represents the configuration module for the 'Disable HTTP Method' feature. This feature is disabled by default.
    MultiRange Byteplus.GetDomainMultiRange
    Indicates the configuration module for the multi-range feature. This feature is disabled by default
    NegativeCaches List<Byteplus.GetDomainNegativeCach>
    Indicates the configuration module for the 'status code cache' feature. This feature is disabled by default. The parameter value is a list, as explained below: Each list element is a cache rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The first rule in the list has the highest priority. If you create multiple rules, pay attention to whether there is containment between rules. If containment exists, rules with a broader scope should appear after rules with a narrower scope.
    OfflineCache Byteplus.GetDomainOfflineCache
    Indicates the configuration module for the 'offline cache' feature.
    OriginAccessRule Byteplus.GetDomainOriginAccessRule
    Indicates the configuration module for the 'Origin allowlist and blacklist' feature. This feature is disabled by default.
    OriginArgs List<Byteplus.GetDomainOriginArg>
    Represents the rule list for the 'Origin Parameters' configuration module. The list can contain up to 50 rules. Each rule includes a filter (Condition) and an action performed by the CDN (OriginArgAction). The order of rules in the list defines their priority. The first rule in the list has the highest priority. The filter in each rule defines the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope. When a user request is received, the CDN matches the request against the rules in order of priority, from highest to lowest. If the request matches a rule, the CDN stops processing the remaining rules. You must add the following preset rule at the end of the rule list. You cannot modify the Condition in this rule, but you can change the configuration in OriginArgAction.
    OriginCertCheck Byteplus.GetDomainOriginCertCheck
    Origin certificate validation
    OriginHost string
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.
    OriginIPv6 string
    Indicates the configuration for "IPv6 origin fetch." This parameter has the following values: ipv6first: The content delivery network always tries to obtain the IPv6 address of the origin domain. If it cannot obtain the IPv6 address, the content delivery network then tries to obtain the IPv4 address of the origin domain. ipv4first: The content delivery network always tries to obtain the IPv4 address of the origin domain. If it cannot obtain the IPv4 address, the content delivery network then tries to obtain the IPv6 address of the origin domain. followclient: The content delivery network tries to obtain the same type of IP address as the user's request. The default value for this parameter is followclient. Since some overseas origin fetch nodes do not support sending origin fetch requests to IPv6 addresses, this feature is only available for origin fetch nodes located in mainland China.
    OriginProtocol string
    Indicates the protocol used for origin requests. The parameter has the following values: http: uses the HTTP protocol for origin requests. https: uses the HTTPS protocol for origin requests. followclient: uses the same protocol as the user's request.
    OriginRange bool
    Indicates whether the 'Range Origin' feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.
    OriginRetry Byteplus.GetDomainOriginRetry
    Indicates the configuration module for the "origin fetch retry settings" feature.
    OriginRewrite Byteplus.GetDomainOriginRewrite
    Indicates the configuration module for the 'Origin URL Rewrite' feature.
    OriginSni Byteplus.GetDomainOriginSni
    Indicates the configuration module for the 'origin SNI' feature.
    Origins List<Byteplus.GetDomainOrigin>
    Indicates the basic origin configuration module.
    PageOptimization Byteplus.GetDomainPageOptimization
    Specifies the configuration module for the 'page optimization' feature.
    PrimaryOrigins List<string>
    Indicates the list of primary origin servers configured for this domain name.
    Project string
    Indicates the project to which the acceleration domain belongs
    Quic Byteplus.GetDomainQuic
    Indicates the configuration module for the QUIC feature. This feature is disabled by default.
    RedirectionRewrite Byteplus.GetDomainRedirectionRewrite
    Represents the configuration module for the 'URL Redirect Rewrite' feature. This feature is disabled by default.
    RefererAccessRule Byteplus.GetDomainRefererAccessRule
    Indicates the configuration module for the "Referer Allowlist and Denylist" feature. This feature is disabled by default.
    RemoteAuth Byteplus.GetDomainRemoteAuth
    Indicates the configuration module for the 'remote authentication' feature. This feature is disabled by default.
    RequestBlockRule Byteplus.GetDomainRequestBlockRule
    Indicates the configuration module for the 'Custom Interception' feature. This feature is disabled by default
    RequestHeaders List<Byteplus.GetDomainRequestHeader>
    Indicates the configuration module for the 'origin HTTP request header' feature. This feature is disabled by default.
    ResponseHeaders List<Byteplus.GetDomainResponseHeader>
    Indicates the configuration module for the 'HTTP response header' feature. This feature is disabled by default.
    RewriteHls Byteplus.GetDomainRewriteHls
    Indicates the configuration module for the "Standard HLS Encryption Rewrite" feature. This feature is disabled by default.
    ServiceRegion string
    Indicates the acceleration region for this accelerated domain name. The parameter values are: chinesemainland: Chinese Mainland. global: Global. outsidechinese_mainland: Global (excluding Chinese Mainland).
    ServiceType string
    Indicates the business type of the domain name. This parameter has the following options: download: File download. web: Web page. video: Audio and video on demand.
    SignedUrlAuth Byteplus.GetDomainSignedUrlAuth
    Indicates the configuration module for the 'URL Authentication' feature. This feature is disabled by default
    Status string
    Indicates the status of the acceleration domain name. The parameter values are as follows: online: indicates normal operation. configuring: indicates configuration in progress. offline: indicates offline status.
    Tags List<Byteplus.GetDomainTag>
    Tag information
    Timeout Byteplus.GetDomainTimeout
    Indicates the configuration module for the 'origin timeout' feature. This feature is disabled by default.
    UaAccessRule Byteplus.GetDomainUaAccessRule
    Indicates the configuration module for the "UA allowlist and blocklist" feature. This feature is disabled by default.
    UpdatedTime int
    Indicates the most recent update time for this domain configuration, in Unix timestamp format.
    UrlNormalize Byteplus.GetDomainUrlNormalize
    Specifies the configuration module for the 'URL normalization' feature. This feature is disabled by default.
    VideoDrag Byteplus.GetDomainVideoDrag
    Indicates the configuration module for the "Video Drag" feature. This feature is disabled by default.
    AreaAccessRule GetDomainAreaAccessRule
    Indicates the configuration module for the 'regional access control' feature. This feature is disabled by default.
    BackupOrigins []string
    Indicates the backup origin server list configured for this domain. If no backup origin server is configured for this domain, the parameter value is null.
    BrowserCaches []GetDomainBrowserCach
    Indicates the configuration module for the 'browser cache' feature. This feature is disabled by default. The parameter value is a list of rules, described as follows: Each list element is a cache rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The rule at the top of the list has the highest priority. If you create multiple rules, pay attention to whether there are containment relationships between rules. If containment exists, rules with a broader scope should appear after those with a narrower scope.
    CacheHost GetDomainCacheHost
    Specifies the configuration module for the 'shared cache' feature. This feature is disabled by default.
    CacheKeys []GetDomainCacheKey
    Indicates the configuration module for the 'cache key' feature. This feature is disabled by default. The parameter value is a list of rules, described as follows: Each list element is a cache key rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The rules in the list have the highest priority. If you create multiple rules, pay attention to whether there is any inclusion relationship between rules. If inclusion exists, rules with a broader scope should appear after those with a narrower scope.
    CacheShared string
    Indicates the role of this domain in the 'shared cache' configuration. The parameter has the following values: targethost: indicates the 'target domain'. cacheshared_on: indicates the 'configured domain'. If this domain is not included in any 'shared cache' configuration, the parameter value is an empty string ('').
    CacheSharedTargetHost string
    If CacheShared is cachesharedon, this parameter indicates the 'Target Domain' in the 'Shared Cache' configuration for this domain name. If CacheShared is target_host, this parameter is empty ("").
    Caches []GetDomainCach
    Represents the configuration module for the 'Cache Rule' feature. This feature is disabled by default, meaning no custom rules are created. The list can contain up to 50 rules. The order of rules in the list defines their priority, with the first rule having the highest priority. The filter in each rule specifies the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope.
    Cname string
    Indicates the CNAME assigned by the content delivery network to the acceleration domain name.
    Compression GetDomainCompression
    Represents the configuration module for the 'Smart Compression' feature. This feature is disabled by default.
    ConditionalOrigin GetDomainConditionalOrigin
    Specifies the configuration module for the 'Conditional Origin' feature.
    CreatedTime int
    Indicates the creation time of this accelerated domain name, in Unix timestamp format.
    CustomErrorPage GetDomainCustomErrorPage
    Indicates the configuration module for the "Custom Error Page" feature. This feature is disabled by default.
    CustomizeAccessRule GetDomainCustomizeAccessRule
    Represents the configuration module for the 'Custom Header Allowlist and Blocklist' feature. This feature is disabled by default.
    Domain string
    Indicates the acceleration domain name.
    DomainLock GetDomainDomainLock
    Indicates the lock status of this domain name.
    DownloadSpeedLimit GetDomainDownloadSpeedLimit
    Represents the configuration module for the 'Download Speed Limit' feature. This feature is disabled by default.
    FollowRedirect bool
    Specifies whether to enable the 'origin redirect follow' feature. The parameter values are: true: enable the feature; false: disable the feature. The default value is false.
    HttpForcedRedirect GetDomainHttpForcedRedirect
    Represents the configuration module for the 'Force HTTPS Redirect to HTTP' feature. This feature is disabled by default.
    Https GetDomainHttps
    Indicates the HTTPS configuration module. This feature is disabled by default.
    IPv6 GetDomainIPv6
    Indicates the configuration module for the IPv6 feature.
    Id string
    Uniquely identifies the resource.
    IpAccessRule GetDomainIpAccessRule
    Specifies the configuration module for the 'IP allowlist and blocklist' feature. This feature is disabled by default. There are two configuration methods: Standard configuration: Specify RuleType and Ip to configure the current domain. Global configuration: Specify SharedConfig to use a global configuration. The global configuration is the allowlist feature. You can only choose one configuration method.
    IsConflictDomain bool
    Indicates whether the domain is a conflicting domain. In CDN, each domain is unique. If you need to add a domain that already exists under another primary account, you must submit a ticket. If you successfully add the domain under your primary account, it becomes a conflicting domain. This parameter has the following values: true: the domain is a conflicting domain. false: the domain is not a conflicting domain.
    LockStatus string
    Indicates whether the configuration for this domain name can be changed. The parameter values are: on: Allowed. off: Not allowed.
    MethodDeniedRule GetDomainMethodDeniedRule
    Represents the configuration module for the 'Disable HTTP Method' feature. This feature is disabled by default.
    MultiRange GetDomainMultiRange
    Indicates the configuration module for the multi-range feature. This feature is disabled by default
    NegativeCaches []GetDomainNegativeCach
    Indicates the configuration module for the 'status code cache' feature. This feature is disabled by default. The parameter value is a list, as explained below: Each list element is a cache rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The first rule in the list has the highest priority. If you create multiple rules, pay attention to whether there is containment between rules. If containment exists, rules with a broader scope should appear after rules with a narrower scope.
    OfflineCache GetDomainOfflineCache
    Indicates the configuration module for the 'offline cache' feature.
    OriginAccessRule GetDomainOriginAccessRule
    Indicates the configuration module for the 'Origin allowlist and blacklist' feature. This feature is disabled by default.
    OriginArgs []GetDomainOriginArg
    Represents the rule list for the 'Origin Parameters' configuration module. The list can contain up to 50 rules. Each rule includes a filter (Condition) and an action performed by the CDN (OriginArgAction). The order of rules in the list defines their priority. The first rule in the list has the highest priority. The filter in each rule defines the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope. When a user request is received, the CDN matches the request against the rules in order of priority, from highest to lowest. If the request matches a rule, the CDN stops processing the remaining rules. You must add the following preset rule at the end of the rule list. You cannot modify the Condition in this rule, but you can change the configuration in OriginArgAction.
    OriginCertCheck GetDomainOriginCertCheck
    Origin certificate validation
    OriginHost string
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.
    OriginIPv6 string
    Indicates the configuration for "IPv6 origin fetch." This parameter has the following values: ipv6first: The content delivery network always tries to obtain the IPv6 address of the origin domain. If it cannot obtain the IPv6 address, the content delivery network then tries to obtain the IPv4 address of the origin domain. ipv4first: The content delivery network always tries to obtain the IPv4 address of the origin domain. If it cannot obtain the IPv4 address, the content delivery network then tries to obtain the IPv6 address of the origin domain. followclient: The content delivery network tries to obtain the same type of IP address as the user's request. The default value for this parameter is followclient. Since some overseas origin fetch nodes do not support sending origin fetch requests to IPv6 addresses, this feature is only available for origin fetch nodes located in mainland China.
    OriginProtocol string
    Indicates the protocol used for origin requests. The parameter has the following values: http: uses the HTTP protocol for origin requests. https: uses the HTTPS protocol for origin requests. followclient: uses the same protocol as the user's request.
    OriginRange bool
    Indicates whether the 'Range Origin' feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.
    OriginRetry GetDomainOriginRetry
    Indicates the configuration module for the "origin fetch retry settings" feature.
    OriginRewrite GetDomainOriginRewrite
    Indicates the configuration module for the 'Origin URL Rewrite' feature.
    OriginSni GetDomainOriginSni
    Indicates the configuration module for the 'origin SNI' feature.
    Origins []GetDomainOrigin
    Indicates the basic origin configuration module.
    PageOptimization GetDomainPageOptimization
    Specifies the configuration module for the 'page optimization' feature.
    PrimaryOrigins []string
    Indicates the list of primary origin servers configured for this domain name.
    Project string
    Indicates the project to which the acceleration domain belongs
    Quic GetDomainQuic
    Indicates the configuration module for the QUIC feature. This feature is disabled by default.
    RedirectionRewrite GetDomainRedirectionRewrite
    Represents the configuration module for the 'URL Redirect Rewrite' feature. This feature is disabled by default.
    RefererAccessRule GetDomainRefererAccessRule
    Indicates the configuration module for the "Referer Allowlist and Denylist" feature. This feature is disabled by default.
    RemoteAuth GetDomainRemoteAuth
    Indicates the configuration module for the 'remote authentication' feature. This feature is disabled by default.
    RequestBlockRule GetDomainRequestBlockRule
    Indicates the configuration module for the 'Custom Interception' feature. This feature is disabled by default
    RequestHeaders []GetDomainRequestHeader
    Indicates the configuration module for the 'origin HTTP request header' feature. This feature is disabled by default.
    ResponseHeaders []GetDomainResponseHeader
    Indicates the configuration module for the 'HTTP response header' feature. This feature is disabled by default.
    RewriteHls GetDomainRewriteHls
    Indicates the configuration module for the "Standard HLS Encryption Rewrite" feature. This feature is disabled by default.
    ServiceRegion string
    Indicates the acceleration region for this accelerated domain name. The parameter values are: chinesemainland: Chinese Mainland. global: Global. outsidechinese_mainland: Global (excluding Chinese Mainland).
    ServiceType string
    Indicates the business type of the domain name. This parameter has the following options: download: File download. web: Web page. video: Audio and video on demand.
    SignedUrlAuth GetDomainSignedUrlAuth
    Indicates the configuration module for the 'URL Authentication' feature. This feature is disabled by default
    Status string
    Indicates the status of the acceleration domain name. The parameter values are as follows: online: indicates normal operation. configuring: indicates configuration in progress. offline: indicates offline status.
    Tags []GetDomainTag
    Tag information
    Timeout GetDomainTimeout
    Indicates the configuration module for the 'origin timeout' feature. This feature is disabled by default.
    UaAccessRule GetDomainUaAccessRule
    Indicates the configuration module for the "UA allowlist and blocklist" feature. This feature is disabled by default.
    UpdatedTime int
    Indicates the most recent update time for this domain configuration, in Unix timestamp format.
    UrlNormalize GetDomainUrlNormalize
    Specifies the configuration module for the 'URL normalization' feature. This feature is disabled by default.
    VideoDrag GetDomainVideoDrag
    Indicates the configuration module for the "Video Drag" feature. This feature is disabled by default.
    areaAccessRule GetDomainAreaAccessRule
    Indicates the configuration module for the 'regional access control' feature. This feature is disabled by default.
    backupOrigins List<String>
    Indicates the backup origin server list configured for this domain. If no backup origin server is configured for this domain, the parameter value is null.
    browserCaches List<GetDomainBrowserCach>
    Indicates the configuration module for the 'browser cache' feature. This feature is disabled by default. The parameter value is a list of rules, described as follows: Each list element is a cache rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The rule at the top of the list has the highest priority. If you create multiple rules, pay attention to whether there are containment relationships between rules. If containment exists, rules with a broader scope should appear after those with a narrower scope.
    cacheHost GetDomainCacheHost
    Specifies the configuration module for the 'shared cache' feature. This feature is disabled by default.
    cacheKeys List<GetDomainCacheKey>
    Indicates the configuration module for the 'cache key' feature. This feature is disabled by default. The parameter value is a list of rules, described as follows: Each list element is a cache key rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The rules in the list have the highest priority. If you create multiple rules, pay attention to whether there is any inclusion relationship between rules. If inclusion exists, rules with a broader scope should appear after those with a narrower scope.
    cacheShared String
    Indicates the role of this domain in the 'shared cache' configuration. The parameter has the following values: targethost: indicates the 'target domain'. cacheshared_on: indicates the 'configured domain'. If this domain is not included in any 'shared cache' configuration, the parameter value is an empty string ('').
    cacheSharedTargetHost String
    If CacheShared is cachesharedon, this parameter indicates the 'Target Domain' in the 'Shared Cache' configuration for this domain name. If CacheShared is target_host, this parameter is empty ("").
    caches List<GetDomainCach>
    Represents the configuration module for the 'Cache Rule' feature. This feature is disabled by default, meaning no custom rules are created. The list can contain up to 50 rules. The order of rules in the list defines their priority, with the first rule having the highest priority. The filter in each rule specifies the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope.
    cname String
    Indicates the CNAME assigned by the content delivery network to the acceleration domain name.
    compression GetDomainCompression
    Represents the configuration module for the 'Smart Compression' feature. This feature is disabled by default.
    conditionalOrigin GetDomainConditionalOrigin
    Specifies the configuration module for the 'Conditional Origin' feature.
    createdTime Integer
    Indicates the creation time of this accelerated domain name, in Unix timestamp format.
    customErrorPage GetDomainCustomErrorPage
    Indicates the configuration module for the "Custom Error Page" feature. This feature is disabled by default.
    customizeAccessRule GetDomainCustomizeAccessRule
    Represents the configuration module for the 'Custom Header Allowlist and Blocklist' feature. This feature is disabled by default.
    domain String
    Indicates the acceleration domain name.
    domainLock GetDomainDomainLock
    Indicates the lock status of this domain name.
    downloadSpeedLimit GetDomainDownloadSpeedLimit
    Represents the configuration module for the 'Download Speed Limit' feature. This feature is disabled by default.
    followRedirect Boolean
    Specifies whether to enable the 'origin redirect follow' feature. The parameter values are: true: enable the feature; false: disable the feature. The default value is false.
    httpForcedRedirect GetDomainHttpForcedRedirect
    Represents the configuration module for the 'Force HTTPS Redirect to HTTP' feature. This feature is disabled by default.
    https GetDomainHttps
    Indicates the HTTPS configuration module. This feature is disabled by default.
    iPv6 GetDomainIPv6
    Indicates the configuration module for the IPv6 feature.
    id String
    Uniquely identifies the resource.
    ipAccessRule GetDomainIpAccessRule
    Specifies the configuration module for the 'IP allowlist and blocklist' feature. This feature is disabled by default. There are two configuration methods: Standard configuration: Specify RuleType and Ip to configure the current domain. Global configuration: Specify SharedConfig to use a global configuration. The global configuration is the allowlist feature. You can only choose one configuration method.
    isConflictDomain Boolean
    Indicates whether the domain is a conflicting domain. In CDN, each domain is unique. If you need to add a domain that already exists under another primary account, you must submit a ticket. If you successfully add the domain under your primary account, it becomes a conflicting domain. This parameter has the following values: true: the domain is a conflicting domain. false: the domain is not a conflicting domain.
    lockStatus String
    Indicates whether the configuration for this domain name can be changed. The parameter values are: on: Allowed. off: Not allowed.
    methodDeniedRule GetDomainMethodDeniedRule
    Represents the configuration module for the 'Disable HTTP Method' feature. This feature is disabled by default.
    multiRange GetDomainMultiRange
    Indicates the configuration module for the multi-range feature. This feature is disabled by default
    negativeCaches List<GetDomainNegativeCach>
    Indicates the configuration module for the 'status code cache' feature. This feature is disabled by default. The parameter value is a list, as explained below: Each list element is a cache rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The first rule in the list has the highest priority. If you create multiple rules, pay attention to whether there is containment between rules. If containment exists, rules with a broader scope should appear after rules with a narrower scope.
    offlineCache GetDomainOfflineCache
    Indicates the configuration module for the 'offline cache' feature.
    originAccessRule GetDomainOriginAccessRule
    Indicates the configuration module for the 'Origin allowlist and blacklist' feature. This feature is disabled by default.
    originArgs List<GetDomainOriginArg>
    Represents the rule list for the 'Origin Parameters' configuration module. The list can contain up to 50 rules. Each rule includes a filter (Condition) and an action performed by the CDN (OriginArgAction). The order of rules in the list defines their priority. The first rule in the list has the highest priority. The filter in each rule defines the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope. When a user request is received, the CDN matches the request against the rules in order of priority, from highest to lowest. If the request matches a rule, the CDN stops processing the remaining rules. You must add the following preset rule at the end of the rule list. You cannot modify the Condition in this rule, but you can change the configuration in OriginArgAction.
    originCertCheck GetDomainOriginCertCheck
    Origin certificate validation
    originHost String
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.
    originIPv6 String
    Indicates the configuration for "IPv6 origin fetch." This parameter has the following values: ipv6first: The content delivery network always tries to obtain the IPv6 address of the origin domain. If it cannot obtain the IPv6 address, the content delivery network then tries to obtain the IPv4 address of the origin domain. ipv4first: The content delivery network always tries to obtain the IPv4 address of the origin domain. If it cannot obtain the IPv4 address, the content delivery network then tries to obtain the IPv6 address of the origin domain. followclient: The content delivery network tries to obtain the same type of IP address as the user's request. The default value for this parameter is followclient. Since some overseas origin fetch nodes do not support sending origin fetch requests to IPv6 addresses, this feature is only available for origin fetch nodes located in mainland China.
    originProtocol String
    Indicates the protocol used for origin requests. The parameter has the following values: http: uses the HTTP protocol for origin requests. https: uses the HTTPS protocol for origin requests. followclient: uses the same protocol as the user's request.
    originRange Boolean
    Indicates whether the 'Range Origin' feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.
    originRetry GetDomainOriginRetry
    Indicates the configuration module for the "origin fetch retry settings" feature.
    originRewrite GetDomainOriginRewrite
    Indicates the configuration module for the 'Origin URL Rewrite' feature.
    originSni GetDomainOriginSni
    Indicates the configuration module for the 'origin SNI' feature.
    origins List<GetDomainOrigin>
    Indicates the basic origin configuration module.
    pageOptimization GetDomainPageOptimization
    Specifies the configuration module for the 'page optimization' feature.
    primaryOrigins List<String>
    Indicates the list of primary origin servers configured for this domain name.
    project String
    Indicates the project to which the acceleration domain belongs
    quic GetDomainQuic
    Indicates the configuration module for the QUIC feature. This feature is disabled by default.
    redirectionRewrite GetDomainRedirectionRewrite
    Represents the configuration module for the 'URL Redirect Rewrite' feature. This feature is disabled by default.
    refererAccessRule GetDomainRefererAccessRule
    Indicates the configuration module for the "Referer Allowlist and Denylist" feature. This feature is disabled by default.
    remoteAuth GetDomainRemoteAuth
    Indicates the configuration module for the 'remote authentication' feature. This feature is disabled by default.
    requestBlockRule GetDomainRequestBlockRule
    Indicates the configuration module for the 'Custom Interception' feature. This feature is disabled by default
    requestHeaders List<GetDomainRequestHeader>
    Indicates the configuration module for the 'origin HTTP request header' feature. This feature is disabled by default.
    responseHeaders List<GetDomainResponseHeader>
    Indicates the configuration module for the 'HTTP response header' feature. This feature is disabled by default.
    rewriteHls GetDomainRewriteHls
    Indicates the configuration module for the "Standard HLS Encryption Rewrite" feature. This feature is disabled by default.
    serviceRegion String
    Indicates the acceleration region for this accelerated domain name. The parameter values are: chinesemainland: Chinese Mainland. global: Global. outsidechinese_mainland: Global (excluding Chinese Mainland).
    serviceType String
    Indicates the business type of the domain name. This parameter has the following options: download: File download. web: Web page. video: Audio and video on demand.
    signedUrlAuth GetDomainSignedUrlAuth
    Indicates the configuration module for the 'URL Authentication' feature. This feature is disabled by default
    status String
    Indicates the status of the acceleration domain name. The parameter values are as follows: online: indicates normal operation. configuring: indicates configuration in progress. offline: indicates offline status.
    tags List<GetDomainTag>
    Tag information
    timeout GetDomainTimeout
    Indicates the configuration module for the 'origin timeout' feature. This feature is disabled by default.
    uaAccessRule GetDomainUaAccessRule
    Indicates the configuration module for the "UA allowlist and blocklist" feature. This feature is disabled by default.
    updatedTime Integer
    Indicates the most recent update time for this domain configuration, in Unix timestamp format.
    urlNormalize GetDomainUrlNormalize
    Specifies the configuration module for the 'URL normalization' feature. This feature is disabled by default.
    videoDrag GetDomainVideoDrag
    Indicates the configuration module for the "Video Drag" feature. This feature is disabled by default.
    areaAccessRule GetDomainAreaAccessRule
    Indicates the configuration module for the 'regional access control' feature. This feature is disabled by default.
    backupOrigins string[]
    Indicates the backup origin server list configured for this domain. If no backup origin server is configured for this domain, the parameter value is null.
    browserCaches GetDomainBrowserCach[]
    Indicates the configuration module for the 'browser cache' feature. This feature is disabled by default. The parameter value is a list of rules, described as follows: Each list element is a cache rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The rule at the top of the list has the highest priority. If you create multiple rules, pay attention to whether there are containment relationships between rules. If containment exists, rules with a broader scope should appear after those with a narrower scope.
    cacheHost GetDomainCacheHost
    Specifies the configuration module for the 'shared cache' feature. This feature is disabled by default.
    cacheKeys GetDomainCacheKey[]
    Indicates the configuration module for the 'cache key' feature. This feature is disabled by default. The parameter value is a list of rules, described as follows: Each list element is a cache key rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The rules in the list have the highest priority. If you create multiple rules, pay attention to whether there is any inclusion relationship between rules. If inclusion exists, rules with a broader scope should appear after those with a narrower scope.
    cacheShared string
    Indicates the role of this domain in the 'shared cache' configuration. The parameter has the following values: targethost: indicates the 'target domain'. cacheshared_on: indicates the 'configured domain'. If this domain is not included in any 'shared cache' configuration, the parameter value is an empty string ('').
    cacheSharedTargetHost string
    If CacheShared is cachesharedon, this parameter indicates the 'Target Domain' in the 'Shared Cache' configuration for this domain name. If CacheShared is target_host, this parameter is empty ("").
    caches GetDomainCach[]
    Represents the configuration module for the 'Cache Rule' feature. This feature is disabled by default, meaning no custom rules are created. The list can contain up to 50 rules. The order of rules in the list defines their priority, with the first rule having the highest priority. The filter in each rule specifies the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope.
    cname string
    Indicates the CNAME assigned by the content delivery network to the acceleration domain name.
    compression GetDomainCompression
    Represents the configuration module for the 'Smart Compression' feature. This feature is disabled by default.
    conditionalOrigin GetDomainConditionalOrigin
    Specifies the configuration module for the 'Conditional Origin' feature.
    createdTime number
    Indicates the creation time of this accelerated domain name, in Unix timestamp format.
    customErrorPage GetDomainCustomErrorPage
    Indicates the configuration module for the "Custom Error Page" feature. This feature is disabled by default.
    customizeAccessRule GetDomainCustomizeAccessRule
    Represents the configuration module for the 'Custom Header Allowlist and Blocklist' feature. This feature is disabled by default.
    domain string
    Indicates the acceleration domain name.
    domainLock GetDomainDomainLock
    Indicates the lock status of this domain name.
    downloadSpeedLimit GetDomainDownloadSpeedLimit
    Represents the configuration module for the 'Download Speed Limit' feature. This feature is disabled by default.
    followRedirect boolean
    Specifies whether to enable the 'origin redirect follow' feature. The parameter values are: true: enable the feature; false: disable the feature. The default value is false.
    httpForcedRedirect GetDomainHttpForcedRedirect
    Represents the configuration module for the 'Force HTTPS Redirect to HTTP' feature. This feature is disabled by default.
    https GetDomainHttps
    Indicates the HTTPS configuration module. This feature is disabled by default.
    iPv6 GetDomainIPv6
    Indicates the configuration module for the IPv6 feature.
    id string
    Uniquely identifies the resource.
    ipAccessRule GetDomainIpAccessRule
    Specifies the configuration module for the 'IP allowlist and blocklist' feature. This feature is disabled by default. There are two configuration methods: Standard configuration: Specify RuleType and Ip to configure the current domain. Global configuration: Specify SharedConfig to use a global configuration. The global configuration is the allowlist feature. You can only choose one configuration method.
    isConflictDomain boolean
    Indicates whether the domain is a conflicting domain. In CDN, each domain is unique. If you need to add a domain that already exists under another primary account, you must submit a ticket. If you successfully add the domain under your primary account, it becomes a conflicting domain. This parameter has the following values: true: the domain is a conflicting domain. false: the domain is not a conflicting domain.
    lockStatus string
    Indicates whether the configuration for this domain name can be changed. The parameter values are: on: Allowed. off: Not allowed.
    methodDeniedRule GetDomainMethodDeniedRule
    Represents the configuration module for the 'Disable HTTP Method' feature. This feature is disabled by default.
    multiRange GetDomainMultiRange
    Indicates the configuration module for the multi-range feature. This feature is disabled by default
    negativeCaches GetDomainNegativeCach[]
    Indicates the configuration module for the 'status code cache' feature. This feature is disabled by default. The parameter value is a list, as explained below: Each list element is a cache rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The first rule in the list has the highest priority. If you create multiple rules, pay attention to whether there is containment between rules. If containment exists, rules with a broader scope should appear after rules with a narrower scope.
    offlineCache GetDomainOfflineCache
    Indicates the configuration module for the 'offline cache' feature.
    originAccessRule GetDomainOriginAccessRule
    Indicates the configuration module for the 'Origin allowlist and blacklist' feature. This feature is disabled by default.
    originArgs GetDomainOriginArg[]
    Represents the rule list for the 'Origin Parameters' configuration module. The list can contain up to 50 rules. Each rule includes a filter (Condition) and an action performed by the CDN (OriginArgAction). The order of rules in the list defines their priority. The first rule in the list has the highest priority. The filter in each rule defines the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope. When a user request is received, the CDN matches the request against the rules in order of priority, from highest to lowest. If the request matches a rule, the CDN stops processing the remaining rules. You must add the following preset rule at the end of the rule list. You cannot modify the Condition in this rule, but you can change the configuration in OriginArgAction.
    originCertCheck GetDomainOriginCertCheck
    Origin certificate validation
    originHost string
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.
    originIPv6 string
    Indicates the configuration for "IPv6 origin fetch." This parameter has the following values: ipv6first: The content delivery network always tries to obtain the IPv6 address of the origin domain. If it cannot obtain the IPv6 address, the content delivery network then tries to obtain the IPv4 address of the origin domain. ipv4first: The content delivery network always tries to obtain the IPv4 address of the origin domain. If it cannot obtain the IPv4 address, the content delivery network then tries to obtain the IPv6 address of the origin domain. followclient: The content delivery network tries to obtain the same type of IP address as the user's request. The default value for this parameter is followclient. Since some overseas origin fetch nodes do not support sending origin fetch requests to IPv6 addresses, this feature is only available for origin fetch nodes located in mainland China.
    originProtocol string
    Indicates the protocol used for origin requests. The parameter has the following values: http: uses the HTTP protocol for origin requests. https: uses the HTTPS protocol for origin requests. followclient: uses the same protocol as the user's request.
    originRange boolean
    Indicates whether the 'Range Origin' feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.
    originRetry GetDomainOriginRetry
    Indicates the configuration module for the "origin fetch retry settings" feature.
    originRewrite GetDomainOriginRewrite
    Indicates the configuration module for the 'Origin URL Rewrite' feature.
    originSni GetDomainOriginSni
    Indicates the configuration module for the 'origin SNI' feature.
    origins GetDomainOrigin[]
    Indicates the basic origin configuration module.
    pageOptimization GetDomainPageOptimization
    Specifies the configuration module for the 'page optimization' feature.
    primaryOrigins string[]
    Indicates the list of primary origin servers configured for this domain name.
    project string
    Indicates the project to which the acceleration domain belongs
    quic GetDomainQuic
    Indicates the configuration module for the QUIC feature. This feature is disabled by default.
    redirectionRewrite GetDomainRedirectionRewrite
    Represents the configuration module for the 'URL Redirect Rewrite' feature. This feature is disabled by default.
    refererAccessRule GetDomainRefererAccessRule
    Indicates the configuration module for the "Referer Allowlist and Denylist" feature. This feature is disabled by default.
    remoteAuth GetDomainRemoteAuth
    Indicates the configuration module for the 'remote authentication' feature. This feature is disabled by default.
    requestBlockRule GetDomainRequestBlockRule
    Indicates the configuration module for the 'Custom Interception' feature. This feature is disabled by default
    requestHeaders GetDomainRequestHeader[]
    Indicates the configuration module for the 'origin HTTP request header' feature. This feature is disabled by default.
    responseHeaders GetDomainResponseHeader[]
    Indicates the configuration module for the 'HTTP response header' feature. This feature is disabled by default.
    rewriteHls GetDomainRewriteHls
    Indicates the configuration module for the "Standard HLS Encryption Rewrite" feature. This feature is disabled by default.
    serviceRegion string
    Indicates the acceleration region for this accelerated domain name. The parameter values are: chinesemainland: Chinese Mainland. global: Global. outsidechinese_mainland: Global (excluding Chinese Mainland).
    serviceType string
    Indicates the business type of the domain name. This parameter has the following options: download: File download. web: Web page. video: Audio and video on demand.
    signedUrlAuth GetDomainSignedUrlAuth
    Indicates the configuration module for the 'URL Authentication' feature. This feature is disabled by default
    status string
    Indicates the status of the acceleration domain name. The parameter values are as follows: online: indicates normal operation. configuring: indicates configuration in progress. offline: indicates offline status.
    tags GetDomainTag[]
    Tag information
    timeout GetDomainTimeout
    Indicates the configuration module for the 'origin timeout' feature. This feature is disabled by default.
    uaAccessRule GetDomainUaAccessRule
    Indicates the configuration module for the "UA allowlist and blocklist" feature. This feature is disabled by default.
    updatedTime number
    Indicates the most recent update time for this domain configuration, in Unix timestamp format.
    urlNormalize GetDomainUrlNormalize
    Specifies the configuration module for the 'URL normalization' feature. This feature is disabled by default.
    videoDrag GetDomainVideoDrag
    Indicates the configuration module for the "Video Drag" feature. This feature is disabled by default.
    area_access_rule GetDomainAreaAccessRule
    Indicates the configuration module for the 'regional access control' feature. This feature is disabled by default.
    backup_origins Sequence[str]
    Indicates the backup origin server list configured for this domain. If no backup origin server is configured for this domain, the parameter value is null.
    browser_caches Sequence[GetDomainBrowserCach]
    Indicates the configuration module for the 'browser cache' feature. This feature is disabled by default. The parameter value is a list of rules, described as follows: Each list element is a cache rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The rule at the top of the list has the highest priority. If you create multiple rules, pay attention to whether there are containment relationships between rules. If containment exists, rules with a broader scope should appear after those with a narrower scope.
    cache_host GetDomainCacheHost
    Specifies the configuration module for the 'shared cache' feature. This feature is disabled by default.
    cache_keys Sequence[GetDomainCacheKey]
    Indicates the configuration module for the 'cache key' feature. This feature is disabled by default. The parameter value is a list of rules, described as follows: Each list element is a cache key rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The rules in the list have the highest priority. If you create multiple rules, pay attention to whether there is any inclusion relationship between rules. If inclusion exists, rules with a broader scope should appear after those with a narrower scope.
    cache_shared str
    Indicates the role of this domain in the 'shared cache' configuration. The parameter has the following values: targethost: indicates the 'target domain'. cacheshared_on: indicates the 'configured domain'. If this domain is not included in any 'shared cache' configuration, the parameter value is an empty string ('').
    cache_shared_target_host str
    If CacheShared is cachesharedon, this parameter indicates the 'Target Domain' in the 'Shared Cache' configuration for this domain name. If CacheShared is target_host, this parameter is empty ("").
    caches Sequence[GetDomainCach]
    Represents the configuration module for the 'Cache Rule' feature. This feature is disabled by default, meaning no custom rules are created. The list can contain up to 50 rules. The order of rules in the list defines their priority, with the first rule having the highest priority. The filter in each rule specifies the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope.
    cname str
    Indicates the CNAME assigned by the content delivery network to the acceleration domain name.
    compression GetDomainCompression
    Represents the configuration module for the 'Smart Compression' feature. This feature is disabled by default.
    conditional_origin GetDomainConditionalOrigin
    Specifies the configuration module for the 'Conditional Origin' feature.
    created_time int
    Indicates the creation time of this accelerated domain name, in Unix timestamp format.
    custom_error_page GetDomainCustomErrorPage
    Indicates the configuration module for the "Custom Error Page" feature. This feature is disabled by default.
    customize_access_rule GetDomainCustomizeAccessRule
    Represents the configuration module for the 'Custom Header Allowlist and Blocklist' feature. This feature is disabled by default.
    domain str
    Indicates the acceleration domain name.
    domain_lock GetDomainDomainLock
    Indicates the lock status of this domain name.
    download_speed_limit GetDomainDownloadSpeedLimit
    Represents the configuration module for the 'Download Speed Limit' feature. This feature is disabled by default.
    follow_redirect bool
    Specifies whether to enable the 'origin redirect follow' feature. The parameter values are: true: enable the feature; false: disable the feature. The default value is false.
    http_forced_redirect GetDomainHttpForcedRedirect
    Represents the configuration module for the 'Force HTTPS Redirect to HTTP' feature. This feature is disabled by default.
    https GetDomainHttps
    Indicates the HTTPS configuration module. This feature is disabled by default.
    i_pv6 GetDomainIPv6
    Indicates the configuration module for the IPv6 feature.
    id str
    Uniquely identifies the resource.
    ip_access_rule GetDomainIpAccessRule
    Specifies the configuration module for the 'IP allowlist and blocklist' feature. This feature is disabled by default. There are two configuration methods: Standard configuration: Specify RuleType and Ip to configure the current domain. Global configuration: Specify SharedConfig to use a global configuration. The global configuration is the allowlist feature. You can only choose one configuration method.
    is_conflict_domain bool
    Indicates whether the domain is a conflicting domain. In CDN, each domain is unique. If you need to add a domain that already exists under another primary account, you must submit a ticket. If you successfully add the domain under your primary account, it becomes a conflicting domain. This parameter has the following values: true: the domain is a conflicting domain. false: the domain is not a conflicting domain.
    lock_status str
    Indicates whether the configuration for this domain name can be changed. The parameter values are: on: Allowed. off: Not allowed.
    method_denied_rule GetDomainMethodDeniedRule
    Represents the configuration module for the 'Disable HTTP Method' feature. This feature is disabled by default.
    multi_range GetDomainMultiRange
    Indicates the configuration module for the multi-range feature. This feature is disabled by default
    negative_caches Sequence[GetDomainNegativeCach]
    Indicates the configuration module for the 'status code cache' feature. This feature is disabled by default. The parameter value is a list, as explained below: Each list element is a cache rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The first rule in the list has the highest priority. If you create multiple rules, pay attention to whether there is containment between rules. If containment exists, rules with a broader scope should appear after rules with a narrower scope.
    offline_cache GetDomainOfflineCache
    Indicates the configuration module for the 'offline cache' feature.
    origin_access_rule GetDomainOriginAccessRule
    Indicates the configuration module for the 'Origin allowlist and blacklist' feature. This feature is disabled by default.
    origin_args Sequence[GetDomainOriginArg]
    Represents the rule list for the 'Origin Parameters' configuration module. The list can contain up to 50 rules. Each rule includes a filter (Condition) and an action performed by the CDN (OriginArgAction). The order of rules in the list defines their priority. The first rule in the list has the highest priority. The filter in each rule defines the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope. When a user request is received, the CDN matches the request against the rules in order of priority, from highest to lowest. If the request matches a rule, the CDN stops processing the remaining rules. You must add the following preset rule at the end of the rule list. You cannot modify the Condition in this rule, but you can change the configuration in OriginArgAction.
    origin_cert_check GetDomainOriginCertCheck
    Origin certificate validation
    origin_host str
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.
    origin_i_pv6 str
    Indicates the configuration for "IPv6 origin fetch." This parameter has the following values: ipv6first: The content delivery network always tries to obtain the IPv6 address of the origin domain. If it cannot obtain the IPv6 address, the content delivery network then tries to obtain the IPv4 address of the origin domain. ipv4first: The content delivery network always tries to obtain the IPv4 address of the origin domain. If it cannot obtain the IPv4 address, the content delivery network then tries to obtain the IPv6 address of the origin domain. followclient: The content delivery network tries to obtain the same type of IP address as the user's request. The default value for this parameter is followclient. Since some overseas origin fetch nodes do not support sending origin fetch requests to IPv6 addresses, this feature is only available for origin fetch nodes located in mainland China.
    origin_protocol str
    Indicates the protocol used for origin requests. The parameter has the following values: http: uses the HTTP protocol for origin requests. https: uses the HTTPS protocol for origin requests. followclient: uses the same protocol as the user's request.
    origin_range bool
    Indicates whether the 'Range Origin' feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.
    origin_retry GetDomainOriginRetry
    Indicates the configuration module for the "origin fetch retry settings" feature.
    origin_rewrite GetDomainOriginRewrite
    Indicates the configuration module for the 'Origin URL Rewrite' feature.
    origin_sni GetDomainOriginSni
    Indicates the configuration module for the 'origin SNI' feature.
    origins Sequence[GetDomainOrigin]
    Indicates the basic origin configuration module.
    page_optimization GetDomainPageOptimization
    Specifies the configuration module for the 'page optimization' feature.
    primary_origins Sequence[str]
    Indicates the list of primary origin servers configured for this domain name.
    project str
    Indicates the project to which the acceleration domain belongs
    quic GetDomainQuic
    Indicates the configuration module for the QUIC feature. This feature is disabled by default.
    redirection_rewrite GetDomainRedirectionRewrite
    Represents the configuration module for the 'URL Redirect Rewrite' feature. This feature is disabled by default.
    referer_access_rule GetDomainRefererAccessRule
    Indicates the configuration module for the "Referer Allowlist and Denylist" feature. This feature is disabled by default.
    remote_auth GetDomainRemoteAuth
    Indicates the configuration module for the 'remote authentication' feature. This feature is disabled by default.
    request_block_rule GetDomainRequestBlockRule
    Indicates the configuration module for the 'Custom Interception' feature. This feature is disabled by default
    request_headers Sequence[GetDomainRequestHeader]
    Indicates the configuration module for the 'origin HTTP request header' feature. This feature is disabled by default.
    response_headers Sequence[GetDomainResponseHeader]
    Indicates the configuration module for the 'HTTP response header' feature. This feature is disabled by default.
    rewrite_hls GetDomainRewriteHls
    Indicates the configuration module for the "Standard HLS Encryption Rewrite" feature. This feature is disabled by default.
    service_region str
    Indicates the acceleration region for this accelerated domain name. The parameter values are: chinesemainland: Chinese Mainland. global: Global. outsidechinese_mainland: Global (excluding Chinese Mainland).
    service_type str
    Indicates the business type of the domain name. This parameter has the following options: download: File download. web: Web page. video: Audio and video on demand.
    signed_url_auth GetDomainSignedUrlAuth
    Indicates the configuration module for the 'URL Authentication' feature. This feature is disabled by default
    status str
    Indicates the status of the acceleration domain name. The parameter values are as follows: online: indicates normal operation. configuring: indicates configuration in progress. offline: indicates offline status.
    tags Sequence[GetDomainTag]
    Tag information
    timeout GetDomainTimeout
    Indicates the configuration module for the 'origin timeout' feature. This feature is disabled by default.
    ua_access_rule GetDomainUaAccessRule
    Indicates the configuration module for the "UA allowlist and blocklist" feature. This feature is disabled by default.
    updated_time int
    Indicates the most recent update time for this domain configuration, in Unix timestamp format.
    url_normalize GetDomainUrlNormalize
    Specifies the configuration module for the 'URL normalization' feature. This feature is disabled by default.
    video_drag GetDomainVideoDrag
    Indicates the configuration module for the "Video Drag" feature. This feature is disabled by default.
    areaAccessRule Property Map
    Indicates the configuration module for the 'regional access control' feature. This feature is disabled by default.
    backupOrigins List<String>
    Indicates the backup origin server list configured for this domain. If no backup origin server is configured for this domain, the parameter value is null.
    browserCaches List<Property Map>
    Indicates the configuration module for the 'browser cache' feature. This feature is disabled by default. The parameter value is a list of rules, described as follows: Each list element is a cache rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The rule at the top of the list has the highest priority. If you create multiple rules, pay attention to whether there are containment relationships between rules. If containment exists, rules with a broader scope should appear after those with a narrower scope.
    cacheHost Property Map
    Specifies the configuration module for the 'shared cache' feature. This feature is disabled by default.
    cacheKeys List<Property Map>
    Indicates the configuration module for the 'cache key' feature. This feature is disabled by default. The parameter value is a list of rules, described as follows: Each list element is a cache key rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The rules in the list have the highest priority. If you create multiple rules, pay attention to whether there is any inclusion relationship between rules. If inclusion exists, rules with a broader scope should appear after those with a narrower scope.
    cacheShared String
    Indicates the role of this domain in the 'shared cache' configuration. The parameter has the following values: targethost: indicates the 'target domain'. cacheshared_on: indicates the 'configured domain'. If this domain is not included in any 'shared cache' configuration, the parameter value is an empty string ('').
    cacheSharedTargetHost String
    If CacheShared is cachesharedon, this parameter indicates the 'Target Domain' in the 'Shared Cache' configuration for this domain name. If CacheShared is target_host, this parameter is empty ("").
    caches List<Property Map>
    Represents the configuration module for the 'Cache Rule' feature. This feature is disabled by default, meaning no custom rules are created. The list can contain up to 50 rules. The order of rules in the list defines their priority, with the first rule having the highest priority. The filter in each rule specifies the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope.
    cname String
    Indicates the CNAME assigned by the content delivery network to the acceleration domain name.
    compression Property Map
    Represents the configuration module for the 'Smart Compression' feature. This feature is disabled by default.
    conditionalOrigin Property Map
    Specifies the configuration module for the 'Conditional Origin' feature.
    createdTime Number
    Indicates the creation time of this accelerated domain name, in Unix timestamp format.
    customErrorPage Property Map
    Indicates the configuration module for the "Custom Error Page" feature. This feature is disabled by default.
    customizeAccessRule Property Map
    Represents the configuration module for the 'Custom Header Allowlist and Blocklist' feature. This feature is disabled by default.
    domain String
    Indicates the acceleration domain name.
    domainLock Property Map
    Indicates the lock status of this domain name.
    downloadSpeedLimit Property Map
    Represents the configuration module for the 'Download Speed Limit' feature. This feature is disabled by default.
    followRedirect Boolean
    Specifies whether to enable the 'origin redirect follow' feature. The parameter values are: true: enable the feature; false: disable the feature. The default value is false.
    httpForcedRedirect Property Map
    Represents the configuration module for the 'Force HTTPS Redirect to HTTP' feature. This feature is disabled by default.
    https Property Map
    Indicates the HTTPS configuration module. This feature is disabled by default.
    iPv6 Property Map
    Indicates the configuration module for the IPv6 feature.
    id String
    Uniquely identifies the resource.
    ipAccessRule Property Map
    Specifies the configuration module for the 'IP allowlist and blocklist' feature. This feature is disabled by default. There are two configuration methods: Standard configuration: Specify RuleType and Ip to configure the current domain. Global configuration: Specify SharedConfig to use a global configuration. The global configuration is the allowlist feature. You can only choose one configuration method.
    isConflictDomain Boolean
    Indicates whether the domain is a conflicting domain. In CDN, each domain is unique. If you need to add a domain that already exists under another primary account, you must submit a ticket. If you successfully add the domain under your primary account, it becomes a conflicting domain. This parameter has the following values: true: the domain is a conflicting domain. false: the domain is not a conflicting domain.
    lockStatus String
    Indicates whether the configuration for this domain name can be changed. The parameter values are: on: Allowed. off: Not allowed.
    methodDeniedRule Property Map
    Represents the configuration module for the 'Disable HTTP Method' feature. This feature is disabled by default.
    multiRange Property Map
    Indicates the configuration module for the multi-range feature. This feature is disabled by default
    negativeCaches List<Property Map>
    Indicates the configuration module for the 'status code cache' feature. This feature is disabled by default. The parameter value is a list, as explained below: Each list element is a cache rule configuration. You can create up to 50 rules. The order of elements in the list determines the priority of the corresponding rules. The first rule in the list has the highest priority. If you create multiple rules, pay attention to whether there is containment between rules. If containment exists, rules with a broader scope should appear after rules with a narrower scope.
    offlineCache Property Map
    Indicates the configuration module for the 'offline cache' feature.
    originAccessRule Property Map
    Indicates the configuration module for the 'Origin allowlist and blacklist' feature. This feature is disabled by default.
    originArgs List<Property Map>
    Represents the rule list for the 'Origin Parameters' configuration module. The list can contain up to 50 rules. Each rule includes a filter (Condition) and an action performed by the CDN (OriginArgAction). The order of rules in the list defines their priority. The first rule in the list has the highest priority. The filter in each rule defines the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope. When a user request is received, the CDN matches the request against the rules in order of priority, from highest to lowest. If the request matches a rule, the CDN stops processing the remaining rules. You must add the following preset rule at the end of the rule list. You cannot modify the Condition in this rule, but you can change the configuration in OriginArgAction.
    originCertCheck Property Map
    Origin certificate validation
    originHost String
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.
    originIPv6 String
    Indicates the configuration for "IPv6 origin fetch." This parameter has the following values: ipv6first: The content delivery network always tries to obtain the IPv6 address of the origin domain. If it cannot obtain the IPv6 address, the content delivery network then tries to obtain the IPv4 address of the origin domain. ipv4first: The content delivery network always tries to obtain the IPv4 address of the origin domain. If it cannot obtain the IPv4 address, the content delivery network then tries to obtain the IPv6 address of the origin domain. followclient: The content delivery network tries to obtain the same type of IP address as the user's request. The default value for this parameter is followclient. Since some overseas origin fetch nodes do not support sending origin fetch requests to IPv6 addresses, this feature is only available for origin fetch nodes located in mainland China.
    originProtocol String
    Indicates the protocol used for origin requests. The parameter has the following values: http: uses the HTTP protocol for origin requests. https: uses the HTTPS protocol for origin requests. followclient: uses the same protocol as the user's request.
    originRange Boolean
    Indicates whether the 'Range Origin' feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.
    originRetry Property Map
    Indicates the configuration module for the "origin fetch retry settings" feature.
    originRewrite Property Map
    Indicates the configuration module for the 'Origin URL Rewrite' feature.
    originSni Property Map
    Indicates the configuration module for the 'origin SNI' feature.
    origins List<Property Map>
    Indicates the basic origin configuration module.
    pageOptimization Property Map
    Specifies the configuration module for the 'page optimization' feature.
    primaryOrigins List<String>
    Indicates the list of primary origin servers configured for this domain name.
    project String
    Indicates the project to which the acceleration domain belongs
    quic Property Map
    Indicates the configuration module for the QUIC feature. This feature is disabled by default.
    redirectionRewrite Property Map
    Represents the configuration module for the 'URL Redirect Rewrite' feature. This feature is disabled by default.
    refererAccessRule Property Map
    Indicates the configuration module for the "Referer Allowlist and Denylist" feature. This feature is disabled by default.
    remoteAuth Property Map
    Indicates the configuration module for the 'remote authentication' feature. This feature is disabled by default.
    requestBlockRule Property Map
    Indicates the configuration module for the 'Custom Interception' feature. This feature is disabled by default
    requestHeaders List<Property Map>
    Indicates the configuration module for the 'origin HTTP request header' feature. This feature is disabled by default.
    responseHeaders List<Property Map>
    Indicates the configuration module for the 'HTTP response header' feature. This feature is disabled by default.
    rewriteHls Property Map
    Indicates the configuration module for the "Standard HLS Encryption Rewrite" feature. This feature is disabled by default.
    serviceRegion String
    Indicates the acceleration region for this accelerated domain name. The parameter values are: chinesemainland: Chinese Mainland. global: Global. outsidechinese_mainland: Global (excluding Chinese Mainland).
    serviceType String
    Indicates the business type of the domain name. This parameter has the following options: download: File download. web: Web page. video: Audio and video on demand.
    signedUrlAuth Property Map
    Indicates the configuration module for the 'URL Authentication' feature. This feature is disabled by default
    status String
    Indicates the status of the acceleration domain name. The parameter values are as follows: online: indicates normal operation. configuring: indicates configuration in progress. offline: indicates offline status.
    tags List<Property Map>
    Tag information
    timeout Property Map
    Indicates the configuration module for the 'origin timeout' feature. This feature is disabled by default.
    uaAccessRule Property Map
    Indicates the configuration module for the "UA allowlist and blocklist" feature. This feature is disabled by default.
    updatedTime Number
    Indicates the most recent update time for this domain configuration, in Unix timestamp format.
    urlNormalize Property Map
    Specifies the configuration module for the 'URL normalization' feature. This feature is disabled by default.
    videoDrag Property Map
    Indicates the configuration module for the "Video Drag" feature. This feature is disabled by default.

    Supporting Types

    GetDomainAreaAccessRule

    Areas List<string>
    Indicates a list of countries to which an allowlist or denylist is applied. When Switch is true, this parameter is required. Country names are represented in abbreviated form. Multiple country names are separated by commas (,).
    RuleType string
    Indicates the rule type for the 'region access control' feature. This parameter has the following values: deny: indicates Denylist. allow: indicates Allowlist.
    Switch bool
    Indicates whether to enable this feature. This parameter has the following values: true: Enables this feature. false: Disables this feature.
    Areas []string
    Indicates a list of countries to which an allowlist or denylist is applied. When Switch is true, this parameter is required. Country names are represented in abbreviated form. Multiple country names are separated by commas (,).
    RuleType string
    Indicates the rule type for the 'region access control' feature. This parameter has the following values: deny: indicates Denylist. allow: indicates Allowlist.
    Switch bool
    Indicates whether to enable this feature. This parameter has the following values: true: Enables this feature. false: Disables this feature.
    areas List<String>
    Indicates a list of countries to which an allowlist or denylist is applied. When Switch is true, this parameter is required. Country names are represented in abbreviated form. Multiple country names are separated by commas (,).
    ruleType String
    Indicates the rule type for the 'region access control' feature. This parameter has the following values: deny: indicates Denylist. allow: indicates Allowlist.
    switch_ Boolean
    Indicates whether to enable this feature. This parameter has the following values: true: Enables this feature. false: Disables this feature.
    areas string[]
    Indicates a list of countries to which an allowlist or denylist is applied. When Switch is true, this parameter is required. Country names are represented in abbreviated form. Multiple country names are separated by commas (,).
    ruleType string
    Indicates the rule type for the 'region access control' feature. This parameter has the following values: deny: indicates Denylist. allow: indicates Allowlist.
    switch boolean
    Indicates whether to enable this feature. This parameter has the following values: true: Enables this feature. false: Disables this feature.
    areas Sequence[str]
    Indicates a list of countries to which an allowlist or denylist is applied. When Switch is true, this parameter is required. Country names are represented in abbreviated form. Multiple country names are separated by commas (,).
    rule_type str
    Indicates the rule type for the 'region access control' feature. This parameter has the following values: deny: indicates Denylist. allow: indicates Allowlist.
    switch bool
    Indicates whether to enable this feature. This parameter has the following values: true: Enables this feature. false: Disables this feature.
    areas List<String>
    Indicates a list of countries to which an allowlist or denylist is applied. When Switch is true, this parameter is required. Country names are represented in abbreviated form. Multiple country names are separated by commas (,).
    ruleType String
    Indicates the rule type for the 'region access control' feature. This parameter has the following values: deny: indicates Denylist. allow: indicates Allowlist.
    switch Boolean
    Indicates whether to enable this feature. This parameter has the following values: true: Enables this feature. false: Disables this feature.

    GetDomainBrowserCach

    CacheAction Byteplus.GetDomainBrowserCachCacheAction
    Indicates the relevant configuration for cache behavior.
    Condition Byteplus.GetDomainBrowserCachCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    CacheAction GetDomainBrowserCachCacheAction
    Indicates the relevant configuration for cache behavior.
    Condition GetDomainBrowserCachCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    cacheAction GetDomainBrowserCachCacheAction
    Indicates the relevant configuration for cache behavior.
    condition GetDomainBrowserCachCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    cacheAction GetDomainBrowserCachCacheAction
    Indicates the relevant configuration for cache behavior.
    condition GetDomainBrowserCachCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    cache_action GetDomainBrowserCachCacheAction
    Indicates the relevant configuration for cache behavior.
    condition GetDomainBrowserCachCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    cacheAction Property Map
    Indicates the relevant configuration for cache behavior.
    condition Property Map
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.

    GetDomainBrowserCachCacheAction

    Action string
    Indicates caching behavior. Currently, you can only specify cache. cache means the behavior is caching.
    DefaultPolicy string
    This parameter is shared by multiple CDN features.
    IgnoreCase bool
    Indicates whether Value is case sensitive. The parameter has the following values: true: not case sensitive. false: case sensitive. The default value is false.
    Ttl int
    Indicates the cache duration in seconds. The valid range is 0–315,360,000. 315,360,000 represents 10 years. If you do not want the content delivery network to cache the specified content, set this parameter to 0.
    Action string
    Indicates caching behavior. Currently, you can only specify cache. cache means the behavior is caching.
    DefaultPolicy string
    This parameter is shared by multiple CDN features.
    IgnoreCase bool
    Indicates whether Value is case sensitive. The parameter has the following values: true: not case sensitive. false: case sensitive. The default value is false.
    Ttl int
    Indicates the cache duration in seconds. The valid range is 0–315,360,000. 315,360,000 represents 10 years. If you do not want the content delivery network to cache the specified content, set this parameter to 0.
    action String
    Indicates caching behavior. Currently, you can only specify cache. cache means the behavior is caching.
    defaultPolicy String
    This parameter is shared by multiple CDN features.
    ignoreCase Boolean
    Indicates whether Value is case sensitive. The parameter has the following values: true: not case sensitive. false: case sensitive. The default value is false.
    ttl Integer
    Indicates the cache duration in seconds. The valid range is 0–315,360,000. 315,360,000 represents 10 years. If you do not want the content delivery network to cache the specified content, set this parameter to 0.
    action string
    Indicates caching behavior. Currently, you can only specify cache. cache means the behavior is caching.
    defaultPolicy string
    This parameter is shared by multiple CDN features.
    ignoreCase boolean
    Indicates whether Value is case sensitive. The parameter has the following values: true: not case sensitive. false: case sensitive. The default value is false.
    ttl number
    Indicates the cache duration in seconds. The valid range is 0–315,360,000. 315,360,000 represents 10 years. If you do not want the content delivery network to cache the specified content, set this parameter to 0.
    action str
    Indicates caching behavior. Currently, you can only specify cache. cache means the behavior is caching.
    default_policy str
    This parameter is shared by multiple CDN features.
    ignore_case bool
    Indicates whether Value is case sensitive. The parameter has the following values: true: not case sensitive. false: case sensitive. The default value is false.
    ttl int
    Indicates the cache duration in seconds. The valid range is 0–315,360,000. 315,360,000 represents 10 years. If you do not want the content delivery network to cache the specified content, set this parameter to 0.
    action String
    Indicates caching behavior. Currently, you can only specify cache. cache means the behavior is caching.
    defaultPolicy String
    This parameter is shared by multiple CDN features.
    ignoreCase Boolean
    Indicates whether Value is case sensitive. The parameter has the following values: true: not case sensitive. false: case sensitive. The default value is false.
    ttl Number
    Indicates the cache duration in seconds. The valid range is 0–315,360,000. 315,360,000 represents 10 years. If you do not want the content delivery network to cache the specified content, set this parameter to 0.

    GetDomainBrowserCachCondition

    ConditionRules List<Byteplus.GetDomainBrowserCachConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainBrowserCachConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainBrowserCachConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainBrowserCachConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainBrowserCachConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainBrowserCachConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainCach

    CacheAction Byteplus.GetDomainCachCacheAction
    Indicates the relevant configuration for cache behavior.
    Condition Byteplus.GetDomainCachCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    CacheAction GetDomainCachCacheAction
    Indicates the relevant configuration for cache behavior.
    Condition GetDomainCachCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    cacheAction GetDomainCachCacheAction
    Indicates the relevant configuration for cache behavior.
    condition GetDomainCachCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    cacheAction GetDomainCachCacheAction
    Indicates the relevant configuration for cache behavior.
    condition GetDomainCachCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    cache_action GetDomainCachCacheAction
    Indicates the relevant configuration for cache behavior.
    condition GetDomainCachCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    cacheAction Property Map
    Indicates the relevant configuration for cache behavior.
    condition Property Map
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.

    GetDomainCachCacheAction

    Action string
    Indicates caching behavior. Currently, you can only specify cache. cache means the behavior is caching.
    DefaultPolicy string
    This parameter is shared by multiple CDN features.
    IgnoreCase bool
    Indicates whether Value is case sensitive. The parameter has the following values: true: not case sensitive. false: case sensitive. The default value is false.
    Ttl int
    Indicates the cache duration in seconds. The valid range is 0–315,360,000. 315,360,000 represents 10 years. If you do not want the content delivery network to cache the specified content, set this parameter to 0.
    Action string
    Indicates caching behavior. Currently, you can only specify cache. cache means the behavior is caching.
    DefaultPolicy string
    This parameter is shared by multiple CDN features.
    IgnoreCase bool
    Indicates whether Value is case sensitive. The parameter has the following values: true: not case sensitive. false: case sensitive. The default value is false.
    Ttl int
    Indicates the cache duration in seconds. The valid range is 0–315,360,000. 315,360,000 represents 10 years. If you do not want the content delivery network to cache the specified content, set this parameter to 0.
    action String
    Indicates caching behavior. Currently, you can only specify cache. cache means the behavior is caching.
    defaultPolicy String
    This parameter is shared by multiple CDN features.
    ignoreCase Boolean
    Indicates whether Value is case sensitive. The parameter has the following values: true: not case sensitive. false: case sensitive. The default value is false.
    ttl Integer
    Indicates the cache duration in seconds. The valid range is 0–315,360,000. 315,360,000 represents 10 years. If you do not want the content delivery network to cache the specified content, set this parameter to 0.
    action string
    Indicates caching behavior. Currently, you can only specify cache. cache means the behavior is caching.
    defaultPolicy string
    This parameter is shared by multiple CDN features.
    ignoreCase boolean
    Indicates whether Value is case sensitive. The parameter has the following values: true: not case sensitive. false: case sensitive. The default value is false.
    ttl number
    Indicates the cache duration in seconds. The valid range is 0–315,360,000. 315,360,000 represents 10 years. If you do not want the content delivery network to cache the specified content, set this parameter to 0.
    action str
    Indicates caching behavior. Currently, you can only specify cache. cache means the behavior is caching.
    default_policy str
    This parameter is shared by multiple CDN features.
    ignore_case bool
    Indicates whether Value is case sensitive. The parameter has the following values: true: not case sensitive. false: case sensitive. The default value is false.
    ttl int
    Indicates the cache duration in seconds. The valid range is 0–315,360,000. 315,360,000 represents 10 years. If you do not want the content delivery network to cache the specified content, set this parameter to 0.
    action String
    Indicates caching behavior. Currently, you can only specify cache. cache means the behavior is caching.
    defaultPolicy String
    This parameter is shared by multiple CDN features.
    ignoreCase Boolean
    Indicates whether Value is case sensitive. The parameter has the following values: true: not case sensitive. false: case sensitive. The default value is false.
    ttl Number
    Indicates the cache duration in seconds. The valid range is 0–315,360,000. 315,360,000 represents 10 years. If you do not want the content delivery network to cache the specified content, set this parameter to 0.

    GetDomainCachCondition

    ConditionRules List<Byteplus.GetDomainCachConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainCachConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainCachConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainCachConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainCachConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainCachConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainCacheHost

    CacheHostRules List<Byteplus.GetDomainCacheHostCacheHostRule>
    Indicates a set of shared cache HOST configurations. Currently, you can only create one configuration. When Switch is true, this parameter is required.
    Switch bool
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.
    CacheHostRules []GetDomainCacheHostCacheHostRule
    Indicates a set of shared cache HOST configurations. Currently, you can only create one configuration. When Switch is true, this parameter is required.
    Switch bool
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.
    cacheHostRules List<GetDomainCacheHostCacheHostRule>
    Indicates a set of shared cache HOST configurations. Currently, you can only create one configuration. When Switch is true, this parameter is required.
    switch_ Boolean
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.
    cacheHostRules GetDomainCacheHostCacheHostRule[]
    Indicates a set of shared cache HOST configurations. Currently, you can only create one configuration. When Switch is true, this parameter is required.
    switch boolean
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.
    cache_host_rules Sequence[GetDomainCacheHostCacheHostRule]
    Indicates a set of shared cache HOST configurations. Currently, you can only create one configuration. When Switch is true, this parameter is required.
    switch bool
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.
    cacheHostRules List<Property Map>
    Indicates a set of shared cache HOST configurations. Currently, you can only create one configuration. When Switch is true, this parameter is required.
    switch Boolean
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.

    GetDomainCacheHostCacheHostRule

    CacheHostAction Byteplus.GetDomainCacheHostCacheHostRuleCacheHostAction
    Indicates the target domain. The target domain must be an accelerated domain under your account. This parameter specifies that the Domain shares the cache of CacheHost.
    Condition Byteplus.GetDomainCacheHostCacheHostRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    CacheHostAction GetDomainCacheHostCacheHostRuleCacheHostAction
    Indicates the target domain. The target domain must be an accelerated domain under your account. This parameter specifies that the Domain shares the cache of CacheHost.
    Condition GetDomainCacheHostCacheHostRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    cacheHostAction GetDomainCacheHostCacheHostRuleCacheHostAction
    Indicates the target domain. The target domain must be an accelerated domain under your account. This parameter specifies that the Domain shares the cache of CacheHost.
    condition GetDomainCacheHostCacheHostRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    cacheHostAction GetDomainCacheHostCacheHostRuleCacheHostAction
    Indicates the target domain. The target domain must be an accelerated domain under your account. This parameter specifies that the Domain shares the cache of CacheHost.
    condition GetDomainCacheHostCacheHostRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    cache_host_action GetDomainCacheHostCacheHostRuleCacheHostAction
    Indicates the target domain. The target domain must be an accelerated domain under your account. This parameter specifies that the Domain shares the cache of CacheHost.
    condition GetDomainCacheHostCacheHostRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    cacheHostAction Property Map
    Indicates the target domain. The target domain must be an accelerated domain under your account. This parameter specifies that the Domain shares the cache of CacheHost.
    condition Property Map
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.

    GetDomainCacheHostCacheHostRuleCacheHostAction

    CacheHost string
    Specifies the target domain name. The target domain name must be an acceleration domain under your account. This parameter indicates that Domain shares the cache of CacheHost.
    CacheHost string
    Specifies the target domain name. The target domain name must be an acceleration domain under your account. This parameter indicates that Domain shares the cache of CacheHost.
    cacheHost String
    Specifies the target domain name. The target domain name must be an acceleration domain under your account. This parameter indicates that Domain shares the cache of CacheHost.
    cacheHost string
    Specifies the target domain name. The target domain name must be an acceleration domain under your account. This parameter indicates that Domain shares the cache of CacheHost.
    cache_host str
    Specifies the target domain name. The target domain name must be an acceleration domain under your account. This parameter indicates that Domain shares the cache of CacheHost.
    cacheHost String
    Specifies the target domain name. The target domain name must be an acceleration domain under your account. This parameter indicates that Domain shares the cache of CacheHost.

    GetDomainCacheHostCacheHostRuleCondition

    ConditionRules List<Byteplus.GetDomainCacheHostCacheHostRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainCacheHostCacheHostRuleConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainCacheHostCacheHostRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainCacheHostCacheHostRuleConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainCacheHostCacheHostRuleConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainCacheHostCacheHostRuleConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainCacheKey

    CacheKeyAction Byteplus.GetDomainCacheKeyCacheKeyAction
    Indicates the action performed by the content delivery network under the Condition scenario.
    Condition Byteplus.GetDomainCacheKeyCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    CacheKeyAction GetDomainCacheKeyCacheKeyAction
    Indicates the action performed by the content delivery network under the Condition scenario.
    Condition GetDomainCacheKeyCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    cacheKeyAction GetDomainCacheKeyCacheKeyAction
    Indicates the action performed by the content delivery network under the Condition scenario.
    condition GetDomainCacheKeyCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    cacheKeyAction GetDomainCacheKeyCacheKeyAction
    Indicates the action performed by the content delivery network under the Condition scenario.
    condition GetDomainCacheKeyCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    cache_key_action GetDomainCacheKeyCacheKeyAction
    Indicates the action performed by the content delivery network under the Condition scenario.
    condition GetDomainCacheKeyCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    cacheKeyAction Property Map
    Indicates the action performed by the content delivery network under the Condition scenario.
    condition Property Map
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.

    GetDomainCacheKeyCacheKeyAction

    CacheKeyComponents List<Byteplus.GetDomainCacheKeyCacheKeyActionCacheKeyComponent>
    Indicates a list of operation configurations. Currently, you can only set one operation configuration.
    CacheKeyComponents []GetDomainCacheKeyCacheKeyActionCacheKeyComponent
    Indicates a list of operation configurations. Currently, you can only set one operation configuration.
    cacheKeyComponents List<GetDomainCacheKeyCacheKeyActionCacheKeyComponent>
    Indicates a list of operation configurations. Currently, you can only set one operation configuration.
    cacheKeyComponents GetDomainCacheKeyCacheKeyActionCacheKeyComponent[]
    Indicates a list of operation configurations. Currently, you can only set one operation configuration.
    cache_key_components Sequence[GetDomainCacheKeyCacheKeyActionCacheKeyComponent]
    Indicates a list of operation configurations. Currently, you can only set one operation configuration.
    cacheKeyComponents List<Property Map>
    Indicates a list of operation configurations. Currently, you can only set one operation configuration.

    GetDomainCacheKeyCacheKeyActionCacheKeyComponent

    Action string
    Specifies the action to perform; required when modifying. This parameter has the following values: exclude: The cache key does not include any query parameters, which means parameters are removed from the cache. include: The cache key includes all query parameters, which means parameters are retained in the cache. includePart: The cache key includes query parameters in Subobject, which means some parameters are retained in the cache. excludePart: The cache key does not include query parameters in Subobject, which means some parameters are removed from the cache.
    IgnoreCase bool
    Indicates whether the content delivery network ignores case when matching Value. The parameter values are: true: ignore case. false: do not ignore case. The default value is false.
    Object string
    Indicates the object to be set. Currently, you can only specify queryString. queryString refers to the query parameters in the request URL.
    Subobject string
    Specify one or more objects of the Object type. Parameter details: If Action is include or exclude, Subobject must be *. * means all query parameters. If Action is includePart or excludePart, you can specify one or more query parameters. The query parameters you specify cannot be *, and cannot contain consecutive slashes (//), percent signs (%), or spaces. Use a semicolon (;) to separate multiple query parameter names. The default value for Subobject is *.
    Action string
    Specifies the action to perform; required when modifying. This parameter has the following values: exclude: The cache key does not include any query parameters, which means parameters are removed from the cache. include: The cache key includes all query parameters, which means parameters are retained in the cache. includePart: The cache key includes query parameters in Subobject, which means some parameters are retained in the cache. excludePart: The cache key does not include query parameters in Subobject, which means some parameters are removed from the cache.
    IgnoreCase bool
    Indicates whether the content delivery network ignores case when matching Value. The parameter values are: true: ignore case. false: do not ignore case. The default value is false.
    Object string
    Indicates the object to be set. Currently, you can only specify queryString. queryString refers to the query parameters in the request URL.
    Subobject string
    Specify one or more objects of the Object type. Parameter details: If Action is include or exclude, Subobject must be *. * means all query parameters. If Action is includePart or excludePart, you can specify one or more query parameters. The query parameters you specify cannot be *, and cannot contain consecutive slashes (//), percent signs (%), or spaces. Use a semicolon (;) to separate multiple query parameter names. The default value for Subobject is *.
    action String
    Specifies the action to perform; required when modifying. This parameter has the following values: exclude: The cache key does not include any query parameters, which means parameters are removed from the cache. include: The cache key includes all query parameters, which means parameters are retained in the cache. includePart: The cache key includes query parameters in Subobject, which means some parameters are retained in the cache. excludePart: The cache key does not include query parameters in Subobject, which means some parameters are removed from the cache.
    ignoreCase Boolean
    Indicates whether the content delivery network ignores case when matching Value. The parameter values are: true: ignore case. false: do not ignore case. The default value is false.
    object String
    Indicates the object to be set. Currently, you can only specify queryString. queryString refers to the query parameters in the request URL.
    subobject String
    Specify one or more objects of the Object type. Parameter details: If Action is include or exclude, Subobject must be *. * means all query parameters. If Action is includePart or excludePart, you can specify one or more query parameters. The query parameters you specify cannot be *, and cannot contain consecutive slashes (//), percent signs (%), or spaces. Use a semicolon (;) to separate multiple query parameter names. The default value for Subobject is *.
    action string
    Specifies the action to perform; required when modifying. This parameter has the following values: exclude: The cache key does not include any query parameters, which means parameters are removed from the cache. include: The cache key includes all query parameters, which means parameters are retained in the cache. includePart: The cache key includes query parameters in Subobject, which means some parameters are retained in the cache. excludePart: The cache key does not include query parameters in Subobject, which means some parameters are removed from the cache.
    ignoreCase boolean
    Indicates whether the content delivery network ignores case when matching Value. The parameter values are: true: ignore case. false: do not ignore case. The default value is false.
    object string
    Indicates the object to be set. Currently, you can only specify queryString. queryString refers to the query parameters in the request URL.
    subobject string
    Specify one or more objects of the Object type. Parameter details: If Action is include or exclude, Subobject must be *. * means all query parameters. If Action is includePart or excludePart, you can specify one or more query parameters. The query parameters you specify cannot be *, and cannot contain consecutive slashes (//), percent signs (%), or spaces. Use a semicolon (;) to separate multiple query parameter names. The default value for Subobject is *.
    action str
    Specifies the action to perform; required when modifying. This parameter has the following values: exclude: The cache key does not include any query parameters, which means parameters are removed from the cache. include: The cache key includes all query parameters, which means parameters are retained in the cache. includePart: The cache key includes query parameters in Subobject, which means some parameters are retained in the cache. excludePart: The cache key does not include query parameters in Subobject, which means some parameters are removed from the cache.
    ignore_case bool
    Indicates whether the content delivery network ignores case when matching Value. The parameter values are: true: ignore case. false: do not ignore case. The default value is false.
    object str
    Indicates the object to be set. Currently, you can only specify queryString. queryString refers to the query parameters in the request URL.
    subobject str
    Specify one or more objects of the Object type. Parameter details: If Action is include or exclude, Subobject must be *. * means all query parameters. If Action is includePart or excludePart, you can specify one or more query parameters. The query parameters you specify cannot be *, and cannot contain consecutive slashes (//), percent signs (%), or spaces. Use a semicolon (;) to separate multiple query parameter names. The default value for Subobject is *.
    action String
    Specifies the action to perform; required when modifying. This parameter has the following values: exclude: The cache key does not include any query parameters, which means parameters are removed from the cache. include: The cache key includes all query parameters, which means parameters are retained in the cache. includePart: The cache key includes query parameters in Subobject, which means some parameters are retained in the cache. excludePart: The cache key does not include query parameters in Subobject, which means some parameters are removed from the cache.
    ignoreCase Boolean
    Indicates whether the content delivery network ignores case when matching Value. The parameter values are: true: ignore case. false: do not ignore case. The default value is false.
    object String
    Indicates the object to be set. Currently, you can only specify queryString. queryString refers to the query parameters in the request URL.
    subobject String
    Specify one or more objects of the Object type. Parameter details: If Action is include or exclude, Subobject must be *. * means all query parameters. If Action is includePart or excludePart, you can specify one or more query parameters. The query parameters you specify cannot be *, and cannot contain consecutive slashes (//), percent signs (%), or spaces. Use a semicolon (;) to separate multiple query parameter names. The default value for Subobject is *.

    GetDomainCacheKeyCondition

    ConditionRules List<Byteplus.GetDomainCacheKeyConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainCacheKeyConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainCacheKeyConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainCacheKeyConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainCacheKeyConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainCacheKeyConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainCompression

    CompressionRules List<Byteplus.GetDomainCompressionCompressionRule>
    Indicates a set of smart compression configuration rules. This parameter is required when Switch is true.
    Switch bool
    Smart compression configuration switch. This parameter has the following values: true: enables smart compression. false: disables smart compression.
    CompressionRules []GetDomainCompressionCompressionRule
    Indicates a set of smart compression configuration rules. This parameter is required when Switch is true.
    Switch bool
    Smart compression configuration switch. This parameter has the following values: true: enables smart compression. false: disables smart compression.
    compressionRules List<GetDomainCompressionCompressionRule>
    Indicates a set of smart compression configuration rules. This parameter is required when Switch is true.
    switch_ Boolean
    Smart compression configuration switch. This parameter has the following values: true: enables smart compression. false: disables smart compression.
    compressionRules GetDomainCompressionCompressionRule[]
    Indicates a set of smart compression configuration rules. This parameter is required when Switch is true.
    switch boolean
    Smart compression configuration switch. This parameter has the following values: true: enables smart compression. false: disables smart compression.
    compression_rules Sequence[GetDomainCompressionCompressionRule]
    Indicates a set of smart compression configuration rules. This parameter is required when Switch is true.
    switch bool
    Smart compression configuration switch. This parameter has the following values: true: enables smart compression. false: disables smart compression.
    compressionRules List<Property Map>
    Indicates a set of smart compression configuration rules. This parameter is required when Switch is true.
    switch Boolean
    Smart compression configuration switch. This parameter has the following values: true: enables smart compression. false: disables smart compression.

    GetDomainCompressionCompressionRule

    CompressionAction Byteplus.GetDomainCompressionCompressionRuleCompressionAction
    Represents the configuration for compression operations.
    Condition Byteplus.GetDomainCompressionCompressionRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    CompressionAction GetDomainCompressionCompressionRuleCompressionAction
    Represents the configuration for compression operations.
    Condition GetDomainCompressionCompressionRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    compressionAction GetDomainCompressionCompressionRuleCompressionAction
    Represents the configuration for compression operations.
    condition GetDomainCompressionCompressionRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    compressionAction GetDomainCompressionCompressionRuleCompressionAction
    Represents the configuration for compression operations.
    condition GetDomainCompressionCompressionRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    compression_action GetDomainCompressionCompressionRuleCompressionAction
    Represents the configuration for compression operations.
    condition GetDomainCompressionCompressionRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    compressionAction Property Map
    Represents the configuration for compression operations.
    condition Property Map
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.

    GetDomainCompressionCompressionRuleCompressionAction

    CompressionFormat string
    If the matching condition is based on the Content-Type header (when Condition is null or not specified), this parameter specifies the matching criteria for Content-Type. The values are as follows: default: matches file types included in the default Content-Type list. customize: matches custom file types in the Content-Type header. If Condition is not null, the matching criteria are defined in ConditionRule. In this case, this parameter must be set to all.
    CompressionTarget string
    Specifies the file types to compress. The parameter is described as follows: If CompressionFormat is default, this parameter must be set to *, indicating the default Content-Type list. The list includes the following file types: text/html, text/xml, text/plain, text/css, application/javascript, application/x-javascript, application/rss+xml, text/javascript, image/tiff, image/svg+xml, application/json, application/xml, text/plain; charset=utf-8. If CompressionFormat is customize, you need to specify one or more file types. Multiple file types are separated by commas (,). If CompressionFormat is all, this parameter must be set to *.
    CompressionTypes List<string>
    Compression algorithm: gzip and br specify the compression type. default: compresses all files by default, with the target count as *. customize: compresses custom file types. Choices: [default, customize]
    MaxFileSizeKb int
    Indicates the minimum value for the file size range. CDN only compresses files within the range specified by MinFileSizeKB and MaxFileSizeKB. The parameter value range is 0 - 2,147,483,647, the unit is KB, and the base is 1,024. The default value is 0.
    MinFileSizeKb int
    Indicates the maximum value for the file size range. The value range is 0 - 2,147,483,647, in KB, using a base of 1,024. If this parameter is not specified, there is no upper limit for file size.
    CompressionFormat string
    If the matching condition is based on the Content-Type header (when Condition is null or not specified), this parameter specifies the matching criteria for Content-Type. The values are as follows: default: matches file types included in the default Content-Type list. customize: matches custom file types in the Content-Type header. If Condition is not null, the matching criteria are defined in ConditionRule. In this case, this parameter must be set to all.
    CompressionTarget string
    Specifies the file types to compress. The parameter is described as follows: If CompressionFormat is default, this parameter must be set to *, indicating the default Content-Type list. The list includes the following file types: text/html, text/xml, text/plain, text/css, application/javascript, application/x-javascript, application/rss+xml, text/javascript, image/tiff, image/svg+xml, application/json, application/xml, text/plain; charset=utf-8. If CompressionFormat is customize, you need to specify one or more file types. Multiple file types are separated by commas (,). If CompressionFormat is all, this parameter must be set to *.
    CompressionTypes []string
    Compression algorithm: gzip and br specify the compression type. default: compresses all files by default, with the target count as *. customize: compresses custom file types. Choices: [default, customize]
    MaxFileSizeKb int
    Indicates the minimum value for the file size range. CDN only compresses files within the range specified by MinFileSizeKB and MaxFileSizeKB. The parameter value range is 0 - 2,147,483,647, the unit is KB, and the base is 1,024. The default value is 0.
    MinFileSizeKb int
    Indicates the maximum value for the file size range. The value range is 0 - 2,147,483,647, in KB, using a base of 1,024. If this parameter is not specified, there is no upper limit for file size.
    compressionFormat String
    If the matching condition is based on the Content-Type header (when Condition is null or not specified), this parameter specifies the matching criteria for Content-Type. The values are as follows: default: matches file types included in the default Content-Type list. customize: matches custom file types in the Content-Type header. If Condition is not null, the matching criteria are defined in ConditionRule. In this case, this parameter must be set to all.
    compressionTarget String
    Specifies the file types to compress. The parameter is described as follows: If CompressionFormat is default, this parameter must be set to *, indicating the default Content-Type list. The list includes the following file types: text/html, text/xml, text/plain, text/css, application/javascript, application/x-javascript, application/rss+xml, text/javascript, image/tiff, image/svg+xml, application/json, application/xml, text/plain; charset=utf-8. If CompressionFormat is customize, you need to specify one or more file types. Multiple file types are separated by commas (,). If CompressionFormat is all, this parameter must be set to *.
    compressionTypes List<String>
    Compression algorithm: gzip and br specify the compression type. default: compresses all files by default, with the target count as *. customize: compresses custom file types. Choices: [default, customize]
    maxFileSizeKb Integer
    Indicates the minimum value for the file size range. CDN only compresses files within the range specified by MinFileSizeKB and MaxFileSizeKB. The parameter value range is 0 - 2,147,483,647, the unit is KB, and the base is 1,024. The default value is 0.
    minFileSizeKb Integer
    Indicates the maximum value for the file size range. The value range is 0 - 2,147,483,647, in KB, using a base of 1,024. If this parameter is not specified, there is no upper limit for file size.
    compressionFormat string
    If the matching condition is based on the Content-Type header (when Condition is null or not specified), this parameter specifies the matching criteria for Content-Type. The values are as follows: default: matches file types included in the default Content-Type list. customize: matches custom file types in the Content-Type header. If Condition is not null, the matching criteria are defined in ConditionRule. In this case, this parameter must be set to all.
    compressionTarget string
    Specifies the file types to compress. The parameter is described as follows: If CompressionFormat is default, this parameter must be set to *, indicating the default Content-Type list. The list includes the following file types: text/html, text/xml, text/plain, text/css, application/javascript, application/x-javascript, application/rss+xml, text/javascript, image/tiff, image/svg+xml, application/json, application/xml, text/plain; charset=utf-8. If CompressionFormat is customize, you need to specify one or more file types. Multiple file types are separated by commas (,). If CompressionFormat is all, this parameter must be set to *.
    compressionTypes string[]
    Compression algorithm: gzip and br specify the compression type. default: compresses all files by default, with the target count as *. customize: compresses custom file types. Choices: [default, customize]
    maxFileSizeKb number
    Indicates the minimum value for the file size range. CDN only compresses files within the range specified by MinFileSizeKB and MaxFileSizeKB. The parameter value range is 0 - 2,147,483,647, the unit is KB, and the base is 1,024. The default value is 0.
    minFileSizeKb number
    Indicates the maximum value for the file size range. The value range is 0 - 2,147,483,647, in KB, using a base of 1,024. If this parameter is not specified, there is no upper limit for file size.
    compression_format str
    If the matching condition is based on the Content-Type header (when Condition is null or not specified), this parameter specifies the matching criteria for Content-Type. The values are as follows: default: matches file types included in the default Content-Type list. customize: matches custom file types in the Content-Type header. If Condition is not null, the matching criteria are defined in ConditionRule. In this case, this parameter must be set to all.
    compression_target str
    Specifies the file types to compress. The parameter is described as follows: If CompressionFormat is default, this parameter must be set to *, indicating the default Content-Type list. The list includes the following file types: text/html, text/xml, text/plain, text/css, application/javascript, application/x-javascript, application/rss+xml, text/javascript, image/tiff, image/svg+xml, application/json, application/xml, text/plain; charset=utf-8. If CompressionFormat is customize, you need to specify one or more file types. Multiple file types are separated by commas (,). If CompressionFormat is all, this parameter must be set to *.
    compression_types Sequence[str]
    Compression algorithm: gzip and br specify the compression type. default: compresses all files by default, with the target count as *. customize: compresses custom file types. Choices: [default, customize]
    max_file_size_kb int
    Indicates the minimum value for the file size range. CDN only compresses files within the range specified by MinFileSizeKB and MaxFileSizeKB. The parameter value range is 0 - 2,147,483,647, the unit is KB, and the base is 1,024. The default value is 0.
    min_file_size_kb int
    Indicates the maximum value for the file size range. The value range is 0 - 2,147,483,647, in KB, using a base of 1,024. If this parameter is not specified, there is no upper limit for file size.
    compressionFormat String
    If the matching condition is based on the Content-Type header (when Condition is null or not specified), this parameter specifies the matching criteria for Content-Type. The values are as follows: default: matches file types included in the default Content-Type list. customize: matches custom file types in the Content-Type header. If Condition is not null, the matching criteria are defined in ConditionRule. In this case, this parameter must be set to all.
    compressionTarget String
    Specifies the file types to compress. The parameter is described as follows: If CompressionFormat is default, this parameter must be set to *, indicating the default Content-Type list. The list includes the following file types: text/html, text/xml, text/plain, text/css, application/javascript, application/x-javascript, application/rss+xml, text/javascript, image/tiff, image/svg+xml, application/json, application/xml, text/plain; charset=utf-8. If CompressionFormat is customize, you need to specify one or more file types. Multiple file types are separated by commas (,). If CompressionFormat is all, this parameter must be set to *.
    compressionTypes List<String>
    Compression algorithm: gzip and br specify the compression type. default: compresses all files by default, with the target count as *. customize: compresses custom file types. Choices: [default, customize]
    maxFileSizeKb Number
    Indicates the minimum value for the file size range. CDN only compresses files within the range specified by MinFileSizeKB and MaxFileSizeKB. The parameter value range is 0 - 2,147,483,647, the unit is KB, and the base is 1,024. The default value is 0.
    minFileSizeKb Number
    Indicates the maximum value for the file size range. The value range is 0 - 2,147,483,647, in KB, using a base of 1,024. If this parameter is not specified, there is no upper limit for file size.

    GetDomainCompressionCompressionRuleCondition

    ConditionRules List<Byteplus.GetDomainCompressionCompressionRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainCompressionCompressionRuleConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainCompressionCompressionRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainCompressionCompressionRuleConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainCompressionCompressionRuleConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainCompressionCompressionRuleConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainConditionalOrigin

    OriginRules List<Byteplus.GetDomainConditionalOriginOriginRule>
    Indicates a list of rules. Each rule in the list defines a filter and the action the content delivery network performs on requests that meet the filter criteria.
    Switch bool
    Indicates whether this feature is enabled. The parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.
    OriginRules []GetDomainConditionalOriginOriginRule
    Indicates a list of rules. Each rule in the list defines a filter and the action the content delivery network performs on requests that meet the filter criteria.
    Switch bool
    Indicates whether this feature is enabled. The parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.
    originRules List<GetDomainConditionalOriginOriginRule>
    Indicates a list of rules. Each rule in the list defines a filter and the action the content delivery network performs on requests that meet the filter criteria.
    switch_ Boolean
    Indicates whether this feature is enabled. The parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.
    originRules GetDomainConditionalOriginOriginRule[]
    Indicates a list of rules. Each rule in the list defines a filter and the action the content delivery network performs on requests that meet the filter criteria.
    switch boolean
    Indicates whether this feature is enabled. The parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.
    origin_rules Sequence[GetDomainConditionalOriginOriginRule]
    Indicates a list of rules. Each rule in the list defines a filter and the action the content delivery network performs on requests that meet the filter criteria.
    switch bool
    Indicates whether this feature is enabled. The parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.
    originRules List<Property Map>
    Indicates a list of rules. Each rule in the list defines a filter and the action the content delivery network performs on requests that meet the filter criteria.
    switch Boolean
    Indicates whether this feature is enabled. The parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.

    GetDomainConditionalOriginOriginRule

    Actions Byteplus.GetDomainConditionalOriginOriginRuleActions
    Indicates the operation configuration for a rule in the list.
    Condition Byteplus.GetDomainConditionalOriginOriginRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    Actions GetDomainConditionalOriginOriginRuleActions
    Indicates the operation configuration for a rule in the list.
    Condition GetDomainConditionalOriginOriginRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    actions GetDomainConditionalOriginOriginRuleActions
    Indicates the operation configuration for a rule in the list.
    condition GetDomainConditionalOriginOriginRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    actions GetDomainConditionalOriginOriginRuleActions
    Indicates the operation configuration for a rule in the list.
    condition GetDomainConditionalOriginOriginRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    actions GetDomainConditionalOriginOriginRuleActions
    Indicates the operation configuration for a rule in the list.
    condition GetDomainConditionalOriginOriginRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    actions Property Map
    Indicates the operation configuration for a rule in the list.
    condition Property Map
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.

    GetDomainConditionalOriginOriginRuleActions

    OriginLines List<Byteplus.GetDomainConditionalOriginOriginRuleActionsOriginLine>
    Indicates a list of origin configurations. Currently, the list can contain only one origin configuration.
    OriginLines []GetDomainConditionalOriginOriginRuleActionsOriginLine
    Indicates a list of origin configurations. Currently, the list can contain only one origin configuration.
    originLines List<GetDomainConditionalOriginOriginRuleActionsOriginLine>
    Indicates a list of origin configurations. Currently, the list can contain only one origin configuration.
    originLines GetDomainConditionalOriginOriginRuleActionsOriginLine[]
    Indicates a list of origin configurations. Currently, the list can contain only one origin configuration.
    origin_lines Sequence[GetDomainConditionalOriginOriginRuleActionsOriginLine]
    Indicates a list of origin configurations. Currently, the list can contain only one origin configuration.
    originLines List<Property Map>
    Indicates a list of origin configurations. Currently, the list can contain only one origin configuration.

    GetDomainConditionalOriginOriginRuleActionsOriginLine

    Address string
    Represents the address of an origin server. When InstanceType is ip, Address specifies an IPv4 or IPv6 address. When InstanceType is domain, Address specifies a domain name. The domain name cannot be a wildcard domain. If you specify OriginLines, Address is required.
    HttpPort string
    Indicates the port used by the content delivery network to access the origin server via the HTTP protocol. The valid range is 1–65535, with a default value of 80. If the origin server does not have this port open, you do not need to specify this parameter.
    HttpsPort string
    Specifies the port used by the content delivery network to access the origin server via HTTPS. The value range is 1–65535, and the default is 443. If the origin server does not open this port, you do not need to specify this parameter.
    InstanceType string
    Indicates the type of origin. The parameter has the following values: ip: indicates an IP address. domain: indicates a domain name. InstanceType is required if OriginLines is specified.
    OriginHost string
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter takes precedence over the global OriginHost parameter. The value of this parameter cannot exceed 1,024 characters. The default value is the same as the global OriginHost.
    Address string
    Represents the address of an origin server. When InstanceType is ip, Address specifies an IPv4 or IPv6 address. When InstanceType is domain, Address specifies a domain name. The domain name cannot be a wildcard domain. If you specify OriginLines, Address is required.
    HttpPort string
    Indicates the port used by the content delivery network to access the origin server via the HTTP protocol. The valid range is 1–65535, with a default value of 80. If the origin server does not have this port open, you do not need to specify this parameter.
    HttpsPort string
    Specifies the port used by the content delivery network to access the origin server via HTTPS. The value range is 1–65535, and the default is 443. If the origin server does not open this port, you do not need to specify this parameter.
    InstanceType string
    Indicates the type of origin. The parameter has the following values: ip: indicates an IP address. domain: indicates a domain name. InstanceType is required if OriginLines is specified.
    OriginHost string
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter takes precedence over the global OriginHost parameter. The value of this parameter cannot exceed 1,024 characters. The default value is the same as the global OriginHost.
    address String
    Represents the address of an origin server. When InstanceType is ip, Address specifies an IPv4 or IPv6 address. When InstanceType is domain, Address specifies a domain name. The domain name cannot be a wildcard domain. If you specify OriginLines, Address is required.
    httpPort String
    Indicates the port used by the content delivery network to access the origin server via the HTTP protocol. The valid range is 1–65535, with a default value of 80. If the origin server does not have this port open, you do not need to specify this parameter.
    httpsPort String
    Specifies the port used by the content delivery network to access the origin server via HTTPS. The value range is 1–65535, and the default is 443. If the origin server does not open this port, you do not need to specify this parameter.
    instanceType String
    Indicates the type of origin. The parameter has the following values: ip: indicates an IP address. domain: indicates a domain name. InstanceType is required if OriginLines is specified.
    originHost String
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter takes precedence over the global OriginHost parameter. The value of this parameter cannot exceed 1,024 characters. The default value is the same as the global OriginHost.
    address string
    Represents the address of an origin server. When InstanceType is ip, Address specifies an IPv4 or IPv6 address. When InstanceType is domain, Address specifies a domain name. The domain name cannot be a wildcard domain. If you specify OriginLines, Address is required.
    httpPort string
    Indicates the port used by the content delivery network to access the origin server via the HTTP protocol. The valid range is 1–65535, with a default value of 80. If the origin server does not have this port open, you do not need to specify this parameter.
    httpsPort string
    Specifies the port used by the content delivery network to access the origin server via HTTPS. The value range is 1–65535, and the default is 443. If the origin server does not open this port, you do not need to specify this parameter.
    instanceType string
    Indicates the type of origin. The parameter has the following values: ip: indicates an IP address. domain: indicates a domain name. InstanceType is required if OriginLines is specified.
    originHost string
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter takes precedence over the global OriginHost parameter. The value of this parameter cannot exceed 1,024 characters. The default value is the same as the global OriginHost.
    address str
    Represents the address of an origin server. When InstanceType is ip, Address specifies an IPv4 or IPv6 address. When InstanceType is domain, Address specifies a domain name. The domain name cannot be a wildcard domain. If you specify OriginLines, Address is required.
    http_port str
    Indicates the port used by the content delivery network to access the origin server via the HTTP protocol. The valid range is 1–65535, with a default value of 80. If the origin server does not have this port open, you do not need to specify this parameter.
    https_port str
    Specifies the port used by the content delivery network to access the origin server via HTTPS. The value range is 1–65535, and the default is 443. If the origin server does not open this port, you do not need to specify this parameter.
    instance_type str
    Indicates the type of origin. The parameter has the following values: ip: indicates an IP address. domain: indicates a domain name. InstanceType is required if OriginLines is specified.
    origin_host str
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter takes precedence over the global OriginHost parameter. The value of this parameter cannot exceed 1,024 characters. The default value is the same as the global OriginHost.
    address String
    Represents the address of an origin server. When InstanceType is ip, Address specifies an IPv4 or IPv6 address. When InstanceType is domain, Address specifies a domain name. The domain name cannot be a wildcard domain. If you specify OriginLines, Address is required.
    httpPort String
    Indicates the port used by the content delivery network to access the origin server via the HTTP protocol. The valid range is 1–65535, with a default value of 80. If the origin server does not have this port open, you do not need to specify this parameter.
    httpsPort String
    Specifies the port used by the content delivery network to access the origin server via HTTPS. The value range is 1–65535, and the default is 443. If the origin server does not open this port, you do not need to specify this parameter.
    instanceType String
    Indicates the type of origin. The parameter has the following values: ip: indicates an IP address. domain: indicates a domain name. InstanceType is required if OriginLines is specified.
    originHost String
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter takes precedence over the global OriginHost parameter. The value of this parameter cannot exceed 1,024 characters. The default value is the same as the global OriginHost.

    GetDomainConditionalOriginOriginRuleCondition

    ConditionGroups List<Byteplus.GetDomainConditionalOriginOriginRuleConditionConditionGroup>
    ConditionGroups
    Connective string
    Specifies the relationship between these condition groups. This parameter has the following values: or: Indicates an 'or' relationship. In this case, if any condition group is met, the user request matches the rule. and: Indicates an 'and' relationship. In this case, all condition groups must be met for the user request to match the rule. The default value is or.
    IsGroup bool
    Indicates whether each filter condition is a condition group. The value of this parameter is always true, meaning each filter condition is a condition group. Currently, each condition group can only contain one filter condition.
    ConditionGroups []GetDomainConditionalOriginOriginRuleConditionConditionGroup
    ConditionGroups
    Connective string
    Specifies the relationship between these condition groups. This parameter has the following values: or: Indicates an 'or' relationship. In this case, if any condition group is met, the user request matches the rule. and: Indicates an 'and' relationship. In this case, all condition groups must be met for the user request to match the rule. The default value is or.
    IsGroup bool
    Indicates whether each filter condition is a condition group. The value of this parameter is always true, meaning each filter condition is a condition group. Currently, each condition group can only contain one filter condition.
    conditionGroups List<GetDomainConditionalOriginOriginRuleConditionConditionGroup>
    ConditionGroups
    connective String
    Specifies the relationship between these condition groups. This parameter has the following values: or: Indicates an 'or' relationship. In this case, if any condition group is met, the user request matches the rule. and: Indicates an 'and' relationship. In this case, all condition groups must be met for the user request to match the rule. The default value is or.
    isGroup Boolean
    Indicates whether each filter condition is a condition group. The value of this parameter is always true, meaning each filter condition is a condition group. Currently, each condition group can only contain one filter condition.
    conditionGroups GetDomainConditionalOriginOriginRuleConditionConditionGroup[]
    ConditionGroups
    connective string
    Specifies the relationship between these condition groups. This parameter has the following values: or: Indicates an 'or' relationship. In this case, if any condition group is met, the user request matches the rule. and: Indicates an 'and' relationship. In this case, all condition groups must be met for the user request to match the rule. The default value is or.
    isGroup boolean
    Indicates whether each filter condition is a condition group. The value of this parameter is always true, meaning each filter condition is a condition group. Currently, each condition group can only contain one filter condition.
    condition_groups Sequence[GetDomainConditionalOriginOriginRuleConditionConditionGroup]
    ConditionGroups
    connective str
    Specifies the relationship between these condition groups. This parameter has the following values: or: Indicates an 'or' relationship. In this case, if any condition group is met, the user request matches the rule. and: Indicates an 'and' relationship. In this case, all condition groups must be met for the user request to match the rule. The default value is or.
    is_group bool
    Indicates whether each filter condition is a condition group. The value of this parameter is always true, meaning each filter condition is a condition group. Currently, each condition group can only contain one filter condition.
    conditionGroups List<Property Map>
    ConditionGroups
    connective String
    Specifies the relationship between these condition groups. This parameter has the following values: or: Indicates an 'or' relationship. In this case, if any condition group is met, the user request matches the rule. and: Indicates an 'and' relationship. In this case, all condition groups must be met for the user request to match the rule. The default value is or.
    isGroup Boolean
    Indicates whether each filter condition is a condition group. The value of this parameter is always true, meaning each filter condition is a condition group. Currently, each condition group can only contain one filter condition.

    GetDomainConditionalOriginOriginRuleConditionConditionGroup

    Condition Byteplus.GetDomainConditionalOriginOriginRuleConditionConditionGroupCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    Condition GetDomainConditionalOriginOriginRuleConditionConditionGroupCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    condition GetDomainConditionalOriginOriginRuleConditionConditionGroupCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    condition GetDomainConditionalOriginOriginRuleConditionConditionGroupCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    condition GetDomainConditionalOriginOriginRuleConditionConditionGroupCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    condition Property Map
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.

    GetDomainConditionalOriginOriginRuleConditionConditionGroupCondition

    Object string
    Indicates a filter type. This parameter has the following values: path: The full path in the request URL. directory: Any directory in the path. For example, if the path is /a/b/c/d/file, then /a/, /b/c/, and /d/ are directories. filetype: The extension at the end of the path. fullquerystring: The query string in the request URL. clientip: The client's IP address or the location associated with the IP address. If you specify Condition, Object is required.
    Operator string
    Specifies a comparison type. Different Objects correspond to different values. When Object is path, directory, or filetype, the parameter values are equal and notequal. When Object is path, additional values are regexmatch and regexnotmatch. When Object is fullquerystring, the values are regexmatch and regexnotmatch. When Object is clientip, the values are equal, notequal, belong, and notbelong. The comparison types are explained as follows: equal: If Object matches any filter value in Value, the request meets this filter condition. notequal: If Object does not match any filter value in Value, the request meets this filter condition. regexmatch: If any regular expression in Value matches any part of Object, the request meets this filter condition. regexnotmatch: If none of the regular expressions in Value match any part of Object, the request meets this filter condition. belong: If the client IP address belongs to any country or region listed in Value, the request meets this filter condition. notbelong: If the client IP address does not belong to any country or region listed in Value, the request meets this filter condition. If you specify Condition, Operator is required.
    Values List<string>
    Represents one or more filter values. Filter values are separated by semicolons (;). The input requirements for this parameter are as follows: When Object is path, directory, or filetype, the total length of all filter values must not exceed 1,024 characters and must not contain the following characters: consecutive slashes (//), spaces, dollar sign ($), question mark (?), or Delete (ASCII code 127). When Object is path, this parameter has the following additional requirements: each filter value must start with a slash (/) but must not end with a slash (/). You can use one or more asterisks () in the filter value, where each asterisk represents one or more characters. For example: /www/img/myimage.png. When Object is directory, this parameter has the following additional requirements: each filter value must start and end with a slash (/). For example: /www/img/. When Object is filetype, this parameter has the following additional requirements: each filter value does not need to start with a period (.). For example: png;txt. When Object is fullquerystring, the input requirements for this parameter are as follows: the total length of all filter values must not exceed 256 characters. Filter values can include numbers, letters, percent sign (%), underscore (), and hyphen (-). When Object is clientip, if Operator is equal or notequal, the input requirements for this parameter are as follows: the number of IP addresses must not exceed 5. IP addresses must be IPv4 addresses. If you specify Condition, Value is required.
    Object string
    Indicates a filter type. This parameter has the following values: path: The full path in the request URL. directory: Any directory in the path. For example, if the path is /a/b/c/d/file, then /a/, /b/c/, and /d/ are directories. filetype: The extension at the end of the path. fullquerystring: The query string in the request URL. clientip: The client's IP address or the location associated with the IP address. If you specify Condition, Object is required.
    Operator string
    Specifies a comparison type. Different Objects correspond to different values. When Object is path, directory, or filetype, the parameter values are equal and notequal. When Object is path, additional values are regexmatch and regexnotmatch. When Object is fullquerystring, the values are regexmatch and regexnotmatch. When Object is clientip, the values are equal, notequal, belong, and notbelong. The comparison types are explained as follows: equal: If Object matches any filter value in Value, the request meets this filter condition. notequal: If Object does not match any filter value in Value, the request meets this filter condition. regexmatch: If any regular expression in Value matches any part of Object, the request meets this filter condition. regexnotmatch: If none of the regular expressions in Value match any part of Object, the request meets this filter condition. belong: If the client IP address belongs to any country or region listed in Value, the request meets this filter condition. notbelong: If the client IP address does not belong to any country or region listed in Value, the request meets this filter condition. If you specify Condition, Operator is required.
    Values []string
    Represents one or more filter values. Filter values are separated by semicolons (;). The input requirements for this parameter are as follows: When Object is path, directory, or filetype, the total length of all filter values must not exceed 1,024 characters and must not contain the following characters: consecutive slashes (//), spaces, dollar sign ($), question mark (?), or Delete (ASCII code 127). When Object is path, this parameter has the following additional requirements: each filter value must start with a slash (/) but must not end with a slash (/). You can use one or more asterisks () in the filter value, where each asterisk represents one or more characters. For example: /www/img/myimage.png. When Object is directory, this parameter has the following additional requirements: each filter value must start and end with a slash (/). For example: /www/img/. When Object is filetype, this parameter has the following additional requirements: each filter value does not need to start with a period (.). For example: png;txt. When Object is fullquerystring, the input requirements for this parameter are as follows: the total length of all filter values must not exceed 256 characters. Filter values can include numbers, letters, percent sign (%), underscore (), and hyphen (-). When Object is clientip, if Operator is equal or notequal, the input requirements for this parameter are as follows: the number of IP addresses must not exceed 5. IP addresses must be IPv4 addresses. If you specify Condition, Value is required.
    object String
    Indicates a filter type. This parameter has the following values: path: The full path in the request URL. directory: Any directory in the path. For example, if the path is /a/b/c/d/file, then /a/, /b/c/, and /d/ are directories. filetype: The extension at the end of the path. fullquerystring: The query string in the request URL. clientip: The client's IP address or the location associated with the IP address. If you specify Condition, Object is required.
    operator String
    Specifies a comparison type. Different Objects correspond to different values. When Object is path, directory, or filetype, the parameter values are equal and notequal. When Object is path, additional values are regexmatch and regexnotmatch. When Object is fullquerystring, the values are regexmatch and regexnotmatch. When Object is clientip, the values are equal, notequal, belong, and notbelong. The comparison types are explained as follows: equal: If Object matches any filter value in Value, the request meets this filter condition. notequal: If Object does not match any filter value in Value, the request meets this filter condition. regexmatch: If any regular expression in Value matches any part of Object, the request meets this filter condition. regexnotmatch: If none of the regular expressions in Value match any part of Object, the request meets this filter condition. belong: If the client IP address belongs to any country or region listed in Value, the request meets this filter condition. notbelong: If the client IP address does not belong to any country or region listed in Value, the request meets this filter condition. If you specify Condition, Operator is required.
    values List<String>
    Represents one or more filter values. Filter values are separated by semicolons (;). The input requirements for this parameter are as follows: When Object is path, directory, or filetype, the total length of all filter values must not exceed 1,024 characters and must not contain the following characters: consecutive slashes (//), spaces, dollar sign ($), question mark (?), or Delete (ASCII code 127). When Object is path, this parameter has the following additional requirements: each filter value must start with a slash (/) but must not end with a slash (/). You can use one or more asterisks () in the filter value, where each asterisk represents one or more characters. For example: /www/img/myimage.png. When Object is directory, this parameter has the following additional requirements: each filter value must start and end with a slash (/). For example: /www/img/. When Object is filetype, this parameter has the following additional requirements: each filter value does not need to start with a period (.). For example: png;txt. When Object is fullquerystring, the input requirements for this parameter are as follows: the total length of all filter values must not exceed 256 characters. Filter values can include numbers, letters, percent sign (%), underscore (), and hyphen (-). When Object is clientip, if Operator is equal or notequal, the input requirements for this parameter are as follows: the number of IP addresses must not exceed 5. IP addresses must be IPv4 addresses. If you specify Condition, Value is required.
    object string
    Indicates a filter type. This parameter has the following values: path: The full path in the request URL. directory: Any directory in the path. For example, if the path is /a/b/c/d/file, then /a/, /b/c/, and /d/ are directories. filetype: The extension at the end of the path. fullquerystring: The query string in the request URL. clientip: The client's IP address or the location associated with the IP address. If you specify Condition, Object is required.
    operator string
    Specifies a comparison type. Different Objects correspond to different values. When Object is path, directory, or filetype, the parameter values are equal and notequal. When Object is path, additional values are regexmatch and regexnotmatch. When Object is fullquerystring, the values are regexmatch and regexnotmatch. When Object is clientip, the values are equal, notequal, belong, and notbelong. The comparison types are explained as follows: equal: If Object matches any filter value in Value, the request meets this filter condition. notequal: If Object does not match any filter value in Value, the request meets this filter condition. regexmatch: If any regular expression in Value matches any part of Object, the request meets this filter condition. regexnotmatch: If none of the regular expressions in Value match any part of Object, the request meets this filter condition. belong: If the client IP address belongs to any country or region listed in Value, the request meets this filter condition. notbelong: If the client IP address does not belong to any country or region listed in Value, the request meets this filter condition. If you specify Condition, Operator is required.
    values string[]
    Represents one or more filter values. Filter values are separated by semicolons (;). The input requirements for this parameter are as follows: When Object is path, directory, or filetype, the total length of all filter values must not exceed 1,024 characters and must not contain the following characters: consecutive slashes (//), spaces, dollar sign ($), question mark (?), or Delete (ASCII code 127). When Object is path, this parameter has the following additional requirements: each filter value must start with a slash (/) but must not end with a slash (/). You can use one or more asterisks () in the filter value, where each asterisk represents one or more characters. For example: /www/img/myimage.png. When Object is directory, this parameter has the following additional requirements: each filter value must start and end with a slash (/). For example: /www/img/. When Object is filetype, this parameter has the following additional requirements: each filter value does not need to start with a period (.). For example: png;txt. When Object is fullquerystring, the input requirements for this parameter are as follows: the total length of all filter values must not exceed 256 characters. Filter values can include numbers, letters, percent sign (%), underscore (), and hyphen (-). When Object is clientip, if Operator is equal or notequal, the input requirements for this parameter are as follows: the number of IP addresses must not exceed 5. IP addresses must be IPv4 addresses. If you specify Condition, Value is required.
    object str
    Indicates a filter type. This parameter has the following values: path: The full path in the request URL. directory: Any directory in the path. For example, if the path is /a/b/c/d/file, then /a/, /b/c/, and /d/ are directories. filetype: The extension at the end of the path. fullquerystring: The query string in the request URL. clientip: The client's IP address or the location associated with the IP address. If you specify Condition, Object is required.
    operator str
    Specifies a comparison type. Different Objects correspond to different values. When Object is path, directory, or filetype, the parameter values are equal and notequal. When Object is path, additional values are regexmatch and regexnotmatch. When Object is fullquerystring, the values are regexmatch and regexnotmatch. When Object is clientip, the values are equal, notequal, belong, and notbelong. The comparison types are explained as follows: equal: If Object matches any filter value in Value, the request meets this filter condition. notequal: If Object does not match any filter value in Value, the request meets this filter condition. regexmatch: If any regular expression in Value matches any part of Object, the request meets this filter condition. regexnotmatch: If none of the regular expressions in Value match any part of Object, the request meets this filter condition. belong: If the client IP address belongs to any country or region listed in Value, the request meets this filter condition. notbelong: If the client IP address does not belong to any country or region listed in Value, the request meets this filter condition. If you specify Condition, Operator is required.
    values Sequence[str]
    Represents one or more filter values. Filter values are separated by semicolons (;). The input requirements for this parameter are as follows: When Object is path, directory, or filetype, the total length of all filter values must not exceed 1,024 characters and must not contain the following characters: consecutive slashes (//), spaces, dollar sign ($), question mark (?), or Delete (ASCII code 127). When Object is path, this parameter has the following additional requirements: each filter value must start with a slash (/) but must not end with a slash (/). You can use one or more asterisks () in the filter value, where each asterisk represents one or more characters. For example: /www/img/myimage.png. When Object is directory, this parameter has the following additional requirements: each filter value must start and end with a slash (/). For example: /www/img/. When Object is filetype, this parameter has the following additional requirements: each filter value does not need to start with a period (.). For example: png;txt. When Object is fullquerystring, the input requirements for this parameter are as follows: the total length of all filter values must not exceed 256 characters. Filter values can include numbers, letters, percent sign (%), underscore (), and hyphen (-). When Object is clientip, if Operator is equal or notequal, the input requirements for this parameter are as follows: the number of IP addresses must not exceed 5. IP addresses must be IPv4 addresses. If you specify Condition, Value is required.
    object String
    Indicates a filter type. This parameter has the following values: path: The full path in the request URL. directory: Any directory in the path. For example, if the path is /a/b/c/d/file, then /a/, /b/c/, and /d/ are directories. filetype: The extension at the end of the path. fullquerystring: The query string in the request URL. clientip: The client's IP address or the location associated with the IP address. If you specify Condition, Object is required.
    operator String
    Specifies a comparison type. Different Objects correspond to different values. When Object is path, directory, or filetype, the parameter values are equal and notequal. When Object is path, additional values are regexmatch and regexnotmatch. When Object is fullquerystring, the values are regexmatch and regexnotmatch. When Object is clientip, the values are equal, notequal, belong, and notbelong. The comparison types are explained as follows: equal: If Object matches any filter value in Value, the request meets this filter condition. notequal: If Object does not match any filter value in Value, the request meets this filter condition. regexmatch: If any regular expression in Value matches any part of Object, the request meets this filter condition. regexnotmatch: If none of the regular expressions in Value match any part of Object, the request meets this filter condition. belong: If the client IP address belongs to any country or region listed in Value, the request meets this filter condition. notbelong: If the client IP address does not belong to any country or region listed in Value, the request meets this filter condition. If you specify Condition, Operator is required.
    values List<String>
    Represents one or more filter values. Filter values are separated by semicolons (;). The input requirements for this parameter are as follows: When Object is path, directory, or filetype, the total length of all filter values must not exceed 1,024 characters and must not contain the following characters: consecutive slashes (//), spaces, dollar sign ($), question mark (?), or Delete (ASCII code 127). When Object is path, this parameter has the following additional requirements: each filter value must start with a slash (/) but must not end with a slash (/). You can use one or more asterisks () in the filter value, where each asterisk represents one or more characters. For example: /www/img/myimage.png. When Object is directory, this parameter has the following additional requirements: each filter value must start and end with a slash (/). For example: /www/img/. When Object is filetype, this parameter has the following additional requirements: each filter value does not need to start with a period (.). For example: png;txt. When Object is fullquerystring, the input requirements for this parameter are as follows: the total length of all filter values must not exceed 256 characters. Filter values can include numbers, letters, percent sign (%), underscore (), and hyphen (-). When Object is clientip, if Operator is equal or notequal, the input requirements for this parameter are as follows: the number of IP addresses must not exceed 5. IP addresses must be IPv4 addresses. If you specify Condition, Value is required.

    GetDomainCustomErrorPage

    ErrorPageRules List<Byteplus.GetDomainCustomErrorPageErrorPageRule>
    Indicates a set of configuration rules. You can add up to 50 rules.
    Switch bool
    Indicates whether this feature is enabled. The parameter values are: true: Enabled. false: Disabled. The default value is false.
    ErrorPageRules []GetDomainCustomErrorPageErrorPageRule
    Indicates a set of configuration rules. You can add up to 50 rules.
    Switch bool
    Indicates whether this feature is enabled. The parameter values are: true: Enabled. false: Disabled. The default value is false.
    errorPageRules List<GetDomainCustomErrorPageErrorPageRule>
    Indicates a set of configuration rules. You can add up to 50 rules.
    switch_ Boolean
    Indicates whether this feature is enabled. The parameter values are: true: Enabled. false: Disabled. The default value is false.
    errorPageRules GetDomainCustomErrorPageErrorPageRule[]
    Indicates a set of configuration rules. You can add up to 50 rules.
    switch boolean
    Indicates whether this feature is enabled. The parameter values are: true: Enabled. false: Disabled. The default value is false.
    error_page_rules Sequence[GetDomainCustomErrorPageErrorPageRule]
    Indicates a set of configuration rules. You can add up to 50 rules.
    switch bool
    Indicates whether this feature is enabled. The parameter values are: true: Enabled. false: Disabled. The default value is false.
    errorPageRules List<Property Map>
    Indicates a set of configuration rules. You can add up to 50 rules.
    switch Boolean
    Indicates whether this feature is enabled. The parameter values are: true: Enabled. false: Disabled. The default value is false.

    GetDomainCustomErrorPageErrorPageRule

    ErrorPageAction Byteplus.GetDomainCustomErrorPageErrorPageRuleErrorPageAction
    Indicates the relevant configuration for the rule.
    ErrorPageAction GetDomainCustomErrorPageErrorPageRuleErrorPageAction
    Indicates the relevant configuration for the rule.
    errorPageAction GetDomainCustomErrorPageErrorPageRuleErrorPageAction
    Indicates the relevant configuration for the rule.
    errorPageAction GetDomainCustomErrorPageErrorPageRuleErrorPageAction
    Indicates the relevant configuration for the rule.
    error_page_action GetDomainCustomErrorPageErrorPageRuleErrorPageAction
    Indicates the relevant configuration for the rule.
    errorPageAction Property Map
    Indicates the relevant configuration for the rule.

    GetDomainCustomErrorPageErrorPageRuleErrorPageAction

    Action string
    Indicates the actual operation. Currently, you can only set this parameter to redirect. This means the client request will be redirected.
    RedirectCode string
    Indicates the response status code for redirection. You can select an appropriate status code as needed. The available values are 301, 302, 303, 307, and 308. Note: For 301 and 302, if the original request method is not GET, the client may use GET when sending the new request to the new URL. For 303, the new request method is GET. For 307 and 308, the new request method remains the same as the original request and will not be changed.
    RedirectUrl string
    Indicates the target address for redirection. The length must not exceed 1,024 characters. The address must include the protocol, domain name, and path, and comply with URL specifications.
    StatusCode string
    Indicates a status code, with a value range of 400–599. You can enter 4xx or 5xx. 4xx covers all status codes from 400 to 499. 5xx covers all status codes from 500 to 599.
    Action string
    Indicates the actual operation. Currently, you can only set this parameter to redirect. This means the client request will be redirected.
    RedirectCode string
    Indicates the response status code for redirection. You can select an appropriate status code as needed. The available values are 301, 302, 303, 307, and 308. Note: For 301 and 302, if the original request method is not GET, the client may use GET when sending the new request to the new URL. For 303, the new request method is GET. For 307 and 308, the new request method remains the same as the original request and will not be changed.
    RedirectUrl string
    Indicates the target address for redirection. The length must not exceed 1,024 characters. The address must include the protocol, domain name, and path, and comply with URL specifications.
    StatusCode string
    Indicates a status code, with a value range of 400–599. You can enter 4xx or 5xx. 4xx covers all status codes from 400 to 499. 5xx covers all status codes from 500 to 599.
    action String
    Indicates the actual operation. Currently, you can only set this parameter to redirect. This means the client request will be redirected.
    redirectCode String
    Indicates the response status code for redirection. You can select an appropriate status code as needed. The available values are 301, 302, 303, 307, and 308. Note: For 301 and 302, if the original request method is not GET, the client may use GET when sending the new request to the new URL. For 303, the new request method is GET. For 307 and 308, the new request method remains the same as the original request and will not be changed.
    redirectUrl String
    Indicates the target address for redirection. The length must not exceed 1,024 characters. The address must include the protocol, domain name, and path, and comply with URL specifications.
    statusCode String
    Indicates a status code, with a value range of 400–599. You can enter 4xx or 5xx. 4xx covers all status codes from 400 to 499. 5xx covers all status codes from 500 to 599.
    action string
    Indicates the actual operation. Currently, you can only set this parameter to redirect. This means the client request will be redirected.
    redirectCode string
    Indicates the response status code for redirection. You can select an appropriate status code as needed. The available values are 301, 302, 303, 307, and 308. Note: For 301 and 302, if the original request method is not GET, the client may use GET when sending the new request to the new URL. For 303, the new request method is GET. For 307 and 308, the new request method remains the same as the original request and will not be changed.
    redirectUrl string
    Indicates the target address for redirection. The length must not exceed 1,024 characters. The address must include the protocol, domain name, and path, and comply with URL specifications.
    statusCode string
    Indicates a status code, with a value range of 400–599. You can enter 4xx or 5xx. 4xx covers all status codes from 400 to 499. 5xx covers all status codes from 500 to 599.
    action str
    Indicates the actual operation. Currently, you can only set this parameter to redirect. This means the client request will be redirected.
    redirect_code str
    Indicates the response status code for redirection. You can select an appropriate status code as needed. The available values are 301, 302, 303, 307, and 308. Note: For 301 and 302, if the original request method is not GET, the client may use GET when sending the new request to the new URL. For 303, the new request method is GET. For 307 and 308, the new request method remains the same as the original request and will not be changed.
    redirect_url str
    Indicates the target address for redirection. The length must not exceed 1,024 characters. The address must include the protocol, domain name, and path, and comply with URL specifications.
    status_code str
    Indicates a status code, with a value range of 400–599. You can enter 4xx or 5xx. 4xx covers all status codes from 400 to 499. 5xx covers all status codes from 500 to 599.
    action String
    Indicates the actual operation. Currently, you can only set this parameter to redirect. This means the client request will be redirected.
    redirectCode String
    Indicates the response status code for redirection. You can select an appropriate status code as needed. The available values are 301, 302, 303, 307, and 308. Note: For 301 and 302, if the original request method is not GET, the client may use GET when sending the new request to the new URL. For 303, the new request method is GET. For 307 and 308, the new request method remains the same as the original request and will not be changed.
    redirectUrl String
    Indicates the target address for redirection. The length must not exceed 1,024 characters. The address must include the protocol, domain name, and path, and comply with URL specifications.
    statusCode String
    Indicates a status code, with a value range of 400–599. You can enter 4xx or 5xx. 4xx covers all status codes from 400 to 499. 5xx covers all status codes from 500 to 599.

    GetDomainCustomizeAccessRule

    CustomizeInstances List<Byteplus.GetDomainCustomizeAccessRuleCustomizeInstance>
    Describes a rule list. Each rule in the list defines a Denylist or Allowlist configuration. The list can contain up to 10 rules.
    Switch bool
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.
    CustomizeInstances []GetDomainCustomizeAccessRuleCustomizeInstance
    Describes a rule list. Each rule in the list defines a Denylist or Allowlist configuration. The list can contain up to 10 rules.
    Switch bool
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.
    customizeInstances List<GetDomainCustomizeAccessRuleCustomizeInstance>
    Describes a rule list. Each rule in the list defines a Denylist or Allowlist configuration. The list can contain up to 10 rules.
    switch_ Boolean
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.
    customizeInstances GetDomainCustomizeAccessRuleCustomizeInstance[]
    Describes a rule list. Each rule in the list defines a Denylist or Allowlist configuration. The list can contain up to 10 rules.
    switch boolean
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.
    customize_instances Sequence[GetDomainCustomizeAccessRuleCustomizeInstance]
    Describes a rule list. Each rule in the list defines a Denylist or Allowlist configuration. The list can contain up to 10 rules.
    switch bool
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.
    customizeInstances List<Property Map>
    Describes a rule list. Each rule in the list defines a Denylist or Allowlist configuration. The list can contain up to 10 rules.
    switch Boolean
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.

    GetDomainCustomizeAccessRuleCustomizeInstance

    CustomizeRule GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRule
    Describes the configuration for a rule in the list.
    customizeRule GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRule
    Describes the configuration for a rule in the list.
    customizeRule GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRule
    Describes the configuration for a rule in the list.
    customize_rule GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRule
    Describes the configuration for a rule in the list.
    customizeRule Property Map
    Describes the configuration for a rule in the list.

    GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRule

    AccessAction Byteplus.GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleAccessAction
    Indicates the configuration of the denylist or allowlist in this rule.
    Condition Byteplus.GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    AccessAction GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleAccessAction
    Indicates the configuration of the denylist or allowlist in this rule.
    Condition GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    accessAction GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleAccessAction
    Indicates the configuration of the denylist or allowlist in this rule.
    condition GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    accessAction GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleAccessAction
    Indicates the configuration of the denylist or allowlist in this rule.
    condition GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    access_action GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleAccessAction
    Indicates the configuration of the denylist or allowlist in this rule.
    condition GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    accessAction Property Map
    Indicates the configuration of the denylist or allowlist in this rule.
    condition Property Map
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.

    GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleAccessAction

    AllowEmpty bool
    Indicates whether the CDN accepts user requests where the RequestHeader value is empty. An empty header value refers to either of the following situations: The user request does not include RequestHeader. The user request includes RequestHeader, but the header value is empty ("").
    ListRules List<string>
    Indicates a list of regular expressions used to match the value of the request header. The list can contain up to 20 regular expressions, and the total length of all expressions cannot exceed 1,024 characters. The relationship between the regular expressions is OR. That is, if the value of RequestHeader in a user request matches any regular expression, the rule applies to the request.
    RequestHeader string
    Indicates a specified request header. Header names are case-insensitive and must meet the following requirements: The name must not exceed 1,024 characters. The name cannot be Referer, User-Agent, or Origin. The name can contain letters, digits, underscores (_), and hyphens (-). The name cannot start with a digit.
    RuleType string
    Indicates the type of list. This parameter has the following values: allow: defines an allowlist in this rule. If a user request does not match the allowlist, the CDN rejects the request and returns a 403 status code. deny: defines a denylist in this rule. If a user request matches the denylist, the CDN rejects the request and returns a 403 status code.
    AllowEmpty bool
    Indicates whether the CDN accepts user requests where the RequestHeader value is empty. An empty header value refers to either of the following situations: The user request does not include RequestHeader. The user request includes RequestHeader, but the header value is empty ("").
    ListRules []string
    Indicates a list of regular expressions used to match the value of the request header. The list can contain up to 20 regular expressions, and the total length of all expressions cannot exceed 1,024 characters. The relationship between the regular expressions is OR. That is, if the value of RequestHeader in a user request matches any regular expression, the rule applies to the request.
    RequestHeader string
    Indicates a specified request header. Header names are case-insensitive and must meet the following requirements: The name must not exceed 1,024 characters. The name cannot be Referer, User-Agent, or Origin. The name can contain letters, digits, underscores (_), and hyphens (-). The name cannot start with a digit.
    RuleType string
    Indicates the type of list. This parameter has the following values: allow: defines an allowlist in this rule. If a user request does not match the allowlist, the CDN rejects the request and returns a 403 status code. deny: defines a denylist in this rule. If a user request matches the denylist, the CDN rejects the request and returns a 403 status code.
    allowEmpty Boolean
    Indicates whether the CDN accepts user requests where the RequestHeader value is empty. An empty header value refers to either of the following situations: The user request does not include RequestHeader. The user request includes RequestHeader, but the header value is empty ("").
    listRules List<String>
    Indicates a list of regular expressions used to match the value of the request header. The list can contain up to 20 regular expressions, and the total length of all expressions cannot exceed 1,024 characters. The relationship between the regular expressions is OR. That is, if the value of RequestHeader in a user request matches any regular expression, the rule applies to the request.
    requestHeader String
    Indicates a specified request header. Header names are case-insensitive and must meet the following requirements: The name must not exceed 1,024 characters. The name cannot be Referer, User-Agent, or Origin. The name can contain letters, digits, underscores (_), and hyphens (-). The name cannot start with a digit.
    ruleType String
    Indicates the type of list. This parameter has the following values: allow: defines an allowlist in this rule. If a user request does not match the allowlist, the CDN rejects the request and returns a 403 status code. deny: defines a denylist in this rule. If a user request matches the denylist, the CDN rejects the request and returns a 403 status code.
    allowEmpty boolean
    Indicates whether the CDN accepts user requests where the RequestHeader value is empty. An empty header value refers to either of the following situations: The user request does not include RequestHeader. The user request includes RequestHeader, but the header value is empty ("").
    listRules string[]
    Indicates a list of regular expressions used to match the value of the request header. The list can contain up to 20 regular expressions, and the total length of all expressions cannot exceed 1,024 characters. The relationship between the regular expressions is OR. That is, if the value of RequestHeader in a user request matches any regular expression, the rule applies to the request.
    requestHeader string
    Indicates a specified request header. Header names are case-insensitive and must meet the following requirements: The name must not exceed 1,024 characters. The name cannot be Referer, User-Agent, or Origin. The name can contain letters, digits, underscores (_), and hyphens (-). The name cannot start with a digit.
    ruleType string
    Indicates the type of list. This parameter has the following values: allow: defines an allowlist in this rule. If a user request does not match the allowlist, the CDN rejects the request and returns a 403 status code. deny: defines a denylist in this rule. If a user request matches the denylist, the CDN rejects the request and returns a 403 status code.
    allow_empty bool
    Indicates whether the CDN accepts user requests where the RequestHeader value is empty. An empty header value refers to either of the following situations: The user request does not include RequestHeader. The user request includes RequestHeader, but the header value is empty ("").
    list_rules Sequence[str]
    Indicates a list of regular expressions used to match the value of the request header. The list can contain up to 20 regular expressions, and the total length of all expressions cannot exceed 1,024 characters. The relationship between the regular expressions is OR. That is, if the value of RequestHeader in a user request matches any regular expression, the rule applies to the request.
    request_header str
    Indicates a specified request header. Header names are case-insensitive and must meet the following requirements: The name must not exceed 1,024 characters. The name cannot be Referer, User-Agent, or Origin. The name can contain letters, digits, underscores (_), and hyphens (-). The name cannot start with a digit.
    rule_type str
    Indicates the type of list. This parameter has the following values: allow: defines an allowlist in this rule. If a user request does not match the allowlist, the CDN rejects the request and returns a 403 status code. deny: defines a denylist in this rule. If a user request matches the denylist, the CDN rejects the request and returns a 403 status code.
    allowEmpty Boolean
    Indicates whether the CDN accepts user requests where the RequestHeader value is empty. An empty header value refers to either of the following situations: The user request does not include RequestHeader. The user request includes RequestHeader, but the header value is empty ("").
    listRules List<String>
    Indicates a list of regular expressions used to match the value of the request header. The list can contain up to 20 regular expressions, and the total length of all expressions cannot exceed 1,024 characters. The relationship between the regular expressions is OR. That is, if the value of RequestHeader in a user request matches any regular expression, the rule applies to the request.
    requestHeader String
    Indicates a specified request header. Header names are case-insensitive and must meet the following requirements: The name must not exceed 1,024 characters. The name cannot be Referer, User-Agent, or Origin. The name can contain letters, digits, underscores (_), and hyphens (-). The name cannot start with a digit.
    ruleType String
    Indicates the type of list. This parameter has the following values: allow: defines an allowlist in this rule. If a user request does not match the allowlist, the CDN rejects the request and returns a 403 status code. deny: defines a denylist in this rule. If a user request matches the denylist, the CDN rejects the request and returns a 403 status code.

    GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleCondition

    ConditionRules List<Byteplus.GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRuleConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainDomainLock

    Remark string
    Indicates the reason why the acceleration domain is locked. If Status is on, this parameter provides a description of the reason. If Status is off, this parameter is empty ("")
    Status string
    Indicates the lock status of the acceleration domain name. The parameter has the following values: on: the acceleration domain name is locked. off: the acceleration domain name is not locked.
    Remark string
    Indicates the reason why the acceleration domain is locked. If Status is on, this parameter provides a description of the reason. If Status is off, this parameter is empty ("")
    Status string
    Indicates the lock status of the acceleration domain name. The parameter has the following values: on: the acceleration domain name is locked. off: the acceleration domain name is not locked.
    remark String
    Indicates the reason why the acceleration domain is locked. If Status is on, this parameter provides a description of the reason. If Status is off, this parameter is empty ("")
    status String
    Indicates the lock status of the acceleration domain name. The parameter has the following values: on: the acceleration domain name is locked. off: the acceleration domain name is not locked.
    remark string
    Indicates the reason why the acceleration domain is locked. If Status is on, this parameter provides a description of the reason. If Status is off, this parameter is empty ("")
    status string
    Indicates the lock status of the acceleration domain name. The parameter has the following values: on: the acceleration domain name is locked. off: the acceleration domain name is not locked.
    remark str
    Indicates the reason why the acceleration domain is locked. If Status is on, this parameter provides a description of the reason. If Status is off, this parameter is empty ("")
    status str
    Indicates the lock status of the acceleration domain name. The parameter has the following values: on: the acceleration domain name is locked. off: the acceleration domain name is not locked.
    remark String
    Indicates the reason why the acceleration domain is locked. If Status is on, this parameter provides a description of the reason. If Status is off, this parameter is empty ("")
    status String
    Indicates the lock status of the acceleration domain name. The parameter has the following values: on: the acceleration domain name is locked. off: the acceleration domain name is not locked.

    GetDomainDownloadSpeedLimit

    DownloadSpeedLimitRules List<Byteplus.GetDomainDownloadSpeedLimitDownloadSpeedLimitRule>
    Indicates the rule for download rate limiting. This parameter is required when Switch is true.
    Switch bool
    Indicates whether this feature is enabled. The parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.
    DownloadSpeedLimitRules []GetDomainDownloadSpeedLimitDownloadSpeedLimitRule
    Indicates the rule for download rate limiting. This parameter is required when Switch is true.
    Switch bool
    Indicates whether this feature is enabled. The parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.
    downloadSpeedLimitRules List<GetDomainDownloadSpeedLimitDownloadSpeedLimitRule>
    Indicates the rule for download rate limiting. This parameter is required when Switch is true.
    switch_ Boolean
    Indicates whether this feature is enabled. The parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.
    downloadSpeedLimitRules GetDomainDownloadSpeedLimitDownloadSpeedLimitRule[]
    Indicates the rule for download rate limiting. This parameter is required when Switch is true.
    switch boolean
    Indicates whether this feature is enabled. The parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.
    download_speed_limit_rules Sequence[GetDomainDownloadSpeedLimitDownloadSpeedLimitRule]
    Indicates the rule for download rate limiting. This parameter is required when Switch is true.
    switch bool
    Indicates whether this feature is enabled. The parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.
    downloadSpeedLimitRules List<Property Map>
    Indicates the rule for download rate limiting. This parameter is required when Switch is true.
    switch Boolean
    Indicates whether this feature is enabled. The parameter has the following values: true: enables the feature. false: disables the feature. The default value is false.

    GetDomainDownloadSpeedLimitDownloadSpeedLimitRule

    Condition Byteplus.GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    DownloadSpeedLimitAction Byteplus.GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitAction
    Indicates the rate limiting configuration.
    Condition GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    DownloadSpeedLimitAction GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitAction
    Indicates the rate limiting configuration.
    condition GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    downloadSpeedLimitAction GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitAction
    Indicates the rate limiting configuration.
    condition GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    downloadSpeedLimitAction GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitAction
    Indicates the rate limiting configuration.
    condition GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    download_speed_limit_action GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitAction
    Indicates the rate limiting configuration.
    condition Property Map
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    downloadSpeedLimitAction Property Map
    Indicates the rate limiting configuration.

    GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleCondition

    ConditionRules List<Byteplus.GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitAction

    SpeedLimitRate int
    Indicates the maximum download speed for a single request, measured in B/S. The parameter range is 1–1,073,741,824,000,000, using a base conversion of 1,024.
    SpeedLimitRateAfter int
    Represents a data volume. Download throttling is enabled for a request only when the amount of data downloaded in a single request reaches this value. Unit: Byte. The parameter range is 0–1,073,741,824,000,000, using a base of 1,024 for conversion.
    SpeedLimitTime Byteplus.GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitActionSpeedLimitTime
    Indicates the date and time period when rate limiting occurs.
    SpeedLimitRate int
    Indicates the maximum download speed for a single request, measured in B/S. The parameter range is 1–1,073,741,824,000,000, using a base conversion of 1,024.
    SpeedLimitRateAfter int
    Represents a data volume. Download throttling is enabled for a request only when the amount of data downloaded in a single request reaches this value. Unit: Byte. The parameter range is 0–1,073,741,824,000,000, using a base of 1,024 for conversion.
    SpeedLimitTime GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitActionSpeedLimitTime
    Indicates the date and time period when rate limiting occurs.
    speedLimitRate Integer
    Indicates the maximum download speed for a single request, measured in B/S. The parameter range is 1–1,073,741,824,000,000, using a base conversion of 1,024.
    speedLimitRateAfter Integer
    Represents a data volume. Download throttling is enabled for a request only when the amount of data downloaded in a single request reaches this value. Unit: Byte. The parameter range is 0–1,073,741,824,000,000, using a base of 1,024 for conversion.
    speedLimitTime GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitActionSpeedLimitTime
    Indicates the date and time period when rate limiting occurs.
    speedLimitRate number
    Indicates the maximum download speed for a single request, measured in B/S. The parameter range is 1–1,073,741,824,000,000, using a base conversion of 1,024.
    speedLimitRateAfter number
    Represents a data volume. Download throttling is enabled for a request only when the amount of data downloaded in a single request reaches this value. Unit: Byte. The parameter range is 0–1,073,741,824,000,000, using a base of 1,024 for conversion.
    speedLimitTime GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitActionSpeedLimitTime
    Indicates the date and time period when rate limiting occurs.
    speed_limit_rate int
    Indicates the maximum download speed for a single request, measured in B/S. The parameter range is 1–1,073,741,824,000,000, using a base conversion of 1,024.
    speed_limit_rate_after int
    Represents a data volume. Download throttling is enabled for a request only when the amount of data downloaded in a single request reaches this value. Unit: Byte. The parameter range is 0–1,073,741,824,000,000, using a base of 1,024 for conversion.
    speed_limit_time GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitActionSpeedLimitTime
    Indicates the date and time period when rate limiting occurs.
    speedLimitRate Number
    Indicates the maximum download speed for a single request, measured in B/S. The parameter range is 1–1,073,741,824,000,000, using a base conversion of 1,024.
    speedLimitRateAfter Number
    Represents a data volume. Download throttling is enabled for a request only when the amount of data downloaded in a single request reaches this value. Unit: Byte. The parameter range is 0–1,073,741,824,000,000, using a base of 1,024 for conversion.
    speedLimitTime Property Map
    Indicates the date and time period when rate limiting occurs.

    GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitActionSpeedLimitTime

    BeginTime string
    Indicates the start time for rate limiting. The time format is mm:ss. If the DayWeek parameter value is unlimited, the default values for BeginTime and EndTime will be set to 00:00 and 23:59, respectively.
    DayWeek string
    Specifies the date when rate limiting occurs. This parameter has the following values: monday, tuesday, wednesday, thursday, friday, saturday, sunday, unlimited. unlimited means every day. You can specify one or more values. Separate multiple values with a semicolon (;).
    EndTime string
    Indicates the end time for rate limiting. The time format is mm:ss. If the DayWeek parameter is set to unlimited, the default values for BeginTime and EndTime are 00:00 and 23:59, respectively.
    BeginTime string
    Indicates the start time for rate limiting. The time format is mm:ss. If the DayWeek parameter value is unlimited, the default values for BeginTime and EndTime will be set to 00:00 and 23:59, respectively.
    DayWeek string
    Specifies the date when rate limiting occurs. This parameter has the following values: monday, tuesday, wednesday, thursday, friday, saturday, sunday, unlimited. unlimited means every day. You can specify one or more values. Separate multiple values with a semicolon (;).
    EndTime string
    Indicates the end time for rate limiting. The time format is mm:ss. If the DayWeek parameter is set to unlimited, the default values for BeginTime and EndTime are 00:00 and 23:59, respectively.
    beginTime String
    Indicates the start time for rate limiting. The time format is mm:ss. If the DayWeek parameter value is unlimited, the default values for BeginTime and EndTime will be set to 00:00 and 23:59, respectively.
    dayWeek String
    Specifies the date when rate limiting occurs. This parameter has the following values: monday, tuesday, wednesday, thursday, friday, saturday, sunday, unlimited. unlimited means every day. You can specify one or more values. Separate multiple values with a semicolon (;).
    endTime String
    Indicates the end time for rate limiting. The time format is mm:ss. If the DayWeek parameter is set to unlimited, the default values for BeginTime and EndTime are 00:00 and 23:59, respectively.
    beginTime string
    Indicates the start time for rate limiting. The time format is mm:ss. If the DayWeek parameter value is unlimited, the default values for BeginTime and EndTime will be set to 00:00 and 23:59, respectively.
    dayWeek string
    Specifies the date when rate limiting occurs. This parameter has the following values: monday, tuesday, wednesday, thursday, friday, saturday, sunday, unlimited. unlimited means every day. You can specify one or more values. Separate multiple values with a semicolon (;).
    endTime string
    Indicates the end time for rate limiting. The time format is mm:ss. If the DayWeek parameter is set to unlimited, the default values for BeginTime and EndTime are 00:00 and 23:59, respectively.
    begin_time str
    Indicates the start time for rate limiting. The time format is mm:ss. If the DayWeek parameter value is unlimited, the default values for BeginTime and EndTime will be set to 00:00 and 23:59, respectively.
    day_week str
    Specifies the date when rate limiting occurs. This parameter has the following values: monday, tuesday, wednesday, thursday, friday, saturday, sunday, unlimited. unlimited means every day. You can specify one or more values. Separate multiple values with a semicolon (;).
    end_time str
    Indicates the end time for rate limiting. The time format is mm:ss. If the DayWeek parameter is set to unlimited, the default values for BeginTime and EndTime are 00:00 and 23:59, respectively.
    beginTime String
    Indicates the start time for rate limiting. The time format is mm:ss. If the DayWeek parameter value is unlimited, the default values for BeginTime and EndTime will be set to 00:00 and 23:59, respectively.
    dayWeek String
    Specifies the date when rate limiting occurs. This parameter has the following values: monday, tuesday, wednesday, thursday, friday, saturday, sunday, unlimited. unlimited means every day. You can specify one or more values. Separate multiple values with a semicolon (;).
    endTime String
    Indicates the end time for rate limiting. The time format is mm:ss. If the DayWeek parameter is set to unlimited, the default values for BeginTime and EndTime are 00:00 and 23:59, respectively.

    GetDomainHttpForcedRedirect

    EnableForcedRedirect bool
    Indicates whether this feature is enabled. The parameter values are: true: enables the feature. When enabled, the content delivery network redirects incoming HTTPS requests to HTTP requests. false: disables the feature. The content delivery network does not redirect HTTPS requests to HTTP requests. To enable this feature, your acceleration domain must have HTTPS enabled.
    StatusCode string
    Indicates the redirect status code returned by the content delivery network when it receives an HTTPS request. This parameter has the following values: 301: indicates the 301 response status code. 302: indicates the 302 response status code. The default value for this parameter is 301.
    EnableForcedRedirect bool
    Indicates whether this feature is enabled. The parameter values are: true: enables the feature. When enabled, the content delivery network redirects incoming HTTPS requests to HTTP requests. false: disables the feature. The content delivery network does not redirect HTTPS requests to HTTP requests. To enable this feature, your acceleration domain must have HTTPS enabled.
    StatusCode string
    Indicates the redirect status code returned by the content delivery network when it receives an HTTPS request. This parameter has the following values: 301: indicates the 301 response status code. 302: indicates the 302 response status code. The default value for this parameter is 301.
    enableForcedRedirect Boolean
    Indicates whether this feature is enabled. The parameter values are: true: enables the feature. When enabled, the content delivery network redirects incoming HTTPS requests to HTTP requests. false: disables the feature. The content delivery network does not redirect HTTPS requests to HTTP requests. To enable this feature, your acceleration domain must have HTTPS enabled.
    statusCode String
    Indicates the redirect status code returned by the content delivery network when it receives an HTTPS request. This parameter has the following values: 301: indicates the 301 response status code. 302: indicates the 302 response status code. The default value for this parameter is 301.
    enableForcedRedirect boolean
    Indicates whether this feature is enabled. The parameter values are: true: enables the feature. When enabled, the content delivery network redirects incoming HTTPS requests to HTTP requests. false: disables the feature. The content delivery network does not redirect HTTPS requests to HTTP requests. To enable this feature, your acceleration domain must have HTTPS enabled.
    statusCode string
    Indicates the redirect status code returned by the content delivery network when it receives an HTTPS request. This parameter has the following values: 301: indicates the 301 response status code. 302: indicates the 302 response status code. The default value for this parameter is 301.
    enable_forced_redirect bool
    Indicates whether this feature is enabled. The parameter values are: true: enables the feature. When enabled, the content delivery network redirects incoming HTTPS requests to HTTP requests. false: disables the feature. The content delivery network does not redirect HTTPS requests to HTTP requests. To enable this feature, your acceleration domain must have HTTPS enabled.
    status_code str
    Indicates the redirect status code returned by the content delivery network when it receives an HTTPS request. This parameter has the following values: 301: indicates the 301 response status code. 302: indicates the 302 response status code. The default value for this parameter is 301.
    enableForcedRedirect Boolean
    Indicates whether this feature is enabled. The parameter values are: true: enables the feature. When enabled, the content delivery network redirects incoming HTTPS requests to HTTP requests. false: disables the feature. The content delivery network does not redirect HTTPS requests to HTTP requests. To enable this feature, your acceleration domain must have HTTPS enabled.
    statusCode String
    Indicates the redirect status code returned by the content delivery network when it receives an HTTPS request. This parameter has the following values: 301: indicates the 301 response status code. 302: indicates the 302 response status code. The default value for this parameter is 301.

    GetDomainHttps

    CertCheck Byteplus.GetDomainHttpsCertCheck
    Indicates the configuration module for the 'mutual authentication' feature. To configure 'mutual authentication'.
    CertInfo Byteplus.GetDomainHttpsCertInfo
    Indicates the single certificate to be associated with the acceleration domain name.
    CertInfoLists List<Byteplus.GetDomainHttpsCertInfoList>
    Indicates the dual certificate to be associated with the acceleration domain name.
    DisableHttp bool
    Indicates whether to allow requests where the URL scheme is HTTP. The parameter values are: true: allows requests with HTTP scheme. false: does not allow requests with HTTP scheme. The default value is false.
    ForcedRedirect Byteplus.GetDomainHttpsForcedRedirect
    Indicates the configuration module for the 'HTTP Forced Redirect to HTTPS' feature. This feature is disabled by default.
    Hsts Byteplus.GetDomainHttpsHsts
    Indicates the configuration module for the HSTS feature. This feature is disabled by default.
    Http2 bool
    HTTP/2 configuration switch. This parameter has the following values: true: enables HTTP/2. false: disables HTTP/2. To enable HTTP/2, you must first enable HTTPS. This feature is disabled by default. However, HTTP/2 is enabled by default in the following scenarios: The business type of the accelerated domain is web (ServiceType is web). The accelerated domain has already enabled HTTPS.
    Ocsp bool
    Specify whether to enable OCSP stapling. This parameter has the following values: true: enables OCSP stapling. false: disables OCSP stapling. To enable OCSP stapling, you must first enable HTTPS. The default value is false.
    Switch bool
    Indicates whether to enable the HTTPS feature. This parameter has the following values: true: enables the feature; false: disables the feature. If Switch is true, you must specify a certificate. If you specify a single certificate, you need to provide CertInfo. If you specify dual certificates, you need to provide CertInfoList. The certificate you specify can be hosted in the certificate center or on the content delivery network.
    TlsVersions List<string>
    Indicates the configuration module for the "TLS Version" feature. This parameter specifies the TLS versions that user requests can use, with the following options: tlsv1.0: TLS 1.0 tlsv1.1: TLS 1.1 tlsv1.2: TLS 1.2 tlsv1.3: TLS 1.3 The default value for this parameter is ["tlsv1.1", "tlsv1.2", "tlsv1.3"]
    CertCheck GetDomainHttpsCertCheck
    Indicates the configuration module for the 'mutual authentication' feature. To configure 'mutual authentication'.
    CertInfo GetDomainHttpsCertInfo
    Indicates the single certificate to be associated with the acceleration domain name.
    CertInfoLists []GetDomainHttpsCertInfoList
    Indicates the dual certificate to be associated with the acceleration domain name.
    DisableHttp bool
    Indicates whether to allow requests where the URL scheme is HTTP. The parameter values are: true: allows requests with HTTP scheme. false: does not allow requests with HTTP scheme. The default value is false.
    ForcedRedirect GetDomainHttpsForcedRedirect
    Indicates the configuration module for the 'HTTP Forced Redirect to HTTPS' feature. This feature is disabled by default.
    Hsts GetDomainHttpsHsts
    Indicates the configuration module for the HSTS feature. This feature is disabled by default.
    Http2 bool
    HTTP/2 configuration switch. This parameter has the following values: true: enables HTTP/2. false: disables HTTP/2. To enable HTTP/2, you must first enable HTTPS. This feature is disabled by default. However, HTTP/2 is enabled by default in the following scenarios: The business type of the accelerated domain is web (ServiceType is web). The accelerated domain has already enabled HTTPS.
    Ocsp bool
    Specify whether to enable OCSP stapling. This parameter has the following values: true: enables OCSP stapling. false: disables OCSP stapling. To enable OCSP stapling, you must first enable HTTPS. The default value is false.
    Switch bool
    Indicates whether to enable the HTTPS feature. This parameter has the following values: true: enables the feature; false: disables the feature. If Switch is true, you must specify a certificate. If you specify a single certificate, you need to provide CertInfo. If you specify dual certificates, you need to provide CertInfoList. The certificate you specify can be hosted in the certificate center or on the content delivery network.
    TlsVersions []string
    Indicates the configuration module for the "TLS Version" feature. This parameter specifies the TLS versions that user requests can use, with the following options: tlsv1.0: TLS 1.0 tlsv1.1: TLS 1.1 tlsv1.2: TLS 1.2 tlsv1.3: TLS 1.3 The default value for this parameter is ["tlsv1.1", "tlsv1.2", "tlsv1.3"]
    certCheck GetDomainHttpsCertCheck
    Indicates the configuration module for the 'mutual authentication' feature. To configure 'mutual authentication'.
    certInfo GetDomainHttpsCertInfo
    Indicates the single certificate to be associated with the acceleration domain name.
    certInfoLists List<GetDomainHttpsCertInfoList>
    Indicates the dual certificate to be associated with the acceleration domain name.
    disableHttp Boolean
    Indicates whether to allow requests where the URL scheme is HTTP. The parameter values are: true: allows requests with HTTP scheme. false: does not allow requests with HTTP scheme. The default value is false.
    forcedRedirect GetDomainHttpsForcedRedirect
    Indicates the configuration module for the 'HTTP Forced Redirect to HTTPS' feature. This feature is disabled by default.
    hsts GetDomainHttpsHsts
    Indicates the configuration module for the HSTS feature. This feature is disabled by default.
    http2 Boolean
    HTTP/2 configuration switch. This parameter has the following values: true: enables HTTP/2. false: disables HTTP/2. To enable HTTP/2, you must first enable HTTPS. This feature is disabled by default. However, HTTP/2 is enabled by default in the following scenarios: The business type of the accelerated domain is web (ServiceType is web). The accelerated domain has already enabled HTTPS.
    ocsp Boolean
    Specify whether to enable OCSP stapling. This parameter has the following values: true: enables OCSP stapling. false: disables OCSP stapling. To enable OCSP stapling, you must first enable HTTPS. The default value is false.
    switch_ Boolean
    Indicates whether to enable the HTTPS feature. This parameter has the following values: true: enables the feature; false: disables the feature. If Switch is true, you must specify a certificate. If you specify a single certificate, you need to provide CertInfo. If you specify dual certificates, you need to provide CertInfoList. The certificate you specify can be hosted in the certificate center or on the content delivery network.
    tlsVersions List<String>
    Indicates the configuration module for the "TLS Version" feature. This parameter specifies the TLS versions that user requests can use, with the following options: tlsv1.0: TLS 1.0 tlsv1.1: TLS 1.1 tlsv1.2: TLS 1.2 tlsv1.3: TLS 1.3 The default value for this parameter is ["tlsv1.1", "tlsv1.2", "tlsv1.3"]
    certCheck GetDomainHttpsCertCheck
    Indicates the configuration module for the 'mutual authentication' feature. To configure 'mutual authentication'.
    certInfo GetDomainHttpsCertInfo
    Indicates the single certificate to be associated with the acceleration domain name.
    certInfoLists GetDomainHttpsCertInfoList[]
    Indicates the dual certificate to be associated with the acceleration domain name.
    disableHttp boolean
    Indicates whether to allow requests where the URL scheme is HTTP. The parameter values are: true: allows requests with HTTP scheme. false: does not allow requests with HTTP scheme. The default value is false.
    forcedRedirect GetDomainHttpsForcedRedirect
    Indicates the configuration module for the 'HTTP Forced Redirect to HTTPS' feature. This feature is disabled by default.
    hsts GetDomainHttpsHsts
    Indicates the configuration module for the HSTS feature. This feature is disabled by default.
    http2 boolean
    HTTP/2 configuration switch. This parameter has the following values: true: enables HTTP/2. false: disables HTTP/2. To enable HTTP/2, you must first enable HTTPS. This feature is disabled by default. However, HTTP/2 is enabled by default in the following scenarios: The business type of the accelerated domain is web (ServiceType is web). The accelerated domain has already enabled HTTPS.
    ocsp boolean
    Specify whether to enable OCSP stapling. This parameter has the following values: true: enables OCSP stapling. false: disables OCSP stapling. To enable OCSP stapling, you must first enable HTTPS. The default value is false.
    switch boolean
    Indicates whether to enable the HTTPS feature. This parameter has the following values: true: enables the feature; false: disables the feature. If Switch is true, you must specify a certificate. If you specify a single certificate, you need to provide CertInfo. If you specify dual certificates, you need to provide CertInfoList. The certificate you specify can be hosted in the certificate center or on the content delivery network.
    tlsVersions string[]
    Indicates the configuration module for the "TLS Version" feature. This parameter specifies the TLS versions that user requests can use, with the following options: tlsv1.0: TLS 1.0 tlsv1.1: TLS 1.1 tlsv1.2: TLS 1.2 tlsv1.3: TLS 1.3 The default value for this parameter is ["tlsv1.1", "tlsv1.2", "tlsv1.3"]
    cert_check GetDomainHttpsCertCheck
    Indicates the configuration module for the 'mutual authentication' feature. To configure 'mutual authentication'.
    cert_info GetDomainHttpsCertInfo
    Indicates the single certificate to be associated with the acceleration domain name.
    cert_info_lists Sequence[GetDomainHttpsCertInfoList]
    Indicates the dual certificate to be associated with the acceleration domain name.
    disable_http bool
    Indicates whether to allow requests where the URL scheme is HTTP. The parameter values are: true: allows requests with HTTP scheme. false: does not allow requests with HTTP scheme. The default value is false.
    forced_redirect GetDomainHttpsForcedRedirect
    Indicates the configuration module for the 'HTTP Forced Redirect to HTTPS' feature. This feature is disabled by default.
    hsts GetDomainHttpsHsts
    Indicates the configuration module for the HSTS feature. This feature is disabled by default.
    http2 bool
    HTTP/2 configuration switch. This parameter has the following values: true: enables HTTP/2. false: disables HTTP/2. To enable HTTP/2, you must first enable HTTPS. This feature is disabled by default. However, HTTP/2 is enabled by default in the following scenarios: The business type of the accelerated domain is web (ServiceType is web). The accelerated domain has already enabled HTTPS.
    ocsp bool
    Specify whether to enable OCSP stapling. This parameter has the following values: true: enables OCSP stapling. false: disables OCSP stapling. To enable OCSP stapling, you must first enable HTTPS. The default value is false.
    switch bool
    Indicates whether to enable the HTTPS feature. This parameter has the following values: true: enables the feature; false: disables the feature. If Switch is true, you must specify a certificate. If you specify a single certificate, you need to provide CertInfo. If you specify dual certificates, you need to provide CertInfoList. The certificate you specify can be hosted in the certificate center or on the content delivery network.
    tls_versions Sequence[str]
    Indicates the configuration module for the "TLS Version" feature. This parameter specifies the TLS versions that user requests can use, with the following options: tlsv1.0: TLS 1.0 tlsv1.1: TLS 1.1 tlsv1.2: TLS 1.2 tlsv1.3: TLS 1.3 The default value for this parameter is ["tlsv1.1", "tlsv1.2", "tlsv1.3"]
    certCheck Property Map
    Indicates the configuration module for the 'mutual authentication' feature. To configure 'mutual authentication'.
    certInfo Property Map
    Indicates the single certificate to be associated with the acceleration domain name.
    certInfoLists List<Property Map>
    Indicates the dual certificate to be associated with the acceleration domain name.
    disableHttp Boolean
    Indicates whether to allow requests where the URL scheme is HTTP. The parameter values are: true: allows requests with HTTP scheme. false: does not allow requests with HTTP scheme. The default value is false.
    forcedRedirect Property Map
    Indicates the configuration module for the 'HTTP Forced Redirect to HTTPS' feature. This feature is disabled by default.
    hsts Property Map
    Indicates the configuration module for the HSTS feature. This feature is disabled by default.
    http2 Boolean
    HTTP/2 configuration switch. This parameter has the following values: true: enables HTTP/2. false: disables HTTP/2. To enable HTTP/2, you must first enable HTTPS. This feature is disabled by default. However, HTTP/2 is enabled by default in the following scenarios: The business type of the accelerated domain is web (ServiceType is web). The accelerated domain has already enabled HTTPS.
    ocsp Boolean
    Specify whether to enable OCSP stapling. This parameter has the following values: true: enables OCSP stapling. false: disables OCSP stapling. To enable OCSP stapling, you must first enable HTTPS. The default value is false.
    switch Boolean
    Indicates whether to enable the HTTPS feature. This parameter has the following values: true: enables the feature; false: disables the feature. If Switch is true, you must specify a certificate. If you specify a single certificate, you need to provide CertInfo. If you specify dual certificates, you need to provide CertInfoList. The certificate you specify can be hosted in the certificate center or on the content delivery network.
    tlsVersions List<String>
    Indicates the configuration module for the "TLS Version" feature. This parameter specifies the TLS versions that user requests can use, with the following options: tlsv1.0: TLS 1.0 tlsv1.1: TLS 1.1 tlsv1.2: TLS 1.2 tlsv1.3: TLS 1.3 The default value for this parameter is ["tlsv1.1", "tlsv1.2", "tlsv1.3"]

    GetDomainHttpsCertCheck

    CertInfoLists List<Byteplus.GetDomainHttpsCertCheckCertInfoList>
    Specifies a list of CA certificates to associate with the accelerated domain name. The list can contain up to two CA certificates. These CA certificates can be already hosted on the content delivery network or pending upload. The encryption algorithm for CA certificates can be RSA, ECC, or SM2. If a CA certificate is hosted on the content delivery network, you need to specify its ID in CertId. If the certificate is pending upload, you need to specify the Certificate structure and define the certificate within it. After you upload the certificate, it will be hosted on the content delivery network.
    Switch bool
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.
    CertInfoLists []GetDomainHttpsCertCheckCertInfoList
    Specifies a list of CA certificates to associate with the accelerated domain name. The list can contain up to two CA certificates. These CA certificates can be already hosted on the content delivery network or pending upload. The encryption algorithm for CA certificates can be RSA, ECC, or SM2. If a CA certificate is hosted on the content delivery network, you need to specify its ID in CertId. If the certificate is pending upload, you need to specify the Certificate structure and define the certificate within it. After you upload the certificate, it will be hosted on the content delivery network.
    Switch bool
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.
    certInfoLists List<GetDomainHttpsCertCheckCertInfoList>
    Specifies a list of CA certificates to associate with the accelerated domain name. The list can contain up to two CA certificates. These CA certificates can be already hosted on the content delivery network or pending upload. The encryption algorithm for CA certificates can be RSA, ECC, or SM2. If a CA certificate is hosted on the content delivery network, you need to specify its ID in CertId. If the certificate is pending upload, you need to specify the Certificate structure and define the certificate within it. After you upload the certificate, it will be hosted on the content delivery network.
    switch_ Boolean
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.
    certInfoLists GetDomainHttpsCertCheckCertInfoList[]
    Specifies a list of CA certificates to associate with the accelerated domain name. The list can contain up to two CA certificates. These CA certificates can be already hosted on the content delivery network or pending upload. The encryption algorithm for CA certificates can be RSA, ECC, or SM2. If a CA certificate is hosted on the content delivery network, you need to specify its ID in CertId. If the certificate is pending upload, you need to specify the Certificate structure and define the certificate within it. After you upload the certificate, it will be hosted on the content delivery network.
    switch boolean
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.
    cert_info_lists Sequence[GetDomainHttpsCertCheckCertInfoList]
    Specifies a list of CA certificates to associate with the accelerated domain name. The list can contain up to two CA certificates. These CA certificates can be already hosted on the content delivery network or pending upload. The encryption algorithm for CA certificates can be RSA, ECC, or SM2. If a CA certificate is hosted on the content delivery network, you need to specify its ID in CertId. If the certificate is pending upload, you need to specify the Certificate structure and define the certificate within it. After you upload the certificate, it will be hosted on the content delivery network.
    switch bool
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.
    certInfoLists List<Property Map>
    Specifies a list of CA certificates to associate with the accelerated domain name. The list can contain up to two CA certificates. These CA certificates can be already hosted on the content delivery network or pending upload. The encryption algorithm for CA certificates can be RSA, ECC, or SM2. If a CA certificate is hosted on the content delivery network, you need to specify its ID in CertId. If the certificate is pending upload, you need to specify the Certificate structure and define the certificate within it. After you upload the certificate, it will be hosted on the content delivery network.
    switch Boolean
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.

    GetDomainHttpsCertCheckCertInfoList

    CertId string
    Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    CertName string
    Represents the content of the Common Name (CN) field in the CA certificate.
    Certificate Byteplus.GetDomainHttpsCertCheckCertInfoListCertificate
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.
    EffectiveTime int
    Indicates the issuance time of the certificate, in Unix timestamp.
    EncryType string
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    ExpireTime int
    Indicates the expiration time of the certificate, as a Unix timestamp.
    Source string
    Specifies the certificate hosting location. The parameter values are: volccertcenter: certificate center; cdncerthosting: content delivery network.
    CertId string
    Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    CertName string
    Represents the content of the Common Name (CN) field in the CA certificate.
    Certificate GetDomainHttpsCertCheckCertInfoListCertificate
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.
    EffectiveTime int
    Indicates the issuance time of the certificate, in Unix timestamp.
    EncryType string
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    ExpireTime int
    Indicates the expiration time of the certificate, as a Unix timestamp.
    Source string
    Specifies the certificate hosting location. The parameter values are: volccertcenter: certificate center; cdncerthosting: content delivery network.
    certId String
    Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    certName String
    Represents the content of the Common Name (CN) field in the CA certificate.
    certificate GetDomainHttpsCertCheckCertInfoListCertificate
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.
    effectiveTime Integer
    Indicates the issuance time of the certificate, in Unix timestamp.
    encryType String
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    expireTime Integer
    Indicates the expiration time of the certificate, as a Unix timestamp.
    source String
    Specifies the certificate hosting location. The parameter values are: volccertcenter: certificate center; cdncerthosting: content delivery network.
    certId string
    Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    certName string
    Represents the content of the Common Name (CN) field in the CA certificate.
    certificate GetDomainHttpsCertCheckCertInfoListCertificate
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.
    effectiveTime number
    Indicates the issuance time of the certificate, in Unix timestamp.
    encryType string
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    expireTime number
    Indicates the expiration time of the certificate, as a Unix timestamp.
    source string
    Specifies the certificate hosting location. The parameter values are: volccertcenter: certificate center; cdncerthosting: content delivery network.
    cert_id str
    Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    cert_name str
    Represents the content of the Common Name (CN) field in the CA certificate.
    certificate GetDomainHttpsCertCheckCertInfoListCertificate
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.
    effective_time int
    Indicates the issuance time of the certificate, in Unix timestamp.
    encry_type str
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    expire_time int
    Indicates the expiration time of the certificate, as a Unix timestamp.
    source str
    Specifies the certificate hosting location. The parameter values are: volccertcenter: certificate center; cdncerthosting: content delivery network.
    certId String
    Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    certName String
    Represents the content of the Common Name (CN) field in the CA certificate.
    certificate Property Map
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.
    effectiveTime Number
    Indicates the issuance time of the certificate, in Unix timestamp.
    encryType String
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    expireTime Number
    Indicates the expiration time of the certificate, as a Unix timestamp.
    source String
    Specifies the certificate hosting location. The parameter values are: volccertcenter: certificate center; cdncerthosting: content delivery network.

    GetDomainHttpsCertCheckCertInfoListCertificate

    Certificate string
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    EncryptionCert string
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    EncryptionKey string
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    PrivateKey string
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.
    Certificate string
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    EncryptionCert string
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    EncryptionKey string
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    PrivateKey string
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.
    certificate String
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    encryptionCert String
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    encryptionKey String
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    privateKey String
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.
    certificate string
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    encryptionCert string
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    encryptionKey string
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    privateKey string
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.
    certificate str
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    encryption_cert str
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    encryption_key str
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    private_key str
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.
    certificate String
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    encryptionCert String
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    encryptionKey String
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    privateKey String
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.

    GetDomainHttpsCertInfo

    CertId string
    Represents the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    CertName string
    Indicates the content of the Common Name (CN) field in the CA certificate.
    Certificate Byteplus.GetDomainHttpsCertInfoCertificate
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the CDN.
    EffectiveTime int
    Indicates the issuance time of the certificate, in Unix timestamp.
    EncryType string
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    ExpireTime int
    Indicates the expiration time of the certificate, in Unix timestamp.
    Source string
    Indicates the location where the certificate is hosted. This parameter has the following values: volccertcenter: Certificate Center. cdncerthosting: Content Delivery Network.
    CertId string
    Represents the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    CertName string
    Indicates the content of the Common Name (CN) field in the CA certificate.
    Certificate GetDomainHttpsCertInfoCertificate
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the CDN.
    EffectiveTime int
    Indicates the issuance time of the certificate, in Unix timestamp.
    EncryType string
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    ExpireTime int
    Indicates the expiration time of the certificate, in Unix timestamp.
    Source string
    Indicates the location where the certificate is hosted. This parameter has the following values: volccertcenter: Certificate Center. cdncerthosting: Content Delivery Network.
    certId String
    Represents the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    certName String
    Indicates the content of the Common Name (CN) field in the CA certificate.
    certificate GetDomainHttpsCertInfoCertificate
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the CDN.
    effectiveTime Integer
    Indicates the issuance time of the certificate, in Unix timestamp.
    encryType String
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    expireTime Integer
    Indicates the expiration time of the certificate, in Unix timestamp.
    source String
    Indicates the location where the certificate is hosted. This parameter has the following values: volccertcenter: Certificate Center. cdncerthosting: Content Delivery Network.
    certId string
    Represents the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    certName string
    Indicates the content of the Common Name (CN) field in the CA certificate.
    certificate GetDomainHttpsCertInfoCertificate
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the CDN.
    effectiveTime number
    Indicates the issuance time of the certificate, in Unix timestamp.
    encryType string
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    expireTime number
    Indicates the expiration time of the certificate, in Unix timestamp.
    source string
    Indicates the location where the certificate is hosted. This parameter has the following values: volccertcenter: Certificate Center. cdncerthosting: Content Delivery Network.
    cert_id str
    Represents the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    cert_name str
    Indicates the content of the Common Name (CN) field in the CA certificate.
    certificate GetDomainHttpsCertInfoCertificate
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the CDN.
    effective_time int
    Indicates the issuance time of the certificate, in Unix timestamp.
    encry_type str
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    expire_time int
    Indicates the expiration time of the certificate, in Unix timestamp.
    source str
    Indicates the location where the certificate is hosted. This parameter has the following values: volccertcenter: Certificate Center. cdncerthosting: Content Delivery Network.
    certId String
    Represents the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    certName String
    Indicates the content of the Common Name (CN) field in the CA certificate.
    certificate Property Map
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the CDN.
    effectiveTime Number
    Indicates the issuance time of the certificate, in Unix timestamp.
    encryType String
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    expireTime Number
    Indicates the expiration time of the certificate, in Unix timestamp.
    source String
    Indicates the location where the certificate is hosted. This parameter has the following values: volccertcenter: Certificate Center. cdncerthosting: Content Delivery Network.

    GetDomainHttpsCertInfoCertificate

    Certificate string
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    EncryptionCert string
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    EncryptionKey string
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    PrivateKey string
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.
    Certificate string
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    EncryptionCert string
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    EncryptionKey string
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    PrivateKey string
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.
    certificate String
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    encryptionCert String
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    encryptionKey String
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    privateKey String
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.
    certificate string
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    encryptionCert string
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    encryptionKey string
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    privateKey string
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.
    certificate str
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    encryption_cert str
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    encryption_key str
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    private_key str
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.
    certificate String
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    encryptionCert String
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    encryptionKey String
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    privateKey String
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.

    GetDomainHttpsCertInfoList

    CertId string
    Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    CertName string
    Represents the content of the Common Name (CN) field in the CA certificate.
    Certificate Byteplus.GetDomainHttpsCertInfoListCertificate
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.
    EffectiveTime int
    Indicates the issuance time of the certificate, in Unix timestamp.
    EncryType string
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    ExpireTime int
    Indicates the expiration time of the certificate, as a Unix timestamp.
    Source string
    Specifies the certificate hosting location. The parameter values are: volccertcenter: certificate center; cdncerthosting: content delivery network.
    CertId string
    Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    CertName string
    Represents the content of the Common Name (CN) field in the CA certificate.
    Certificate GetDomainHttpsCertInfoListCertificate
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.
    EffectiveTime int
    Indicates the issuance time of the certificate, in Unix timestamp.
    EncryType string
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    ExpireTime int
    Indicates the expiration time of the certificate, as a Unix timestamp.
    Source string
    Specifies the certificate hosting location. The parameter values are: volccertcenter: certificate center; cdncerthosting: content delivery network.
    certId String
    Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    certName String
    Represents the content of the Common Name (CN) field in the CA certificate.
    certificate GetDomainHttpsCertInfoListCertificate
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.
    effectiveTime Integer
    Indicates the issuance time of the certificate, in Unix timestamp.
    encryType String
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    expireTime Integer
    Indicates the expiration time of the certificate, as a Unix timestamp.
    source String
    Specifies the certificate hosting location. The parameter values are: volccertcenter: certificate center; cdncerthosting: content delivery network.
    certId string
    Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    certName string
    Represents the content of the Common Name (CN) field in the CA certificate.
    certificate GetDomainHttpsCertInfoListCertificate
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.
    effectiveTime number
    Indicates the issuance time of the certificate, in Unix timestamp.
    encryType string
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    expireTime number
    Indicates the expiration time of the certificate, as a Unix timestamp.
    source string
    Specifies the certificate hosting location. The parameter values are: volccertcenter: certificate center; cdncerthosting: content delivery network.
    cert_id str
    Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    cert_name str
    Represents the content of the Common Name (CN) field in the CA certificate.
    certificate GetDomainHttpsCertInfoListCertificate
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.
    effective_time int
    Indicates the issuance time of the certificate, in Unix timestamp.
    encry_type str
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    expire_time int
    Indicates the expiration time of the certificate, as a Unix timestamp.
    source str
    Specifies the certificate hosting location. The parameter values are: volccertcenter: certificate center; cdncerthosting: content delivery network.
    certId String
    Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
    certName String
    Represents the content of the Common Name (CN) field in the CA certificate.
    certificate Property Map
    Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.
    effectiveTime Number
    Indicates the issuance time of the certificate, in Unix timestamp.
    encryType String
    Indicates the encryption algorithm used by the certificate. The parameter has the following values: intercert: RSA or ECC encryption algorithm. smcert: SM2 encryption algorithm.
    expireTime Number
    Indicates the expiration time of the certificate, as a Unix timestamp.
    source String
    Specifies the certificate hosting location. The parameter values are: volccertcenter: certificate center; cdncerthosting: content delivery network.

    GetDomainHttpsCertInfoListCertificate

    Certificate string
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    EncryptionCert string
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    EncryptionKey string
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    PrivateKey string
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.
    Certificate string
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    EncryptionCert string
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    EncryptionKey string
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    PrivateKey string
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.
    certificate String
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    encryptionCert String
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    encryptionKey String
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    privateKey String
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.
    certificate string
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    encryptionCert string
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    encryptionKey string
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    privateKey string
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.
    certificate str
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    encryption_cert str
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    encryption_key str
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    private_key str
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.
    certificate String
    Indicates the content of the certificate file. Line breaks in the content must be replaced with \r\n. The certificate file extension is .crt or .pem, and the certificate file must include the complete certificate chain.
    encryptionCert String
    Specifies the content of the certificate file for the SM certificate Line breaks in the content must be replaced with \r\n The public key contained in this file is used to encrypt the session key The file extension must be .crt or .pem, and the certificate file must include the complete certificate chain If the certificate to be uploaded is not an SM certificate, this parameter is invalid
    encryptionKey String
    Indicates the content of the private key file for the SM certificate. Line breaks in the content must be replaced with \r\n. This file is used for decryption and has an extension of .key or .pem. The file name is similar to _encrypt.key.
    privateKey String
    Indicates the content of the private key file. Line breaks in the content must be replaced with \r\n. The private key file extension is .key or .pem. If the certificate uses the RSA or ECC encryption algorithm, this file is the private key file for the server certificate you want to upload. The file name is similar to .key. The private key contained in this file is used to verify the server's signature and encrypt session keys. If the certificate uses the SM2 encryption algorithm, this file is the private key file for the national cryptography certificate you want to upload. The file name is similar to _sign.key. The private key contained in this file is used to verify the server's signature. For certificates to be uploaded, this parameter is required.

    GetDomainHttpsForcedRedirect

    EnableForcedRedirect bool
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature. When enabled, the content delivery network redirects HTTP requests to HTTPS requests. false: disables the feature. When disabled, the content delivery network does not redirect HTTP requests to HTTPS requests. To enable this feature, your acceleration domain must have HTTPS enabled.
    StatusCode string
    Indicates the redirect response status code for the CDN when receiving HTTPS requests. The parameter values are: 301: returns status code 301. 302: returns status code 302. The default value is 301.
    EnableForcedRedirect bool
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature. When enabled, the content delivery network redirects HTTP requests to HTTPS requests. false: disables the feature. When disabled, the content delivery network does not redirect HTTP requests to HTTPS requests. To enable this feature, your acceleration domain must have HTTPS enabled.
    StatusCode string
    Indicates the redirect response status code for the CDN when receiving HTTPS requests. The parameter values are: 301: returns status code 301. 302: returns status code 302. The default value is 301.
    enableForcedRedirect Boolean
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature. When enabled, the content delivery network redirects HTTP requests to HTTPS requests. false: disables the feature. When disabled, the content delivery network does not redirect HTTP requests to HTTPS requests. To enable this feature, your acceleration domain must have HTTPS enabled.
    statusCode String
    Indicates the redirect response status code for the CDN when receiving HTTPS requests. The parameter values are: 301: returns status code 301. 302: returns status code 302. The default value is 301.
    enableForcedRedirect boolean
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature. When enabled, the content delivery network redirects HTTP requests to HTTPS requests. false: disables the feature. When disabled, the content delivery network does not redirect HTTP requests to HTTPS requests. To enable this feature, your acceleration domain must have HTTPS enabled.
    statusCode string
    Indicates the redirect response status code for the CDN when receiving HTTPS requests. The parameter values are: 301: returns status code 301. 302: returns status code 302. The default value is 301.
    enable_forced_redirect bool
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature. When enabled, the content delivery network redirects HTTP requests to HTTPS requests. false: disables the feature. When disabled, the content delivery network does not redirect HTTP requests to HTTPS requests. To enable this feature, your acceleration domain must have HTTPS enabled.
    status_code str
    Indicates the redirect response status code for the CDN when receiving HTTPS requests. The parameter values are: 301: returns status code 301. 302: returns status code 302. The default value is 301.
    enableForcedRedirect Boolean
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature. When enabled, the content delivery network redirects HTTP requests to HTTPS requests. false: disables the feature. When disabled, the content delivery network does not redirect HTTP requests to HTTPS requests. To enable this feature, your acceleration domain must have HTTPS enabled.
    statusCode String
    Indicates the redirect response status code for the CDN when receiving HTTPS requests. The parameter values are: 301: returns status code 301. 302: returns status code 302. The default value is 301.

    GetDomainHttpsHsts

    Subdomain string
    Indicates whether the HSTS configuration also applies to subdomains of the accelerated domain. The parameter has the following values: include: applies HSTS configuration to subdomain sites. exclude: does not apply HSTS configuration to subdomain sites. The default value is exclude.
    Switch bool
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.
    Ttl int
    Indicates the cache expiration time for the Strict-Transport-Security response header in the browser, in seconds. If Switch is true, this parameter is required. The value range is 0–31,536,000. 31,536,000 seconds equals 365 days. If the value is 0, it is equivalent to disabling the HSTS setting.
    Subdomain string
    Indicates whether the HSTS configuration also applies to subdomains of the accelerated domain. The parameter has the following values: include: applies HSTS configuration to subdomain sites. exclude: does not apply HSTS configuration to subdomain sites. The default value is exclude.
    Switch bool
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.
    Ttl int
    Indicates the cache expiration time for the Strict-Transport-Security response header in the browser, in seconds. If Switch is true, this parameter is required. The value range is 0–31,536,000. 31,536,000 seconds equals 365 days. If the value is 0, it is equivalent to disabling the HSTS setting.
    subdomain String
    Indicates whether the HSTS configuration also applies to subdomains of the accelerated domain. The parameter has the following values: include: applies HSTS configuration to subdomain sites. exclude: does not apply HSTS configuration to subdomain sites. The default value is exclude.
    switch_ Boolean
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.
    ttl Integer
    Indicates the cache expiration time for the Strict-Transport-Security response header in the browser, in seconds. If Switch is true, this parameter is required. The value range is 0–31,536,000. 31,536,000 seconds equals 365 days. If the value is 0, it is equivalent to disabling the HSTS setting.
    subdomain string
    Indicates whether the HSTS configuration also applies to subdomains of the accelerated domain. The parameter has the following values: include: applies HSTS configuration to subdomain sites. exclude: does not apply HSTS configuration to subdomain sites. The default value is exclude.
    switch boolean
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.
    ttl number
    Indicates the cache expiration time for the Strict-Transport-Security response header in the browser, in seconds. If Switch is true, this parameter is required. The value range is 0–31,536,000. 31,536,000 seconds equals 365 days. If the value is 0, it is equivalent to disabling the HSTS setting.
    subdomain str
    Indicates whether the HSTS configuration also applies to subdomains of the accelerated domain. The parameter has the following values: include: applies HSTS configuration to subdomain sites. exclude: does not apply HSTS configuration to subdomain sites. The default value is exclude.
    switch bool
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.
    ttl int
    Indicates the cache expiration time for the Strict-Transport-Security response header in the browser, in seconds. If Switch is true, this parameter is required. The value range is 0–31,536,000. 31,536,000 seconds equals 365 days. If the value is 0, it is equivalent to disabling the HSTS setting.
    subdomain String
    Indicates whether the HSTS configuration also applies to subdomains of the accelerated domain. The parameter has the following values: include: applies HSTS configuration to subdomain sites. exclude: does not apply HSTS configuration to subdomain sites. The default value is exclude.
    switch Boolean
    Indicates whether to enable this feature. This parameter has the following values: true: enables the feature; false: disables the feature. The default value is false.
    ttl Number
    Indicates the cache expiration time for the Strict-Transport-Security response header in the browser, in seconds. If Switch is true, this parameter is required. The value range is 0–31,536,000. 31,536,000 seconds equals 365 days. If the value is 0, it is equivalent to disabling the HSTS setting.

    GetDomainIPv6

    Switch bool
    Specifies whether to enable IPv6 configuration. This parameter has the following values: true: Enables IPv6. false: Disables IPv6.
    Switch bool
    Specifies whether to enable IPv6 configuration. This parameter has the following values: true: Enables IPv6. false: Disables IPv6.
    switch_ Boolean
    Specifies whether to enable IPv6 configuration. This parameter has the following values: true: Enables IPv6. false: Disables IPv6.
    switch boolean
    Specifies whether to enable IPv6 configuration. This parameter has the following values: true: Enables IPv6. false: Disables IPv6.
    switch bool
    Specifies whether to enable IPv6 configuration. This parameter has the following values: true: Enables IPv6. false: Disables IPv6.
    switch Boolean
    Specifies whether to enable IPv6 configuration. This parameter has the following values: true: Enables IPv6. false: Disables IPv6.

    GetDomainIpAccessRule

    Ips List<string>
    Specifies IP addresses in the denylist or allowlist. This parameter is required when Switch is true. You can specify one or more IP addresses and IP address ranges. IP addresses and ranges can be in IPv4 or IPv6 format. You can enter up to 1,000 addresses. If you specify SharedConfig, you cannot specify this parameter.
    RuleType string
    Indicates the type of IP list. This parameter is required when Switch is true. Valid values are: allow: indicates Allowlist. deny: indicates Denylist. If you specify SharedConfig, you cannot specify this parameter.
    SharedConfig Byteplus.GetDomainIpAccessRuleSharedConfig
    Represents a global configuration. If you specify this parameter, you cannot specify RuleType and Ip.
    Switch bool
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    Ips []string
    Specifies IP addresses in the denylist or allowlist. This parameter is required when Switch is true. You can specify one or more IP addresses and IP address ranges. IP addresses and ranges can be in IPv4 or IPv6 format. You can enter up to 1,000 addresses. If you specify SharedConfig, you cannot specify this parameter.
    RuleType string
    Indicates the type of IP list. This parameter is required when Switch is true. Valid values are: allow: indicates Allowlist. deny: indicates Denylist. If you specify SharedConfig, you cannot specify this parameter.
    SharedConfig GetDomainIpAccessRuleSharedConfig
    Represents a global configuration. If you specify this parameter, you cannot specify RuleType and Ip.
    Switch bool
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    ips List<String>
    Specifies IP addresses in the denylist or allowlist. This parameter is required when Switch is true. You can specify one or more IP addresses and IP address ranges. IP addresses and ranges can be in IPv4 or IPv6 format. You can enter up to 1,000 addresses. If you specify SharedConfig, you cannot specify this parameter.
    ruleType String
    Indicates the type of IP list. This parameter is required when Switch is true. Valid values are: allow: indicates Allowlist. deny: indicates Denylist. If you specify SharedConfig, you cannot specify this parameter.
    sharedConfig GetDomainIpAccessRuleSharedConfig
    Represents a global configuration. If you specify this parameter, you cannot specify RuleType and Ip.
    switch_ Boolean
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    ips string[]
    Specifies IP addresses in the denylist or allowlist. This parameter is required when Switch is true. You can specify one or more IP addresses and IP address ranges. IP addresses and ranges can be in IPv4 or IPv6 format. You can enter up to 1,000 addresses. If you specify SharedConfig, you cannot specify this parameter.
    ruleType string
    Indicates the type of IP list. This parameter is required when Switch is true. Valid values are: allow: indicates Allowlist. deny: indicates Denylist. If you specify SharedConfig, you cannot specify this parameter.
    sharedConfig GetDomainIpAccessRuleSharedConfig
    Represents a global configuration. If you specify this parameter, you cannot specify RuleType and Ip.
    switch boolean
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    ips Sequence[str]
    Specifies IP addresses in the denylist or allowlist. This parameter is required when Switch is true. You can specify one or more IP addresses and IP address ranges. IP addresses and ranges can be in IPv4 or IPv6 format. You can enter up to 1,000 addresses. If you specify SharedConfig, you cannot specify this parameter.
    rule_type str
    Indicates the type of IP list. This parameter is required when Switch is true. Valid values are: allow: indicates Allowlist. deny: indicates Denylist. If you specify SharedConfig, you cannot specify this parameter.
    shared_config GetDomainIpAccessRuleSharedConfig
    Represents a global configuration. If you specify this parameter, you cannot specify RuleType and Ip.
    switch bool
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    ips List<String>
    Specifies IP addresses in the denylist or allowlist. This parameter is required when Switch is true. You can specify one or more IP addresses and IP address ranges. IP addresses and ranges can be in IPv4 or IPv6 format. You can enter up to 1,000 addresses. If you specify SharedConfig, you cannot specify this parameter.
    ruleType String
    Indicates the type of IP list. This parameter is required when Switch is true. Valid values are: allow: indicates Allowlist. deny: indicates Denylist. If you specify SharedConfig, you cannot specify this parameter.
    sharedConfig Property Map
    Represents a global configuration. If you specify this parameter, you cannot specify RuleType and Ip.
    switch Boolean
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.

    GetDomainIpAccessRuleSharedConfig

    ConfigName string
    Indicates the name of a global configuration.
    ConfigName string
    Indicates the name of a global configuration.
    configName String
    Indicates the name of a global configuration.
    configName string
    Indicates the name of a global configuration.
    config_name str
    Indicates the name of a global configuration.
    configName String
    Indicates the name of a global configuration.

    GetDomainMethodDeniedRule

    Methods string
    Indicates one or more HTTP request methods that are disabled. When Switch is true, this parameter is required. Use commas (,) to separate multiple methods. The parameter values are: get: disables the GET request method. post: disables the POST request method. delete: disables the DELETE request method. put: disables the PUT request method. head: disables the HEAD request method. patch: disables the PATCH request method. connect: disables the CONNECT request method. options: disables the OPTIONS request method.
    Switch bool
    Configuration switch for disabling methods. Use commas to separate multiple methods. Required when enabled. choices: [get, post, head, delete, put]
    Methods string
    Indicates one or more HTTP request methods that are disabled. When Switch is true, this parameter is required. Use commas (,) to separate multiple methods. The parameter values are: get: disables the GET request method. post: disables the POST request method. delete: disables the DELETE request method. put: disables the PUT request method. head: disables the HEAD request method. patch: disables the PATCH request method. connect: disables the CONNECT request method. options: disables the OPTIONS request method.
    Switch bool
    Configuration switch for disabling methods. Use commas to separate multiple methods. Required when enabled. choices: [get, post, head, delete, put]
    methods String
    Indicates one or more HTTP request methods that are disabled. When Switch is true, this parameter is required. Use commas (,) to separate multiple methods. The parameter values are: get: disables the GET request method. post: disables the POST request method. delete: disables the DELETE request method. put: disables the PUT request method. head: disables the HEAD request method. patch: disables the PATCH request method. connect: disables the CONNECT request method. options: disables the OPTIONS request method.
    switch_ Boolean
    Configuration switch for disabling methods. Use commas to separate multiple methods. Required when enabled. choices: [get, post, head, delete, put]
    methods string
    Indicates one or more HTTP request methods that are disabled. When Switch is true, this parameter is required. Use commas (,) to separate multiple methods. The parameter values are: get: disables the GET request method. post: disables the POST request method. delete: disables the DELETE request method. put: disables the PUT request method. head: disables the HEAD request method. patch: disables the PATCH request method. connect: disables the CONNECT request method. options: disables the OPTIONS request method.
    switch boolean
    Configuration switch for disabling methods. Use commas to separate multiple methods. Required when enabled. choices: [get, post, head, delete, put]
    methods str
    Indicates one or more HTTP request methods that are disabled. When Switch is true, this parameter is required. Use commas (,) to separate multiple methods. The parameter values are: get: disables the GET request method. post: disables the POST request method. delete: disables the DELETE request method. put: disables the PUT request method. head: disables the HEAD request method. patch: disables the PATCH request method. connect: disables the CONNECT request method. options: disables the OPTIONS request method.
    switch bool
    Configuration switch for disabling methods. Use commas to separate multiple methods. Required when enabled. choices: [get, post, head, delete, put]
    methods String
    Indicates one or more HTTP request methods that are disabled. When Switch is true, this parameter is required. Use commas (,) to separate multiple methods. The parameter values are: get: disables the GET request method. post: disables the POST request method. delete: disables the DELETE request method. put: disables the PUT request method. head: disables the HEAD request method. patch: disables the PATCH request method. connect: disables the CONNECT request method. options: disables the OPTIONS request method.
    switch Boolean
    Configuration switch for disabling methods. Use commas to separate multiple methods. Required when enabled. choices: [get, post, head, delete, put]

    GetDomainMultiRange

    Switch bool
    Indicates whether the feature is enabled. This parameter has the following values: true: enables the feature. When enabled, CDN allows Range requests with multiple ranges. false: disables the feature. If a Range request with multiple ranges is received, CDN rejects the request and returns a 416 response status code. The default value is false.
    Switch bool
    Indicates whether the feature is enabled. This parameter has the following values: true: enables the feature. When enabled, CDN allows Range requests with multiple ranges. false: disables the feature. If a Range request with multiple ranges is received, CDN rejects the request and returns a 416 response status code. The default value is false.
    switch_ Boolean
    Indicates whether the feature is enabled. This parameter has the following values: true: enables the feature. When enabled, CDN allows Range requests with multiple ranges. false: disables the feature. If a Range request with multiple ranges is received, CDN rejects the request and returns a 416 response status code. The default value is false.
    switch boolean
    Indicates whether the feature is enabled. This parameter has the following values: true: enables the feature. When enabled, CDN allows Range requests with multiple ranges. false: disables the feature. If a Range request with multiple ranges is received, CDN rejects the request and returns a 416 response status code. The default value is false.
    switch bool
    Indicates whether the feature is enabled. This parameter has the following values: true: enables the feature. When enabled, CDN allows Range requests with multiple ranges. false: disables the feature. If a Range request with multiple ranges is received, CDN rejects the request and returns a 416 response status code. The default value is false.
    switch Boolean
    Indicates whether the feature is enabled. This parameter has the following values: true: enables the feature. When enabled, CDN allows Range requests with multiple ranges. false: disables the feature. If a Range request with multiple ranges is received, CDN rejects the request and returns a 416 response status code. The default value is false.

    GetDomainNegativeCach

    Condition Byteplus.GetDomainNegativeCachCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    NegativeCacheRule Byteplus.GetDomainNegativeCachNegativeCacheRule
    Represents a list. Each element in the list is a status code cache rule.
    Condition GetDomainNegativeCachCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    NegativeCacheRule GetDomainNegativeCachNegativeCacheRule
    Represents a list. Each element in the list is a status code cache rule.
    condition GetDomainNegativeCachCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    negativeCacheRule GetDomainNegativeCachNegativeCacheRule
    Represents a list. Each element in the list is a status code cache rule.
    condition GetDomainNegativeCachCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    negativeCacheRule GetDomainNegativeCachNegativeCacheRule
    Represents a list. Each element in the list is a status code cache rule.
    condition GetDomainNegativeCachCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    negative_cache_rule GetDomainNegativeCachNegativeCacheRule
    Represents a list. Each element in the list is a status code cache rule.
    condition Property Map
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    negativeCacheRule Property Map
    Represents a list. Each element in the list is a status code cache rule.

    GetDomainNegativeCachCondition

    ConditionRules List<Byteplus.GetDomainNegativeCachConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainNegativeCachConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainNegativeCachConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainNegativeCachConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainNegativeCachConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainNegativeCachConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainNegativeCachNegativeCacheRule

    Action string
    Represents the cache behavior. Currently, you can only specify cache. cache means the behavior is caching.
    IgnoreCase bool
    Indicates whether the CDN ignores case when matching files in a request with ConditionRule. The parameter has the following options: true: ignore case. false: do not ignore case. The default value is false.
    StatusCode string
    Specify a status code to cache. The status code range is 400–599. You can also specify 4xx or 5xx. 4xx refers to all status codes from 400 to 499. 5xx refers to all status codes from 500 to 599.
    Ttl int
    Indicates the cache duration for status codes, in seconds. The range is 1–315,360,000. 315,360,000 means 10 years.
    Action string
    Represents the cache behavior. Currently, you can only specify cache. cache means the behavior is caching.
    IgnoreCase bool
    Indicates whether the CDN ignores case when matching files in a request with ConditionRule. The parameter has the following options: true: ignore case. false: do not ignore case. The default value is false.
    StatusCode string
    Specify a status code to cache. The status code range is 400–599. You can also specify 4xx or 5xx. 4xx refers to all status codes from 400 to 499. 5xx refers to all status codes from 500 to 599.
    Ttl int
    Indicates the cache duration for status codes, in seconds. The range is 1–315,360,000. 315,360,000 means 10 years.
    action String
    Represents the cache behavior. Currently, you can only specify cache. cache means the behavior is caching.
    ignoreCase Boolean
    Indicates whether the CDN ignores case when matching files in a request with ConditionRule. The parameter has the following options: true: ignore case. false: do not ignore case. The default value is false.
    statusCode String
    Specify a status code to cache. The status code range is 400–599. You can also specify 4xx or 5xx. 4xx refers to all status codes from 400 to 499. 5xx refers to all status codes from 500 to 599.
    ttl Integer
    Indicates the cache duration for status codes, in seconds. The range is 1–315,360,000. 315,360,000 means 10 years.
    action string
    Represents the cache behavior. Currently, you can only specify cache. cache means the behavior is caching.
    ignoreCase boolean
    Indicates whether the CDN ignores case when matching files in a request with ConditionRule. The parameter has the following options: true: ignore case. false: do not ignore case. The default value is false.
    statusCode string
    Specify a status code to cache. The status code range is 400–599. You can also specify 4xx or 5xx. 4xx refers to all status codes from 400 to 499. 5xx refers to all status codes from 500 to 599.
    ttl number
    Indicates the cache duration for status codes, in seconds. The range is 1–315,360,000. 315,360,000 means 10 years.
    action str
    Represents the cache behavior. Currently, you can only specify cache. cache means the behavior is caching.
    ignore_case bool
    Indicates whether the CDN ignores case when matching files in a request with ConditionRule. The parameter has the following options: true: ignore case. false: do not ignore case. The default value is false.
    status_code str
    Specify a status code to cache. The status code range is 400–599. You can also specify 4xx or 5xx. 4xx refers to all status codes from 400 to 499. 5xx refers to all status codes from 500 to 599.
    ttl int
    Indicates the cache duration for status codes, in seconds. The range is 1–315,360,000. 315,360,000 means 10 years.
    action String
    Represents the cache behavior. Currently, you can only specify cache. cache means the behavior is caching.
    ignoreCase Boolean
    Indicates whether the CDN ignores case when matching files in a request with ConditionRule. The parameter has the following options: true: ignore case. false: do not ignore case. The default value is false.
    statusCode String
    Specify a status code to cache. The status code range is 400–599. You can also specify 4xx or 5xx. 4xx refers to all status codes from 400 to 499. 5xx refers to all status codes from 500 to 599.
    ttl Number
    Indicates the cache duration for status codes, in seconds. The range is 1–315,360,000. 315,360,000 means 10 years.

    GetDomainOfflineCache

    Object string
    Indicates the trigger conditions for this feature. The parameter has the following values: requesterror: indicates an origin request exception. When an origin request exception occurs, the CDN cannot retrieve files from the origin and does not receive any response status code from the origin. errorcode: indicates the CDN cannot retrieve files from the origin, and the origin's response status code is 5xx. requesterror,errorcode: indicates both conditions are included.
    StatusCode string
    Specifies the specific 5xx response status codes, ranging from 500 to 599. Separate multiple status codes with a semicolon (;). You can also enter 5xx to indicate any status code starting with the digit 5. This parameter is valid only when Object is errorcode or requesterror,error_code.
    Switch bool
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    Object string
    Indicates the trigger conditions for this feature. The parameter has the following values: requesterror: indicates an origin request exception. When an origin request exception occurs, the CDN cannot retrieve files from the origin and does not receive any response status code from the origin. errorcode: indicates the CDN cannot retrieve files from the origin, and the origin's response status code is 5xx. requesterror,errorcode: indicates both conditions are included.
    StatusCode string
    Specifies the specific 5xx response status codes, ranging from 500 to 599. Separate multiple status codes with a semicolon (;). You can also enter 5xx to indicate any status code starting with the digit 5. This parameter is valid only when Object is errorcode or requesterror,error_code.
    Switch bool
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    object String
    Indicates the trigger conditions for this feature. The parameter has the following values: requesterror: indicates an origin request exception. When an origin request exception occurs, the CDN cannot retrieve files from the origin and does not receive any response status code from the origin. errorcode: indicates the CDN cannot retrieve files from the origin, and the origin's response status code is 5xx. requesterror,errorcode: indicates both conditions are included.
    statusCode String
    Specifies the specific 5xx response status codes, ranging from 500 to 599. Separate multiple status codes with a semicolon (;). You can also enter 5xx to indicate any status code starting with the digit 5. This parameter is valid only when Object is errorcode or requesterror,error_code.
    switch_ Boolean
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    object string
    Indicates the trigger conditions for this feature. The parameter has the following values: requesterror: indicates an origin request exception. When an origin request exception occurs, the CDN cannot retrieve files from the origin and does not receive any response status code from the origin. errorcode: indicates the CDN cannot retrieve files from the origin, and the origin's response status code is 5xx. requesterror,errorcode: indicates both conditions are included.
    statusCode string
    Specifies the specific 5xx response status codes, ranging from 500 to 599. Separate multiple status codes with a semicolon (;). You can also enter 5xx to indicate any status code starting with the digit 5. This parameter is valid only when Object is errorcode or requesterror,error_code.
    switch boolean
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    object str
    Indicates the trigger conditions for this feature. The parameter has the following values: requesterror: indicates an origin request exception. When an origin request exception occurs, the CDN cannot retrieve files from the origin and does not receive any response status code from the origin. errorcode: indicates the CDN cannot retrieve files from the origin, and the origin's response status code is 5xx. requesterror,errorcode: indicates both conditions are included.
    status_code str
    Specifies the specific 5xx response status codes, ranging from 500 to 599. Separate multiple status codes with a semicolon (;). You can also enter 5xx to indicate any status code starting with the digit 5. This parameter is valid only when Object is errorcode or requesterror,error_code.
    switch bool
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    object String
    Indicates the trigger conditions for this feature. The parameter has the following values: requesterror: indicates an origin request exception. When an origin request exception occurs, the CDN cannot retrieve files from the origin and does not receive any response status code from the origin. errorcode: indicates the CDN cannot retrieve files from the origin, and the origin's response status code is 5xx. requesterror,errorcode: indicates both conditions are included.
    statusCode String
    Specifies the specific 5xx response status codes, ranging from 500 to 599. Separate multiple status codes with a semicolon (;). You can also enter 5xx to indicate any status code starting with the digit 5. This parameter is valid only when Object is errorcode or requesterror,error_code.
    switch Boolean
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.

    GetDomainOrigin

    Condition Byteplus.GetDomainOriginCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    OriginAction Byteplus.GetDomainOriginOriginAction
    Indicates origin configuration.
    Condition GetDomainOriginCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    OriginAction GetDomainOriginOriginAction
    Indicates origin configuration.
    condition GetDomainOriginCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    originAction GetDomainOriginOriginAction
    Indicates origin configuration.
    condition GetDomainOriginCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    originAction GetDomainOriginOriginAction
    Indicates origin configuration.
    condition GetDomainOriginCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    origin_action GetDomainOriginOriginAction
    Indicates origin configuration.
    condition Property Map
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    originAction Property Map
    Indicates origin configuration.

    GetDomainOriginAccessRule

    AllowEmpty bool
    Specifies whether requests are allowed when the Origin header in the user request is empty (""). The parameter values are: true: allow; false: do not allow. The default value is false.
    IgnoreCase bool
    Indicates whether Origin is case sensitive. This parameter has the following values: true: Origin is case insensitive; false: Origin is case sensitive. The default value is true.
    Origins List<string>
    The address list corresponding to RuleType. When Switch is true, this parameter is required. You can specify one or more IP addresses, CIDR blocks, domain names, and wildcard domain names. Domain names can be second-level domains. IP addresses can be in IPv4 or IPv6 format. You can enter up to 100 addresses. When entering domain names, you do not need to include http:// or https://. The value length cannot exceed 3,000 characters.
    RuleType string
    Origin list configuration type. When Switch is true, this parameter is required. The parameter has the following values: allow: indicates allowlist. deny: indicates denylist.
    Switch bool
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    AllowEmpty bool
    Specifies whether requests are allowed when the Origin header in the user request is empty (""). The parameter values are: true: allow; false: do not allow. The default value is false.
    IgnoreCase bool
    Indicates whether Origin is case sensitive. This parameter has the following values: true: Origin is case insensitive; false: Origin is case sensitive. The default value is true.
    Origins []string
    The address list corresponding to RuleType. When Switch is true, this parameter is required. You can specify one or more IP addresses, CIDR blocks, domain names, and wildcard domain names. Domain names can be second-level domains. IP addresses can be in IPv4 or IPv6 format. You can enter up to 100 addresses. When entering domain names, you do not need to include http:// or https://. The value length cannot exceed 3,000 characters.
    RuleType string
    Origin list configuration type. When Switch is true, this parameter is required. The parameter has the following values: allow: indicates allowlist. deny: indicates denylist.
    Switch bool
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    allowEmpty Boolean
    Specifies whether requests are allowed when the Origin header in the user request is empty (""). The parameter values are: true: allow; false: do not allow. The default value is false.
    ignoreCase Boolean
    Indicates whether Origin is case sensitive. This parameter has the following values: true: Origin is case insensitive; false: Origin is case sensitive. The default value is true.
    origins List<String>
    The address list corresponding to RuleType. When Switch is true, this parameter is required. You can specify one or more IP addresses, CIDR blocks, domain names, and wildcard domain names. Domain names can be second-level domains. IP addresses can be in IPv4 or IPv6 format. You can enter up to 100 addresses. When entering domain names, you do not need to include http:// or https://. The value length cannot exceed 3,000 characters.
    ruleType String
    Origin list configuration type. When Switch is true, this parameter is required. The parameter has the following values: allow: indicates allowlist. deny: indicates denylist.
    switch_ Boolean
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    allowEmpty boolean
    Specifies whether requests are allowed when the Origin header in the user request is empty (""). The parameter values are: true: allow; false: do not allow. The default value is false.
    ignoreCase boolean
    Indicates whether Origin is case sensitive. This parameter has the following values: true: Origin is case insensitive; false: Origin is case sensitive. The default value is true.
    origins string[]
    The address list corresponding to RuleType. When Switch is true, this parameter is required. You can specify one or more IP addresses, CIDR blocks, domain names, and wildcard domain names. Domain names can be second-level domains. IP addresses can be in IPv4 or IPv6 format. You can enter up to 100 addresses. When entering domain names, you do not need to include http:// or https://. The value length cannot exceed 3,000 characters.
    ruleType string
    Origin list configuration type. When Switch is true, this parameter is required. The parameter has the following values: allow: indicates allowlist. deny: indicates denylist.
    switch boolean
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    allow_empty bool
    Specifies whether requests are allowed when the Origin header in the user request is empty (""). The parameter values are: true: allow; false: do not allow. The default value is false.
    ignore_case bool
    Indicates whether Origin is case sensitive. This parameter has the following values: true: Origin is case insensitive; false: Origin is case sensitive. The default value is true.
    origins Sequence[str]
    The address list corresponding to RuleType. When Switch is true, this parameter is required. You can specify one or more IP addresses, CIDR blocks, domain names, and wildcard domain names. Domain names can be second-level domains. IP addresses can be in IPv4 or IPv6 format. You can enter up to 100 addresses. When entering domain names, you do not need to include http:// or https://. The value length cannot exceed 3,000 characters.
    rule_type str
    Origin list configuration type. When Switch is true, this parameter is required. The parameter has the following values: allow: indicates allowlist. deny: indicates denylist.
    switch bool
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    allowEmpty Boolean
    Specifies whether requests are allowed when the Origin header in the user request is empty (""). The parameter values are: true: allow; false: do not allow. The default value is false.
    ignoreCase Boolean
    Indicates whether Origin is case sensitive. This parameter has the following values: true: Origin is case insensitive; false: Origin is case sensitive. The default value is true.
    origins List<String>
    The address list corresponding to RuleType. When Switch is true, this parameter is required. You can specify one or more IP addresses, CIDR blocks, domain names, and wildcard domain names. Domain names can be second-level domains. IP addresses can be in IPv4 or IPv6 format. You can enter up to 100 addresses. When entering domain names, you do not need to include http:// or https://. The value length cannot exceed 3,000 characters.
    ruleType String
    Origin list configuration type. When Switch is true, this parameter is required. The parameter has the following values: allow: indicates allowlist. deny: indicates denylist.
    switch Boolean
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.

    GetDomainOriginArg

    Condition Byteplus.GetDomainOriginArgCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    OriginArgAction Byteplus.GetDomainOriginArgOriginArgAction
    Represents the action performed when the Condition is met.
    Condition GetDomainOriginArgCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    OriginArgAction GetDomainOriginArgOriginArgAction
    Represents the action performed when the Condition is met.
    condition GetDomainOriginArgCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    originArgAction GetDomainOriginArgOriginArgAction
    Represents the action performed when the Condition is met.
    condition GetDomainOriginArgCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    originArgAction GetDomainOriginArgOriginArgAction
    Represents the action performed when the Condition is met.
    condition GetDomainOriginArgCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    origin_arg_action GetDomainOriginArgOriginArgAction
    Represents the action performed when the Condition is met.
    condition Property Map
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    originArgAction Property Map
    Represents the action performed when the Condition is met.

    GetDomainOriginArgCondition

    ConditionRules List<Byteplus.GetDomainOriginArgConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainOriginArgConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainOriginArgConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainOriginArgConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainOriginArgConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainOriginArgConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainOriginArgOriginArgAction

    OriginArgComponents List<Byteplus.GetDomainOriginArgOriginArgActionOriginArgComponent>
    Indicates a list of operations. These operations define how the CDN sets query parameters in origin requests. Currently, only one operation can be included in the list.
    OriginArgComponents []GetDomainOriginArgOriginArgActionOriginArgComponent
    Indicates a list of operations. These operations define how the CDN sets query parameters in origin requests. Currently, only one operation can be included in the list.
    originArgComponents List<GetDomainOriginArgOriginArgActionOriginArgComponent>
    Indicates a list of operations. These operations define how the CDN sets query parameters in origin requests. Currently, only one operation can be included in the list.
    originArgComponents GetDomainOriginArgOriginArgActionOriginArgComponent[]
    Indicates a list of operations. These operations define how the CDN sets query parameters in origin requests. Currently, only one operation can be included in the list.
    origin_arg_components Sequence[GetDomainOriginArgOriginArgActionOriginArgComponent]
    Indicates a list of operations. These operations define how the CDN sets query parameters in origin requests. Currently, only one operation can be included in the list.
    originArgComponents List<Property Map>
    Indicates a list of operations. These operations define how the CDN sets query parameters in origin requests. Currently, only one operation can be included in the list.

    GetDomainOriginArgOriginArgActionOriginArgComponent

    Action string
    include: Indicates that the origin request URL includes all query parameters from the user request URL. exclude: Indicates that the origin request URL does not include any query parameters from the user request URL. addPart: Indicates that the origin request URL includes all query parameters from the user request URL, plus the query parameters specified in the Subobject. includePart: Indicates that if the user request URL contains the query parameters specified in the Subobject, the origin request URL will include these specified query parameters. excludePart: Indicates that the origin request URL includes all query parameters from the user request URL except those specified in the Subobject. set: Indicates that the origin request URL includes all query parameters from the user request URL. For the query parameters and values you specify in the Subobject, CDN will perform the following actions: If these query parameters exist in the user request URL, CDN will set their values in the origin request URL to the values you specify. If the user request URL does not contain these query parameters, CDN will add them to the origin request URL.
    Object string
    Indicates which object the CDN performs the Action on. Currently, this parameter can only be set to queryString, which refers to the query string in the request URL.
    Subobject string
    Represents one or more query parameters. Use semicolons (;) to separate multiple query parameters. The total length must not exceed 1,024 characters. Subobject can only contain letters, numbers, underscores (_), commas (,), hyphens (-), periods (.), and exclamation marks (!). When matching query parameters in the request URL, parameters in Subobject are case-sensitive. Additional notes for Subobject: When Action is include or exclude, Subobject must be *, which represents all query parameters in the request URL. When Action is includePart or excludePart, Subobject represents one or more query parameters, for example, param1;param2. When Action is addPart or set, Subobject represents one or more query parameters and their values in the format key=value, for example, param1=val1;param2=val2;param3=val3.
    Action string
    include: Indicates that the origin request URL includes all query parameters from the user request URL. exclude: Indicates that the origin request URL does not include any query parameters from the user request URL. addPart: Indicates that the origin request URL includes all query parameters from the user request URL, plus the query parameters specified in the Subobject. includePart: Indicates that if the user request URL contains the query parameters specified in the Subobject, the origin request URL will include these specified query parameters. excludePart: Indicates that the origin request URL includes all query parameters from the user request URL except those specified in the Subobject. set: Indicates that the origin request URL includes all query parameters from the user request URL. For the query parameters and values you specify in the Subobject, CDN will perform the following actions: If these query parameters exist in the user request URL, CDN will set their values in the origin request URL to the values you specify. If the user request URL does not contain these query parameters, CDN will add them to the origin request URL.
    Object string
    Indicates which object the CDN performs the Action on. Currently, this parameter can only be set to queryString, which refers to the query string in the request URL.
    Subobject string
    Represents one or more query parameters. Use semicolons (;) to separate multiple query parameters. The total length must not exceed 1,024 characters. Subobject can only contain letters, numbers, underscores (_), commas (,), hyphens (-), periods (.), and exclamation marks (!). When matching query parameters in the request URL, parameters in Subobject are case-sensitive. Additional notes for Subobject: When Action is include or exclude, Subobject must be *, which represents all query parameters in the request URL. When Action is includePart or excludePart, Subobject represents one or more query parameters, for example, param1;param2. When Action is addPart or set, Subobject represents one or more query parameters and their values in the format key=value, for example, param1=val1;param2=val2;param3=val3.
    action String
    include: Indicates that the origin request URL includes all query parameters from the user request URL. exclude: Indicates that the origin request URL does not include any query parameters from the user request URL. addPart: Indicates that the origin request URL includes all query parameters from the user request URL, plus the query parameters specified in the Subobject. includePart: Indicates that if the user request URL contains the query parameters specified in the Subobject, the origin request URL will include these specified query parameters. excludePart: Indicates that the origin request URL includes all query parameters from the user request URL except those specified in the Subobject. set: Indicates that the origin request URL includes all query parameters from the user request URL. For the query parameters and values you specify in the Subobject, CDN will perform the following actions: If these query parameters exist in the user request URL, CDN will set their values in the origin request URL to the values you specify. If the user request URL does not contain these query parameters, CDN will add them to the origin request URL.
    object String
    Indicates which object the CDN performs the Action on. Currently, this parameter can only be set to queryString, which refers to the query string in the request URL.
    subobject String
    Represents one or more query parameters. Use semicolons (;) to separate multiple query parameters. The total length must not exceed 1,024 characters. Subobject can only contain letters, numbers, underscores (_), commas (,), hyphens (-), periods (.), and exclamation marks (!). When matching query parameters in the request URL, parameters in Subobject are case-sensitive. Additional notes for Subobject: When Action is include or exclude, Subobject must be *, which represents all query parameters in the request URL. When Action is includePart or excludePart, Subobject represents one or more query parameters, for example, param1;param2. When Action is addPart or set, Subobject represents one or more query parameters and their values in the format key=value, for example, param1=val1;param2=val2;param3=val3.
    action string
    include: Indicates that the origin request URL includes all query parameters from the user request URL. exclude: Indicates that the origin request URL does not include any query parameters from the user request URL. addPart: Indicates that the origin request URL includes all query parameters from the user request URL, plus the query parameters specified in the Subobject. includePart: Indicates that if the user request URL contains the query parameters specified in the Subobject, the origin request URL will include these specified query parameters. excludePart: Indicates that the origin request URL includes all query parameters from the user request URL except those specified in the Subobject. set: Indicates that the origin request URL includes all query parameters from the user request URL. For the query parameters and values you specify in the Subobject, CDN will perform the following actions: If these query parameters exist in the user request URL, CDN will set their values in the origin request URL to the values you specify. If the user request URL does not contain these query parameters, CDN will add them to the origin request URL.
    object string
    Indicates which object the CDN performs the Action on. Currently, this parameter can only be set to queryString, which refers to the query string in the request URL.
    subobject string
    Represents one or more query parameters. Use semicolons (;) to separate multiple query parameters. The total length must not exceed 1,024 characters. Subobject can only contain letters, numbers, underscores (_), commas (,), hyphens (-), periods (.), and exclamation marks (!). When matching query parameters in the request URL, parameters in Subobject are case-sensitive. Additional notes for Subobject: When Action is include or exclude, Subobject must be *, which represents all query parameters in the request URL. When Action is includePart or excludePart, Subobject represents one or more query parameters, for example, param1;param2. When Action is addPart or set, Subobject represents one or more query parameters and their values in the format key=value, for example, param1=val1;param2=val2;param3=val3.
    action str
    include: Indicates that the origin request URL includes all query parameters from the user request URL. exclude: Indicates that the origin request URL does not include any query parameters from the user request URL. addPart: Indicates that the origin request URL includes all query parameters from the user request URL, plus the query parameters specified in the Subobject. includePart: Indicates that if the user request URL contains the query parameters specified in the Subobject, the origin request URL will include these specified query parameters. excludePart: Indicates that the origin request URL includes all query parameters from the user request URL except those specified in the Subobject. set: Indicates that the origin request URL includes all query parameters from the user request URL. For the query parameters and values you specify in the Subobject, CDN will perform the following actions: If these query parameters exist in the user request URL, CDN will set their values in the origin request URL to the values you specify. If the user request URL does not contain these query parameters, CDN will add them to the origin request URL.
    object str
    Indicates which object the CDN performs the Action on. Currently, this parameter can only be set to queryString, which refers to the query string in the request URL.
    subobject str
    Represents one or more query parameters. Use semicolons (;) to separate multiple query parameters. The total length must not exceed 1,024 characters. Subobject can only contain letters, numbers, underscores (_), commas (,), hyphens (-), periods (.), and exclamation marks (!). When matching query parameters in the request URL, parameters in Subobject are case-sensitive. Additional notes for Subobject: When Action is include or exclude, Subobject must be *, which represents all query parameters in the request URL. When Action is includePart or excludePart, Subobject represents one or more query parameters, for example, param1;param2. When Action is addPart or set, Subobject represents one or more query parameters and their values in the format key=value, for example, param1=val1;param2=val2;param3=val3.
    action String
    include: Indicates that the origin request URL includes all query parameters from the user request URL. exclude: Indicates that the origin request URL does not include any query parameters from the user request URL. addPart: Indicates that the origin request URL includes all query parameters from the user request URL, plus the query parameters specified in the Subobject. includePart: Indicates that if the user request URL contains the query parameters specified in the Subobject, the origin request URL will include these specified query parameters. excludePart: Indicates that the origin request URL includes all query parameters from the user request URL except those specified in the Subobject. set: Indicates that the origin request URL includes all query parameters from the user request URL. For the query parameters and values you specify in the Subobject, CDN will perform the following actions: If these query parameters exist in the user request URL, CDN will set their values in the origin request URL to the values you specify. If the user request URL does not contain these query parameters, CDN will add them to the origin request URL.
    object String
    Indicates which object the CDN performs the Action on. Currently, this parameter can only be set to queryString, which refers to the query string in the request URL.
    subobject String
    Represents one or more query parameters. Use semicolons (;) to separate multiple query parameters. The total length must not exceed 1,024 characters. Subobject can only contain letters, numbers, underscores (_), commas (,), hyphens (-), periods (.), and exclamation marks (!). When matching query parameters in the request URL, parameters in Subobject are case-sensitive. Additional notes for Subobject: When Action is include or exclude, Subobject must be *, which represents all query parameters in the request URL. When Action is includePart or excludePart, Subobject represents one or more query parameters, for example, param1;param2. When Action is addPart or set, Subobject represents one or more query parameters and their values in the format key=value, for example, param1=val1;param2=val2;param3=val3.

    GetDomainOriginCertCheck

    Switch bool
    Switch
    Switch bool
    Switch
    switch_ Boolean
    Switch
    switch boolean
    Switch
    switch bool
    Switch
    switch Boolean
    Switch

    GetDomainOriginCondition

    ConditionRules List<Byteplus.GetDomainOriginConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainOriginConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainOriginConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainOriginConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainOriginConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainOriginConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainOriginOriginAction

    OriginLines List<Byteplus.GetDomainOriginOriginActionOriginLine>
    Indicates a list of origin configurations. Each configuration can include one or more origins.
    OriginLines []GetDomainOriginOriginActionOriginLine
    Indicates a list of origin configurations. Each configuration can include one or more origins.
    originLines List<GetDomainOriginOriginActionOriginLine>
    Indicates a list of origin configurations. Each configuration can include one or more origins.
    originLines GetDomainOriginOriginActionOriginLine[]
    Indicates a list of origin configurations. Each configuration can include one or more origins.
    origin_lines Sequence[GetDomainOriginOriginActionOriginLine]
    Indicates a list of origin configurations. Each configuration can include one or more origins.
    originLines List<Property Map>
    Indicates a list of origin configurations. Each configuration can include one or more origins.

    GetDomainOriginOriginActionOriginLine

    Address string
    Indicates the origin address. The parameter has the following instructions: If InstanceType is ip, you can set an IP address. The IP address can be either IPv4 or IPv6. If InstanceType is domain, you can set a domain name. The domain name cannot be a wildcard domain. If InstanceType is tos, you can set the domain name of an object storage bucket. The bucket can be from Alibaba Cloud, Tencent Cloud, or AWS. If you specify multiple origin configurations in this API request: All primary origin configurations must have the same InstanceType. All backup origin configurations must also have the same InstanceType. If the InstanceType in the primary origin configuration is ip or domain, the InstanceType in the backup origin configuration must also be ip or domain. The total number of primary and backup origin addresses cannot exceed 50.
    HttpPort string
    Indicates the port used by the content delivery network to access the origin server via the HTTP protocol. The value range is 1–65535, and the default value is 80. If the origin server does not support access on this port, you can specify the default value. This parameter is only valid when InstanceType is ip or domain.
    HttpsPort string
    Indicates the port used by the content delivery network to access the origin server via HTTPS. The value range is 1-65535, and the default value is 443. If the origin server does not support access on this port, you can specify the default value. This parameter is only valid when InstanceType is ip or domain.
    InstanceType string
    Indicates the type of origin server. This parameter has the following values: ip: The origin server is accessed via IP address. domain: The origin server is accessed via domain name. tos: The origin server is an object storage bucket.
    OriginHost string
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.
    OriginType string
    Indicates the type of origin server. This parameter has the following values: - primary: Primary origin server. - backup: Backup origin server. At least one primary origin server configuration must be included in this API request. Backup origin server configuration is optional.
    PrivateBucketAccess bool
    Indicates whether private read permissions are enabled for the object storage bucket. This parameter is only valid when InstanceType is tos. The parameter values are: true: Enabled. false: Not enabled. The default value is false.
    PrivateBucketAuth Byteplus.GetDomainOriginOriginActionOriginLinePrivateBucketAuth
    Represents the authentication information for the object storage bucket of a third-party cloud provider.
    Region string
    This parameter is not currently available externally. Do not use this parameter.
    Weight string
    Specifies the weight of the origin. Value range is 1–100, default is 1. The higher the weight, the more likely this origin is selected when the content delivery network sends a request to the origin. This parameter is only valid when InstanceType is ip or domain.
    Address string
    Indicates the origin address. The parameter has the following instructions: If InstanceType is ip, you can set an IP address. The IP address can be either IPv4 or IPv6. If InstanceType is domain, you can set a domain name. The domain name cannot be a wildcard domain. If InstanceType is tos, you can set the domain name of an object storage bucket. The bucket can be from Alibaba Cloud, Tencent Cloud, or AWS. If you specify multiple origin configurations in this API request: All primary origin configurations must have the same InstanceType. All backup origin configurations must also have the same InstanceType. If the InstanceType in the primary origin configuration is ip or domain, the InstanceType in the backup origin configuration must also be ip or domain. The total number of primary and backup origin addresses cannot exceed 50.
    HttpPort string
    Indicates the port used by the content delivery network to access the origin server via the HTTP protocol. The value range is 1–65535, and the default value is 80. If the origin server does not support access on this port, you can specify the default value. This parameter is only valid when InstanceType is ip or domain.
    HttpsPort string
    Indicates the port used by the content delivery network to access the origin server via HTTPS. The value range is 1-65535, and the default value is 443. If the origin server does not support access on this port, you can specify the default value. This parameter is only valid when InstanceType is ip or domain.
    InstanceType string
    Indicates the type of origin server. This parameter has the following values: ip: The origin server is accessed via IP address. domain: The origin server is accessed via domain name. tos: The origin server is an object storage bucket.
    OriginHost string
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.
    OriginType string
    Indicates the type of origin server. This parameter has the following values: - primary: Primary origin server. - backup: Backup origin server. At least one primary origin server configuration must be included in this API request. Backup origin server configuration is optional.
    PrivateBucketAccess bool
    Indicates whether private read permissions are enabled for the object storage bucket. This parameter is only valid when InstanceType is tos. The parameter values are: true: Enabled. false: Not enabled. The default value is false.
    PrivateBucketAuth GetDomainOriginOriginActionOriginLinePrivateBucketAuth
    Represents the authentication information for the object storage bucket of a third-party cloud provider.
    Region string
    This parameter is not currently available externally. Do not use this parameter.
    Weight string
    Specifies the weight of the origin. Value range is 1–100, default is 1. The higher the weight, the more likely this origin is selected when the content delivery network sends a request to the origin. This parameter is only valid when InstanceType is ip or domain.
    address String
    Indicates the origin address. The parameter has the following instructions: If InstanceType is ip, you can set an IP address. The IP address can be either IPv4 or IPv6. If InstanceType is domain, you can set a domain name. The domain name cannot be a wildcard domain. If InstanceType is tos, you can set the domain name of an object storage bucket. The bucket can be from Alibaba Cloud, Tencent Cloud, or AWS. If you specify multiple origin configurations in this API request: All primary origin configurations must have the same InstanceType. All backup origin configurations must also have the same InstanceType. If the InstanceType in the primary origin configuration is ip or domain, the InstanceType in the backup origin configuration must also be ip or domain. The total number of primary and backup origin addresses cannot exceed 50.
    httpPort String
    Indicates the port used by the content delivery network to access the origin server via the HTTP protocol. The value range is 1–65535, and the default value is 80. If the origin server does not support access on this port, you can specify the default value. This parameter is only valid when InstanceType is ip or domain.
    httpsPort String
    Indicates the port used by the content delivery network to access the origin server via HTTPS. The value range is 1-65535, and the default value is 443. If the origin server does not support access on this port, you can specify the default value. This parameter is only valid when InstanceType is ip or domain.
    instanceType String
    Indicates the type of origin server. This parameter has the following values: ip: The origin server is accessed via IP address. domain: The origin server is accessed via domain name. tos: The origin server is an object storage bucket.
    originHost String
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.
    originType String
    Indicates the type of origin server. This parameter has the following values: - primary: Primary origin server. - backup: Backup origin server. At least one primary origin server configuration must be included in this API request. Backup origin server configuration is optional.
    privateBucketAccess Boolean
    Indicates whether private read permissions are enabled for the object storage bucket. This parameter is only valid when InstanceType is tos. The parameter values are: true: Enabled. false: Not enabled. The default value is false.
    privateBucketAuth GetDomainOriginOriginActionOriginLinePrivateBucketAuth
    Represents the authentication information for the object storage bucket of a third-party cloud provider.
    region String
    This parameter is not currently available externally. Do not use this parameter.
    weight String
    Specifies the weight of the origin. Value range is 1–100, default is 1. The higher the weight, the more likely this origin is selected when the content delivery network sends a request to the origin. This parameter is only valid when InstanceType is ip or domain.
    address string
    Indicates the origin address. The parameter has the following instructions: If InstanceType is ip, you can set an IP address. The IP address can be either IPv4 or IPv6. If InstanceType is domain, you can set a domain name. The domain name cannot be a wildcard domain. If InstanceType is tos, you can set the domain name of an object storage bucket. The bucket can be from Alibaba Cloud, Tencent Cloud, or AWS. If you specify multiple origin configurations in this API request: All primary origin configurations must have the same InstanceType. All backup origin configurations must also have the same InstanceType. If the InstanceType in the primary origin configuration is ip or domain, the InstanceType in the backup origin configuration must also be ip or domain. The total number of primary and backup origin addresses cannot exceed 50.
    httpPort string
    Indicates the port used by the content delivery network to access the origin server via the HTTP protocol. The value range is 1–65535, and the default value is 80. If the origin server does not support access on this port, you can specify the default value. This parameter is only valid when InstanceType is ip or domain.
    httpsPort string
    Indicates the port used by the content delivery network to access the origin server via HTTPS. The value range is 1-65535, and the default value is 443. If the origin server does not support access on this port, you can specify the default value. This parameter is only valid when InstanceType is ip or domain.
    instanceType string
    Indicates the type of origin server. This parameter has the following values: ip: The origin server is accessed via IP address. domain: The origin server is accessed via domain name. tos: The origin server is an object storage bucket.
    originHost string
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.
    originType string
    Indicates the type of origin server. This parameter has the following values: - primary: Primary origin server. - backup: Backup origin server. At least one primary origin server configuration must be included in this API request. Backup origin server configuration is optional.
    privateBucketAccess boolean
    Indicates whether private read permissions are enabled for the object storage bucket. This parameter is only valid when InstanceType is tos. The parameter values are: true: Enabled. false: Not enabled. The default value is false.
    privateBucketAuth GetDomainOriginOriginActionOriginLinePrivateBucketAuth
    Represents the authentication information for the object storage bucket of a third-party cloud provider.
    region string
    This parameter is not currently available externally. Do not use this parameter.
    weight string
    Specifies the weight of the origin. Value range is 1–100, default is 1. The higher the weight, the more likely this origin is selected when the content delivery network sends a request to the origin. This parameter is only valid when InstanceType is ip or domain.
    address str
    Indicates the origin address. The parameter has the following instructions: If InstanceType is ip, you can set an IP address. The IP address can be either IPv4 or IPv6. If InstanceType is domain, you can set a domain name. The domain name cannot be a wildcard domain. If InstanceType is tos, you can set the domain name of an object storage bucket. The bucket can be from Alibaba Cloud, Tencent Cloud, or AWS. If you specify multiple origin configurations in this API request: All primary origin configurations must have the same InstanceType. All backup origin configurations must also have the same InstanceType. If the InstanceType in the primary origin configuration is ip or domain, the InstanceType in the backup origin configuration must also be ip or domain. The total number of primary and backup origin addresses cannot exceed 50.
    http_port str
    Indicates the port used by the content delivery network to access the origin server via the HTTP protocol. The value range is 1–65535, and the default value is 80. If the origin server does not support access on this port, you can specify the default value. This parameter is only valid when InstanceType is ip or domain.
    https_port str
    Indicates the port used by the content delivery network to access the origin server via HTTPS. The value range is 1-65535, and the default value is 443. If the origin server does not support access on this port, you can specify the default value. This parameter is only valid when InstanceType is ip or domain.
    instance_type str
    Indicates the type of origin server. This parameter has the following values: ip: The origin server is accessed via IP address. domain: The origin server is accessed via domain name. tos: The origin server is an object storage bucket.
    origin_host str
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.
    origin_type str
    Indicates the type of origin server. This parameter has the following values: - primary: Primary origin server. - backup: Backup origin server. At least one primary origin server configuration must be included in this API request. Backup origin server configuration is optional.
    private_bucket_access bool
    Indicates whether private read permissions are enabled for the object storage bucket. This parameter is only valid when InstanceType is tos. The parameter values are: true: Enabled. false: Not enabled. The default value is false.
    private_bucket_auth GetDomainOriginOriginActionOriginLinePrivateBucketAuth
    Represents the authentication information for the object storage bucket of a third-party cloud provider.
    region str
    This parameter is not currently available externally. Do not use this parameter.
    weight str
    Specifies the weight of the origin. Value range is 1–100, default is 1. The higher the weight, the more likely this origin is selected when the content delivery network sends a request to the origin. This parameter is only valid when InstanceType is ip or domain.
    address String
    Indicates the origin address. The parameter has the following instructions: If InstanceType is ip, you can set an IP address. The IP address can be either IPv4 or IPv6. If InstanceType is domain, you can set a domain name. The domain name cannot be a wildcard domain. If InstanceType is tos, you can set the domain name of an object storage bucket. The bucket can be from Alibaba Cloud, Tencent Cloud, or AWS. If you specify multiple origin configurations in this API request: All primary origin configurations must have the same InstanceType. All backup origin configurations must also have the same InstanceType. If the InstanceType in the primary origin configuration is ip or domain, the InstanceType in the backup origin configuration must also be ip or domain. The total number of primary and backup origin addresses cannot exceed 50.
    httpPort String
    Indicates the port used by the content delivery network to access the origin server via the HTTP protocol. The value range is 1–65535, and the default value is 80. If the origin server does not support access on this port, you can specify the default value. This parameter is only valid when InstanceType is ip or domain.
    httpsPort String
    Indicates the port used by the content delivery network to access the origin server via HTTPS. The value range is 1-65535, and the default value is 443. If the origin server does not support access on this port, you can specify the default value. This parameter is only valid when InstanceType is ip or domain.
    instanceType String
    Indicates the type of origin server. This parameter has the following values: ip: The origin server is accessed via IP address. domain: The origin server is accessed via domain name. tos: The origin server is an object storage bucket.
    originHost String
    If there are multiple sites on the origin server, this parameter specifies the domain name accessed by the origin request. This parameter applies to all origin configurations, but has lower priority than the OriginHost parameter in the origin configuration. The default value of this parameter is the same as Domain. If the origin is an object storage bucket, you do not need to specify this parameter. Its default value is the same as the Address in the origin configuration.
    originType String
    Indicates the type of origin server. This parameter has the following values: - primary: Primary origin server. - backup: Backup origin server. At least one primary origin server configuration must be included in this API request. Backup origin server configuration is optional.
    privateBucketAccess Boolean
    Indicates whether private read permissions are enabled for the object storage bucket. This parameter is only valid when InstanceType is tos. The parameter values are: true: Enabled. false: Not enabled. The default value is false.
    privateBucketAuth Property Map
    Represents the authentication information for the object storage bucket of a third-party cloud provider.
    region String
    This parameter is not currently available externally. Do not use this parameter.
    weight String
    Specifies the weight of the origin. Value range is 1–100, default is 1. The higher the weight, the more likely this origin is selected when the content delivery network sends a request to the origin. This parameter is only valid when InstanceType is ip or domain.

    GetDomainOriginOriginActionOriginLinePrivateBucketAuth

    AuthType string
    Indicates the third-party cloud provider where the object storage bucket is located. The parameter values are: cos: Tencent Cloud. oss: Alibaba Cloud. aws: Amazon AWS.
    Switch bool
    Indicates whether the object storage bucket is from a third-party cloud provider. This parameter has the following values: true: the object storage bucket is from a third-party cloud provider. The default value is false
    TosAuthInformation Byteplus.GetDomainOriginOriginActionOriginLinePrivateBucketAuthTosAuthInformation
    Specifies the access key for the third-party cloud provider. This parameter is only valid when Switch is true.
    AuthType string
    Indicates the third-party cloud provider where the object storage bucket is located. The parameter values are: cos: Tencent Cloud. oss: Alibaba Cloud. aws: Amazon AWS.
    Switch bool
    Indicates whether the object storage bucket is from a third-party cloud provider. This parameter has the following values: true: the object storage bucket is from a third-party cloud provider. The default value is false
    TosAuthInformation GetDomainOriginOriginActionOriginLinePrivateBucketAuthTosAuthInformation
    Specifies the access key for the third-party cloud provider. This parameter is only valid when Switch is true.
    authType String
    Indicates the third-party cloud provider where the object storage bucket is located. The parameter values are: cos: Tencent Cloud. oss: Alibaba Cloud. aws: Amazon AWS.
    switch_ Boolean
    Indicates whether the object storage bucket is from a third-party cloud provider. This parameter has the following values: true: the object storage bucket is from a third-party cloud provider. The default value is false
    tosAuthInformation GetDomainOriginOriginActionOriginLinePrivateBucketAuthTosAuthInformation
    Specifies the access key for the third-party cloud provider. This parameter is only valid when Switch is true.
    authType string
    Indicates the third-party cloud provider where the object storage bucket is located. The parameter values are: cos: Tencent Cloud. oss: Alibaba Cloud. aws: Amazon AWS.
    switch boolean
    Indicates whether the object storage bucket is from a third-party cloud provider. This parameter has the following values: true: the object storage bucket is from a third-party cloud provider. The default value is false
    tosAuthInformation GetDomainOriginOriginActionOriginLinePrivateBucketAuthTosAuthInformation
    Specifies the access key for the third-party cloud provider. This parameter is only valid when Switch is true.
    auth_type str
    Indicates the third-party cloud provider where the object storage bucket is located. The parameter values are: cos: Tencent Cloud. oss: Alibaba Cloud. aws: Amazon AWS.
    switch bool
    Indicates whether the object storage bucket is from a third-party cloud provider. This parameter has the following values: true: the object storage bucket is from a third-party cloud provider. The default value is false
    tos_auth_information GetDomainOriginOriginActionOriginLinePrivateBucketAuthTosAuthInformation
    Specifies the access key for the third-party cloud provider. This parameter is only valid when Switch is true.
    authType String
    Indicates the third-party cloud provider where the object storage bucket is located. The parameter values are: cos: Tencent Cloud. oss: Alibaba Cloud. aws: Amazon AWS.
    switch Boolean
    Indicates whether the object storage bucket is from a third-party cloud provider. This parameter has the following values: true: the object storage bucket is from a third-party cloud provider. The default value is false
    tosAuthInformation Property Map
    Specifies the access key for the third-party cloud provider. This parameter is only valid when Switch is true.

    GetDomainOriginOriginActionOriginLinePrivateBucketAuthTosAuthInformation

    AccessKeyId string
    Specifies the AccessKey ID for your Alibaba Cloud account, SecretId for your Tencent Cloud account, or access key ID for your AWS account.
    AccessKeySecret string
    Indicates the AccessKey Secret for your Alibaba Cloud account, the SecretKey for your Tencent Cloud account, or the secret access key for your AWS account.
    AccessKeyId string
    Specifies the AccessKey ID for your Alibaba Cloud account, SecretId for your Tencent Cloud account, or access key ID for your AWS account.
    AccessKeySecret string
    Indicates the AccessKey Secret for your Alibaba Cloud account, the SecretKey for your Tencent Cloud account, or the secret access key for your AWS account.
    accessKeyId String
    Specifies the AccessKey ID for your Alibaba Cloud account, SecretId for your Tencent Cloud account, or access key ID for your AWS account.
    accessKeySecret String
    Indicates the AccessKey Secret for your Alibaba Cloud account, the SecretKey for your Tencent Cloud account, or the secret access key for your AWS account.
    accessKeyId string
    Specifies the AccessKey ID for your Alibaba Cloud account, SecretId for your Tencent Cloud account, or access key ID for your AWS account.
    accessKeySecret string
    Indicates the AccessKey Secret for your Alibaba Cloud account, the SecretKey for your Tencent Cloud account, or the secret access key for your AWS account.
    access_key_id str
    Specifies the AccessKey ID for your Alibaba Cloud account, SecretId for your Tencent Cloud account, or access key ID for your AWS account.
    access_key_secret str
    Indicates the AccessKey Secret for your Alibaba Cloud account, the SecretKey for your Tencent Cloud account, or the secret access key for your AWS account.
    accessKeyId String
    Specifies the AccessKey ID for your Alibaba Cloud account, SecretId for your Tencent Cloud account, or access key ID for your AWS account.
    accessKeySecret String
    Indicates the AccessKey Secret for your Alibaba Cloud account, the SecretKey for your Tencent Cloud account, or the secret access key for your AWS account.

    GetDomainOriginRetry

    StatusCode string
    Indicates one or more status codes in the range 400–599. Separate multiple status codes with a semicolon (;). You can enter 4xx or 5xx to represent all status codes starting with the digit 4 or 5.
    Switch bool
    Indicates whether this feature is enabled. The parameter values are: true: Enabled. false: Disabled. The default value is false.
    StatusCode string
    Indicates one or more status codes in the range 400–599. Separate multiple status codes with a semicolon (;). You can enter 4xx or 5xx to represent all status codes starting with the digit 4 or 5.
    Switch bool
    Indicates whether this feature is enabled. The parameter values are: true: Enabled. false: Disabled. The default value is false.
    statusCode String
    Indicates one or more status codes in the range 400–599. Separate multiple status codes with a semicolon (;). You can enter 4xx or 5xx to represent all status codes starting with the digit 4 or 5.
    switch_ Boolean
    Indicates whether this feature is enabled. The parameter values are: true: Enabled. false: Disabled. The default value is false.
    statusCode string
    Indicates one or more status codes in the range 400–599. Separate multiple status codes with a semicolon (;). You can enter 4xx or 5xx to represent all status codes starting with the digit 4 or 5.
    switch boolean
    Indicates whether this feature is enabled. The parameter values are: true: Enabled. false: Disabled. The default value is false.
    status_code str
    Indicates one or more status codes in the range 400–599. Separate multiple status codes with a semicolon (;). You can enter 4xx or 5xx to represent all status codes starting with the digit 4 or 5.
    switch bool
    Indicates whether this feature is enabled. The parameter values are: true: Enabled. false: Disabled. The default value is false.
    statusCode String
    Indicates one or more status codes in the range 400–599. Separate multiple status codes with a semicolon (;). You can enter 4xx or 5xx to represent all status codes starting with the digit 4 or 5.
    switch Boolean
    Indicates whether this feature is enabled. The parameter values are: true: Enabled. false: Disabled. The default value is false.

    GetDomainOriginRewrite

    OriginRewriteRules List<Byteplus.GetDomainOriginRewriteOriginRewriteRule>
    Represents a list of rules. This parameter is required when Switch is true. The list can contain up to 50 rules. The order of rules in the list defines their priority, with the first rule having the highest priority. The SourcePath in each rule specifies the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope. When a user request is received, the CDN matches the request against the rules in order of priority, from highest to lowest. If the request matches a rule, the CDN stops processing the remaining rules.
    Switch bool
    Indicates whether to enable this module. The parameter has the following values: true: enables the module. false: disables the module. The default value is false.
    OriginRewriteRules []GetDomainOriginRewriteOriginRewriteRule
    Represents a list of rules. This parameter is required when Switch is true. The list can contain up to 50 rules. The order of rules in the list defines their priority, with the first rule having the highest priority. The SourcePath in each rule specifies the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope. When a user request is received, the CDN matches the request against the rules in order of priority, from highest to lowest. If the request matches a rule, the CDN stops processing the remaining rules.
    Switch bool
    Indicates whether to enable this module. The parameter has the following values: true: enables the module. false: disables the module. The default value is false.
    originRewriteRules List<GetDomainOriginRewriteOriginRewriteRule>
    Represents a list of rules. This parameter is required when Switch is true. The list can contain up to 50 rules. The order of rules in the list defines their priority, with the first rule having the highest priority. The SourcePath in each rule specifies the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope. When a user request is received, the CDN matches the request against the rules in order of priority, from highest to lowest. If the request matches a rule, the CDN stops processing the remaining rules.
    switch_ Boolean
    Indicates whether to enable this module. The parameter has the following values: true: enables the module. false: disables the module. The default value is false.
    originRewriteRules GetDomainOriginRewriteOriginRewriteRule[]
    Represents a list of rules. This parameter is required when Switch is true. The list can contain up to 50 rules. The order of rules in the list defines their priority, with the first rule having the highest priority. The SourcePath in each rule specifies the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope. When a user request is received, the CDN matches the request against the rules in order of priority, from highest to lowest. If the request matches a rule, the CDN stops processing the remaining rules.
    switch boolean
    Indicates whether to enable this module. The parameter has the following values: true: enables the module. false: disables the module. The default value is false.
    origin_rewrite_rules Sequence[GetDomainOriginRewriteOriginRewriteRule]
    Represents a list of rules. This parameter is required when Switch is true. The list can contain up to 50 rules. The order of rules in the list defines their priority, with the first rule having the highest priority. The SourcePath in each rule specifies the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope. When a user request is received, the CDN matches the request against the rules in order of priority, from highest to lowest. If the request matches a rule, the CDN stops processing the remaining rules.
    switch bool
    Indicates whether to enable this module. The parameter has the following values: true: enables the module. false: disables the module. The default value is false.
    originRewriteRules List<Property Map>
    Represents a list of rules. This parameter is required when Switch is true. The list can contain up to 50 rules. The order of rules in the list defines their priority, with the first rule having the highest priority. The SourcePath in each rule specifies the scope of the rule. If you create multiple rules, rules with a broader scope should appear after those with a narrower scope. When a user request is received, the CDN matches the request against the rules in order of priority, from highest to lowest. If the request matches a rule, the CDN stops processing the remaining rules.
    switch Boolean
    Indicates whether to enable this module. The parameter has the following values: true: enables the module. false: disables the module. The default value is false.

    GetDomainOriginRewriteOriginRewriteRule

    Condition Byteplus.GetDomainOriginRewriteOriginRewriteRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    OriginRewriteAction Byteplus.GetDomainOriginRewriteOriginRewriteRuleOriginRewriteAction
    Indicates a rule configuration for origin path rewrite.
    Condition GetDomainOriginRewriteOriginRewriteRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    OriginRewriteAction GetDomainOriginRewriteOriginRewriteRuleOriginRewriteAction
    Indicates a rule configuration for origin path rewrite.
    condition GetDomainOriginRewriteOriginRewriteRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    originRewriteAction GetDomainOriginRewriteOriginRewriteRuleOriginRewriteAction
    Indicates a rule configuration for origin path rewrite.
    condition GetDomainOriginRewriteOriginRewriteRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    originRewriteAction GetDomainOriginRewriteOriginRewriteRuleOriginRewriteAction
    Indicates a rule configuration for origin path rewrite.
    condition GetDomainOriginRewriteOriginRewriteRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    origin_rewrite_action GetDomainOriginRewriteOriginRewriteRuleOriginRewriteAction
    Indicates a rule configuration for origin path rewrite.
    condition Property Map
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    originRewriteAction Property Map
    Indicates a rule configuration for origin path rewrite.

    GetDomainOriginRewriteOriginRewriteRuleCondition

    ConditionRules List<Byteplus.GetDomainOriginRewriteOriginRewriteRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainOriginRewriteOriginRewriteRuleConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainOriginRewriteOriginRewriteRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainOriginRewriteOriginRewriteRuleConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainOriginRewriteOriginRewriteRuleConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainOriginRewriteOriginRewriteRuleConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainOriginRewriteOriginRewriteRuleOriginRewriteAction

    RewriteType string
    Indicates the rewrite type. This parameter supports the following values: rewritepath: rewrites the path in the request URL. rewriteurl: rewrites both the path and query string in the request URL. The default value is rewrite_path.
    SourcePath string
    Indicates a regular expression, with a maximum length of 1,024 characters, used to match objects in the user's request URL. For a user request, if the regular expression matches any part of the object, this rule applies to the request. When RewriteType is rewritepath, the object refers to the path in the request URL. When RewriteType is rewriteurl, the object refers to both the path and query string in the request URL.
    TargetPath string
    Indicates the object in the origin request URL after rewriting. When RewriteType is rewritepath, this object is the path in the origin request URL. When RewriteType is rewriteurl, this object is the path and query string in the origin request URL. You can use $1, $2, $3, etc. in TargetPath to represent groups defined in the regular expression of SourcePath.
    RewriteType string
    Indicates the rewrite type. This parameter supports the following values: rewritepath: rewrites the path in the request URL. rewriteurl: rewrites both the path and query string in the request URL. The default value is rewrite_path.
    SourcePath string
    Indicates a regular expression, with a maximum length of 1,024 characters, used to match objects in the user's request URL. For a user request, if the regular expression matches any part of the object, this rule applies to the request. When RewriteType is rewritepath, the object refers to the path in the request URL. When RewriteType is rewriteurl, the object refers to both the path and query string in the request URL.
    TargetPath string
    Indicates the object in the origin request URL after rewriting. When RewriteType is rewritepath, this object is the path in the origin request URL. When RewriteType is rewriteurl, this object is the path and query string in the origin request URL. You can use $1, $2, $3, etc. in TargetPath to represent groups defined in the regular expression of SourcePath.
    rewriteType String
    Indicates the rewrite type. This parameter supports the following values: rewritepath: rewrites the path in the request URL. rewriteurl: rewrites both the path and query string in the request URL. The default value is rewrite_path.
    sourcePath String
    Indicates a regular expression, with a maximum length of 1,024 characters, used to match objects in the user's request URL. For a user request, if the regular expression matches any part of the object, this rule applies to the request. When RewriteType is rewritepath, the object refers to the path in the request URL. When RewriteType is rewriteurl, the object refers to both the path and query string in the request URL.
    targetPath String
    Indicates the object in the origin request URL after rewriting. When RewriteType is rewritepath, this object is the path in the origin request URL. When RewriteType is rewriteurl, this object is the path and query string in the origin request URL. You can use $1, $2, $3, etc. in TargetPath to represent groups defined in the regular expression of SourcePath.
    rewriteType string
    Indicates the rewrite type. This parameter supports the following values: rewritepath: rewrites the path in the request URL. rewriteurl: rewrites both the path and query string in the request URL. The default value is rewrite_path.
    sourcePath string
    Indicates a regular expression, with a maximum length of 1,024 characters, used to match objects in the user's request URL. For a user request, if the regular expression matches any part of the object, this rule applies to the request. When RewriteType is rewritepath, the object refers to the path in the request URL. When RewriteType is rewriteurl, the object refers to both the path and query string in the request URL.
    targetPath string
    Indicates the object in the origin request URL after rewriting. When RewriteType is rewritepath, this object is the path in the origin request URL. When RewriteType is rewriteurl, this object is the path and query string in the origin request URL. You can use $1, $2, $3, etc. in TargetPath to represent groups defined in the regular expression of SourcePath.
    rewrite_type str
    Indicates the rewrite type. This parameter supports the following values: rewritepath: rewrites the path in the request URL. rewriteurl: rewrites both the path and query string in the request URL. The default value is rewrite_path.
    source_path str
    Indicates a regular expression, with a maximum length of 1,024 characters, used to match objects in the user's request URL. For a user request, if the regular expression matches any part of the object, this rule applies to the request. When RewriteType is rewritepath, the object refers to the path in the request URL. When RewriteType is rewriteurl, the object refers to both the path and query string in the request URL.
    target_path str
    Indicates the object in the origin request URL after rewriting. When RewriteType is rewritepath, this object is the path in the origin request URL. When RewriteType is rewriteurl, this object is the path and query string in the origin request URL. You can use $1, $2, $3, etc. in TargetPath to represent groups defined in the regular expression of SourcePath.
    rewriteType String
    Indicates the rewrite type. This parameter supports the following values: rewritepath: rewrites the path in the request URL. rewriteurl: rewrites both the path and query string in the request URL. The default value is rewrite_path.
    sourcePath String
    Indicates a regular expression, with a maximum length of 1,024 characters, used to match objects in the user's request URL. For a user request, if the regular expression matches any part of the object, this rule applies to the request. When RewriteType is rewritepath, the object refers to the path in the request URL. When RewriteType is rewriteurl, the object refers to both the path and query string in the request URL.
    targetPath String
    Indicates the object in the origin request URL after rewriting. When RewriteType is rewritepath, this object is the path in the origin request URL. When RewriteType is rewriteurl, this object is the path and query string in the origin request URL. You can use $1, $2, $3, etc. in TargetPath to represent groups defined in the regular expression of SourcePath.

    GetDomainOriginSni

    SniDomain string
    Specifies the domain name for origin SNI. When Switch is true, this parameter is required. The value cannot exceed 1,024 characters.
    Switch bool
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.
    SniDomain string
    Specifies the domain name for origin SNI. When Switch is true, this parameter is required. The value cannot exceed 1,024 characters.
    Switch bool
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.
    sniDomain String
    Specifies the domain name for origin SNI. When Switch is true, this parameter is required. The value cannot exceed 1,024 characters.
    switch_ Boolean
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.
    sniDomain string
    Specifies the domain name for origin SNI. When Switch is true, this parameter is required. The value cannot exceed 1,024 characters.
    switch boolean
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.
    sni_domain str
    Specifies the domain name for origin SNI. When Switch is true, this parameter is required. The value cannot exceed 1,024 characters.
    switch bool
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.
    sniDomain String
    Specifies the domain name for origin SNI. When Switch is true, this parameter is required. The value cannot exceed 1,024 characters.
    switch Boolean
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.

    GetDomainPageOptimization

    OptimizationTypes List<string>
    Specifies the optimization target. This parameter has the following values: html: HTML page. js: JavaScript code. css: CSS code. The default value is html. If you specify js or css, html must also be specified.
    Switch bool
    Indicates whether this feature is enabled. The parameter values are: true: The feature is enabled. false: The feature is disabled.
    OptimizationTypes []string
    Specifies the optimization target. This parameter has the following values: html: HTML page. js: JavaScript code. css: CSS code. The default value is html. If you specify js or css, html must also be specified.
    Switch bool
    Indicates whether this feature is enabled. The parameter values are: true: The feature is enabled. false: The feature is disabled.
    optimizationTypes List<String>
    Specifies the optimization target. This parameter has the following values: html: HTML page. js: JavaScript code. css: CSS code. The default value is html. If you specify js or css, html must also be specified.
    switch_ Boolean
    Indicates whether this feature is enabled. The parameter values are: true: The feature is enabled. false: The feature is disabled.
    optimizationTypes string[]
    Specifies the optimization target. This parameter has the following values: html: HTML page. js: JavaScript code. css: CSS code. The default value is html. If you specify js or css, html must also be specified.
    switch boolean
    Indicates whether this feature is enabled. The parameter values are: true: The feature is enabled. false: The feature is disabled.
    optimization_types Sequence[str]
    Specifies the optimization target. This parameter has the following values: html: HTML page. js: JavaScript code. css: CSS code. The default value is html. If you specify js or css, html must also be specified.
    switch bool
    Indicates whether this feature is enabled. The parameter values are: true: The feature is enabled. false: The feature is disabled.
    optimizationTypes List<String>
    Specifies the optimization target. This parameter has the following values: html: HTML page. js: JavaScript code. css: CSS code. The default value is html. If you specify js or css, html must also be specified.
    switch Boolean
    Indicates whether this feature is enabled. The parameter values are: true: The feature is enabled. false: The feature is disabled.

    GetDomainQuic

    Switch bool
    QUIC configuration switch. The parameter values are as follows: true: enables QUIC. false: disables QUIC. To enable QUIC, you must first enable HTTPS.
    Switch bool
    QUIC configuration switch. The parameter values are as follows: true: enables QUIC. false: disables QUIC. To enable QUIC, you must first enable HTTPS.
    switch_ Boolean
    QUIC configuration switch. The parameter values are as follows: true: enables QUIC. false: disables QUIC. To enable QUIC, you must first enable HTTPS.
    switch boolean
    QUIC configuration switch. The parameter values are as follows: true: enables QUIC. false: disables QUIC. To enable QUIC, you must first enable HTTPS.
    switch bool
    QUIC configuration switch. The parameter values are as follows: true: enables QUIC. false: disables QUIC. To enable QUIC, you must first enable HTTPS.
    switch Boolean
    QUIC configuration switch. The parameter values are as follows: true: enables QUIC. false: disables QUIC. To enable QUIC, you must first enable HTTPS.

    GetDomainRedirectionRewrite

    RedirectionRules List<Byteplus.GetDomainRedirectionRewriteRedirectionRule>
    Indicates a list of URL redirect rewrite rules. When Switch is true, this parameter is required. The list can contain up to 50 rules.
    Switch bool
    Indicates whether this configuration is enabled. This parameter has the following values: true: enables URL redirect rewrite. false: disables URL redirect rewrite.
    RedirectionRules []GetDomainRedirectionRewriteRedirectionRule
    Indicates a list of URL redirect rewrite rules. When Switch is true, this parameter is required. The list can contain up to 50 rules.
    Switch bool
    Indicates whether this configuration is enabled. This parameter has the following values: true: enables URL redirect rewrite. false: disables URL redirect rewrite.
    redirectionRules List<GetDomainRedirectionRewriteRedirectionRule>
    Indicates a list of URL redirect rewrite rules. When Switch is true, this parameter is required. The list can contain up to 50 rules.
    switch_ Boolean
    Indicates whether this configuration is enabled. This parameter has the following values: true: enables URL redirect rewrite. false: disables URL redirect rewrite.
    redirectionRules GetDomainRedirectionRewriteRedirectionRule[]
    Indicates a list of URL redirect rewrite rules. When Switch is true, this parameter is required. The list can contain up to 50 rules.
    switch boolean
    Indicates whether this configuration is enabled. This parameter has the following values: true: enables URL redirect rewrite. false: disables URL redirect rewrite.
    redirection_rules Sequence[GetDomainRedirectionRewriteRedirectionRule]
    Indicates a list of URL redirect rewrite rules. When Switch is true, this parameter is required. The list can contain up to 50 rules.
    switch bool
    Indicates whether this configuration is enabled. This parameter has the following values: true: enables URL redirect rewrite. false: disables URL redirect rewrite.
    redirectionRules List<Property Map>
    Indicates a list of URL redirect rewrite rules. When Switch is true, this parameter is required. The list can contain up to 50 rules.
    switch Boolean
    Indicates whether this configuration is enabled. This parameter has the following values: true: enables URL redirect rewrite. false: disables URL redirect rewrite.

    GetDomainRedirectionRewriteRedirectionRule

    redirectionAction Property Map
    Indicates a URL redirect rewrite rule

    GetDomainRedirectionRewriteRedirectionRuleRedirectionAction

    RedirectCode string
    Indicates the response status code for URL redirection. Valid values are 301, 302, 303, 307, and 308. Note: For 301 and 302, if the original request method is not GET, the client may use GET when sending the new request to the new URL. For 303, the new request method is GET. For 307 and 308, the new request method remains the same as the original and is not changed.
    SourcePath string
    Specifies the original file path, which is the path included in the request. The path must start with a slash (/) and cannot contain consecutive slashes (//), percent signs (%), or spaces. The value of this parameter cannot exceed 1,024 characters.
    TargetHost string
    Indicates the domain name or IP address of the site to which the target path belongs. The IP address must be IPv4. The parameter value cannot exceed 1,024 characters. The default value is your acceleration domain name.
    TargetPath string
    Indicates the target path after redirection. The path must start with a slash (/) and cannot contain consecutive slashes (//), percent signs (%), or spaces. The value cannot exceed 1,024 characters.
    TargetProtocol string
    Specifies the protocol used for the new request after URL redirection. The parameter values are: followclient: use the protocol of the original request; http: force the new request to use HTTP; https: force the new request to use HTTPS.
    TargetQueryComponents Byteplus.GetDomainRedirectionRewriteRedirectionRuleRedirectionActionTargetQueryComponents
    Indicates how the query parameters in the original request URL are handled.
    RedirectCode string
    Indicates the response status code for URL redirection. Valid values are 301, 302, 303, 307, and 308. Note: For 301 and 302, if the original request method is not GET, the client may use GET when sending the new request to the new URL. For 303, the new request method is GET. For 307 and 308, the new request method remains the same as the original and is not changed.
    SourcePath string
    Specifies the original file path, which is the path included in the request. The path must start with a slash (/) and cannot contain consecutive slashes (//), percent signs (%), or spaces. The value of this parameter cannot exceed 1,024 characters.
    TargetHost string
    Indicates the domain name or IP address of the site to which the target path belongs. The IP address must be IPv4. The parameter value cannot exceed 1,024 characters. The default value is your acceleration domain name.
    TargetPath string
    Indicates the target path after redirection. The path must start with a slash (/) and cannot contain consecutive slashes (//), percent signs (%), or spaces. The value cannot exceed 1,024 characters.
    TargetProtocol string
    Specifies the protocol used for the new request after URL redirection. The parameter values are: followclient: use the protocol of the original request; http: force the new request to use HTTP; https: force the new request to use HTTPS.
    TargetQueryComponents GetDomainRedirectionRewriteRedirectionRuleRedirectionActionTargetQueryComponents
    Indicates how the query parameters in the original request URL are handled.
    redirectCode String
    Indicates the response status code for URL redirection. Valid values are 301, 302, 303, 307, and 308. Note: For 301 and 302, if the original request method is not GET, the client may use GET when sending the new request to the new URL. For 303, the new request method is GET. For 307 and 308, the new request method remains the same as the original and is not changed.
    sourcePath String
    Specifies the original file path, which is the path included in the request. The path must start with a slash (/) and cannot contain consecutive slashes (//), percent signs (%), or spaces. The value of this parameter cannot exceed 1,024 characters.
    targetHost String
    Indicates the domain name or IP address of the site to which the target path belongs. The IP address must be IPv4. The parameter value cannot exceed 1,024 characters. The default value is your acceleration domain name.
    targetPath String
    Indicates the target path after redirection. The path must start with a slash (/) and cannot contain consecutive slashes (//), percent signs (%), or spaces. The value cannot exceed 1,024 characters.
    targetProtocol String
    Specifies the protocol used for the new request after URL redirection. The parameter values are: followclient: use the protocol of the original request; http: force the new request to use HTTP; https: force the new request to use HTTPS.
    targetQueryComponents GetDomainRedirectionRewriteRedirectionRuleRedirectionActionTargetQueryComponents
    Indicates how the query parameters in the original request URL are handled.
    redirectCode string
    Indicates the response status code for URL redirection. Valid values are 301, 302, 303, 307, and 308. Note: For 301 and 302, if the original request method is not GET, the client may use GET when sending the new request to the new URL. For 303, the new request method is GET. For 307 and 308, the new request method remains the same as the original and is not changed.
    sourcePath string
    Specifies the original file path, which is the path included in the request. The path must start with a slash (/) and cannot contain consecutive slashes (//), percent signs (%), or spaces. The value of this parameter cannot exceed 1,024 characters.
    targetHost string
    Indicates the domain name or IP address of the site to which the target path belongs. The IP address must be IPv4. The parameter value cannot exceed 1,024 characters. The default value is your acceleration domain name.
    targetPath string
    Indicates the target path after redirection. The path must start with a slash (/) and cannot contain consecutive slashes (//), percent signs (%), or spaces. The value cannot exceed 1,024 characters.
    targetProtocol string
    Specifies the protocol used for the new request after URL redirection. The parameter values are: followclient: use the protocol of the original request; http: force the new request to use HTTP; https: force the new request to use HTTPS.
    targetQueryComponents GetDomainRedirectionRewriteRedirectionRuleRedirectionActionTargetQueryComponents
    Indicates how the query parameters in the original request URL are handled.
    redirect_code str
    Indicates the response status code for URL redirection. Valid values are 301, 302, 303, 307, and 308. Note: For 301 and 302, if the original request method is not GET, the client may use GET when sending the new request to the new URL. For 303, the new request method is GET. For 307 and 308, the new request method remains the same as the original and is not changed.
    source_path str
    Specifies the original file path, which is the path included in the request. The path must start with a slash (/) and cannot contain consecutive slashes (//), percent signs (%), or spaces. The value of this parameter cannot exceed 1,024 characters.
    target_host str
    Indicates the domain name or IP address of the site to which the target path belongs. The IP address must be IPv4. The parameter value cannot exceed 1,024 characters. The default value is your acceleration domain name.
    target_path str
    Indicates the target path after redirection. The path must start with a slash (/) and cannot contain consecutive slashes (//), percent signs (%), or spaces. The value cannot exceed 1,024 characters.
    target_protocol str
    Specifies the protocol used for the new request after URL redirection. The parameter values are: followclient: use the protocol of the original request; http: force the new request to use HTTP; https: force the new request to use HTTPS.
    target_query_components GetDomainRedirectionRewriteRedirectionRuleRedirectionActionTargetQueryComponents
    Indicates how the query parameters in the original request URL are handled.
    redirectCode String
    Indicates the response status code for URL redirection. Valid values are 301, 302, 303, 307, and 308. Note: For 301 and 302, if the original request method is not GET, the client may use GET when sending the new request to the new URL. For 303, the new request method is GET. For 307 and 308, the new request method remains the same as the original and is not changed.
    sourcePath String
    Specifies the original file path, which is the path included in the request. The path must start with a slash (/) and cannot contain consecutive slashes (//), percent signs (%), or spaces. The value of this parameter cannot exceed 1,024 characters.
    targetHost String
    Indicates the domain name or IP address of the site to which the target path belongs. The IP address must be IPv4. The parameter value cannot exceed 1,024 characters. The default value is your acceleration domain name.
    targetPath String
    Indicates the target path after redirection. The path must start with a slash (/) and cannot contain consecutive slashes (//), percent signs (%), or spaces. The value cannot exceed 1,024 characters.
    targetProtocol String
    Specifies the protocol used for the new request after URL redirection. The parameter values are: followclient: use the protocol of the original request; http: force the new request to use HTTP; https: force the new request to use HTTPS.
    targetQueryComponents Property Map
    Indicates how the query parameters in the original request URL are handled.

    GetDomainRedirectionRewriteRedirectionRuleRedirectionActionTargetQueryComponents

    Action string
    Indicates how to handle query parameters in the original request URL. This parameter has the following values: include: includes all query parameters from the original request URL in the redirected URL. exclude: excludes all query parameters from the original request URL in the redirected URL. includePart: includes specific query parameters from the original request URL in the redirected URL. excludePart: excludes specific query parameters from the original request URL in the redirected URL.
    Value string
    Indicates the query parameters to retain or remove. Multiple query parameters are separated by a semicolon (;). The specified query parameters cannot contain consecutive slashes (//), percent signs ("), or spaces. The default value of Value is *, which means all query parameters. If Action is include or exclude, Value must be *. If Action is includePart or excludePart, you can specify one or more query parameters. In this case, the specified query parameters cannot be *.
    Action string
    Indicates how to handle query parameters in the original request URL. This parameter has the following values: include: includes all query parameters from the original request URL in the redirected URL. exclude: excludes all query parameters from the original request URL in the redirected URL. includePart: includes specific query parameters from the original request URL in the redirected URL. excludePart: excludes specific query parameters from the original request URL in the redirected URL.
    Value string
    Indicates the query parameters to retain or remove. Multiple query parameters are separated by a semicolon (;). The specified query parameters cannot contain consecutive slashes (//), percent signs ("), or spaces. The default value of Value is *, which means all query parameters. If Action is include or exclude, Value must be *. If Action is includePart or excludePart, you can specify one or more query parameters. In this case, the specified query parameters cannot be *.
    action String
    Indicates how to handle query parameters in the original request URL. This parameter has the following values: include: includes all query parameters from the original request URL in the redirected URL. exclude: excludes all query parameters from the original request URL in the redirected URL. includePart: includes specific query parameters from the original request URL in the redirected URL. excludePart: excludes specific query parameters from the original request URL in the redirected URL.
    value String
    Indicates the query parameters to retain or remove. Multiple query parameters are separated by a semicolon (;). The specified query parameters cannot contain consecutive slashes (//), percent signs ("), or spaces. The default value of Value is *, which means all query parameters. If Action is include or exclude, Value must be *. If Action is includePart or excludePart, you can specify one or more query parameters. In this case, the specified query parameters cannot be *.
    action string
    Indicates how to handle query parameters in the original request URL. This parameter has the following values: include: includes all query parameters from the original request URL in the redirected URL. exclude: excludes all query parameters from the original request URL in the redirected URL. includePart: includes specific query parameters from the original request URL in the redirected URL. excludePart: excludes specific query parameters from the original request URL in the redirected URL.
    value string
    Indicates the query parameters to retain or remove. Multiple query parameters are separated by a semicolon (;). The specified query parameters cannot contain consecutive slashes (//), percent signs ("), or spaces. The default value of Value is *, which means all query parameters. If Action is include or exclude, Value must be *. If Action is includePart or excludePart, you can specify one or more query parameters. In this case, the specified query parameters cannot be *.
    action str
    Indicates how to handle query parameters in the original request URL. This parameter has the following values: include: includes all query parameters from the original request URL in the redirected URL. exclude: excludes all query parameters from the original request URL in the redirected URL. includePart: includes specific query parameters from the original request URL in the redirected URL. excludePart: excludes specific query parameters from the original request URL in the redirected URL.
    value str
    Indicates the query parameters to retain or remove. Multiple query parameters are separated by a semicolon (;). The specified query parameters cannot contain consecutive slashes (//), percent signs ("), or spaces. The default value of Value is *, which means all query parameters. If Action is include or exclude, Value must be *. If Action is includePart or excludePart, you can specify one or more query parameters. In this case, the specified query parameters cannot be *.
    action String
    Indicates how to handle query parameters in the original request URL. This parameter has the following values: include: includes all query parameters from the original request URL in the redirected URL. exclude: excludes all query parameters from the original request URL in the redirected URL. includePart: includes specific query parameters from the original request URL in the redirected URL. excludePart: excludes specific query parameters from the original request URL in the redirected URL.
    value String
    Indicates the query parameters to retain or remove. Multiple query parameters are separated by a semicolon (;). The specified query parameters cannot contain consecutive slashes (//), percent signs ("), or spaces. The default value of Value is *, which means all query parameters. If Action is include or exclude, Value must be *. If Action is includePart or excludePart, you can specify one or more query parameters. In this case, the specified query parameters cannot be *.

    GetDomainRefererAccessRule

    AllowEmpty bool
    Specifies whether the content delivery network accepts a request when the Referer header in the user's request is empty (""). This parameter has the following values: true: accepts the request; false: rejects the request. The default value is false.
    Referers List<string>
    Indicates a list of Referers. The input requirements for this parameter are consistent with those for Referers under the CommonType of ReferersType. We recommend using ReferersType to specify the Referer list. If you specify SharedConfig, you cannot specify this parameter.
    ReferersType Byteplus.GetDomainRefererAccessRuleReferersType
    Indicates a ReferersType object. It contains a CommonType object and a RegularType object, representing a standard Referer list and a Referer regular expression list, respectively. If you specify SharedConfig, you cannot specify this parameter.
    RuleType string
    Indicates the type of Referer list. This parameter is required when Switch is true. This parameter has the following values: allow: indicates Allowlist. deny: indicates Denylist.
    SharedConfig Byteplus.GetDomainRefererAccessRuleSharedConfig
    Represents a global configuration. If you specify this parameter, you cannot specify Referers or ReferersType.
    Switch bool
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    AllowEmpty bool
    Specifies whether the content delivery network accepts a request when the Referer header in the user's request is empty (""). This parameter has the following values: true: accepts the request; false: rejects the request. The default value is false.
    Referers []string
    Indicates a list of Referers. The input requirements for this parameter are consistent with those for Referers under the CommonType of ReferersType. We recommend using ReferersType to specify the Referer list. If you specify SharedConfig, you cannot specify this parameter.
    ReferersType GetDomainRefererAccessRuleReferersType
    Indicates a ReferersType object. It contains a CommonType object and a RegularType object, representing a standard Referer list and a Referer regular expression list, respectively. If you specify SharedConfig, you cannot specify this parameter.
    RuleType string
    Indicates the type of Referer list. This parameter is required when Switch is true. This parameter has the following values: allow: indicates Allowlist. deny: indicates Denylist.
    SharedConfig GetDomainRefererAccessRuleSharedConfig
    Represents a global configuration. If you specify this parameter, you cannot specify Referers or ReferersType.
    Switch bool
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    allowEmpty Boolean
    Specifies whether the content delivery network accepts a request when the Referer header in the user's request is empty (""). This parameter has the following values: true: accepts the request; false: rejects the request. The default value is false.
    referers List<String>
    Indicates a list of Referers. The input requirements for this parameter are consistent with those for Referers under the CommonType of ReferersType. We recommend using ReferersType to specify the Referer list. If you specify SharedConfig, you cannot specify this parameter.
    referersType GetDomainRefererAccessRuleReferersType
    Indicates a ReferersType object. It contains a CommonType object and a RegularType object, representing a standard Referer list and a Referer regular expression list, respectively. If you specify SharedConfig, you cannot specify this parameter.
    ruleType String
    Indicates the type of Referer list. This parameter is required when Switch is true. This parameter has the following values: allow: indicates Allowlist. deny: indicates Denylist.
    sharedConfig GetDomainRefererAccessRuleSharedConfig
    Represents a global configuration. If you specify this parameter, you cannot specify Referers or ReferersType.
    switch_ Boolean
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    allowEmpty boolean
    Specifies whether the content delivery network accepts a request when the Referer header in the user's request is empty (""). This parameter has the following values: true: accepts the request; false: rejects the request. The default value is false.
    referers string[]
    Indicates a list of Referers. The input requirements for this parameter are consistent with those for Referers under the CommonType of ReferersType. We recommend using ReferersType to specify the Referer list. If you specify SharedConfig, you cannot specify this parameter.
    referersType GetDomainRefererAccessRuleReferersType
    Indicates a ReferersType object. It contains a CommonType object and a RegularType object, representing a standard Referer list and a Referer regular expression list, respectively. If you specify SharedConfig, you cannot specify this parameter.
    ruleType string
    Indicates the type of Referer list. This parameter is required when Switch is true. This parameter has the following values: allow: indicates Allowlist. deny: indicates Denylist.
    sharedConfig GetDomainRefererAccessRuleSharedConfig
    Represents a global configuration. If you specify this parameter, you cannot specify Referers or ReferersType.
    switch boolean
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    allow_empty bool
    Specifies whether the content delivery network accepts a request when the Referer header in the user's request is empty (""). This parameter has the following values: true: accepts the request; false: rejects the request. The default value is false.
    referers Sequence[str]
    Indicates a list of Referers. The input requirements for this parameter are consistent with those for Referers under the CommonType of ReferersType. We recommend using ReferersType to specify the Referer list. If you specify SharedConfig, you cannot specify this parameter.
    referers_type GetDomainRefererAccessRuleReferersType
    Indicates a ReferersType object. It contains a CommonType object and a RegularType object, representing a standard Referer list and a Referer regular expression list, respectively. If you specify SharedConfig, you cannot specify this parameter.
    rule_type str
    Indicates the type of Referer list. This parameter is required when Switch is true. This parameter has the following values: allow: indicates Allowlist. deny: indicates Denylist.
    shared_config GetDomainRefererAccessRuleSharedConfig
    Represents a global configuration. If you specify this parameter, you cannot specify Referers or ReferersType.
    switch bool
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.
    allowEmpty Boolean
    Specifies whether the content delivery network accepts a request when the Referer header in the user's request is empty (""). This parameter has the following values: true: accepts the request; false: rejects the request. The default value is false.
    referers List<String>
    Indicates a list of Referers. The input requirements for this parameter are consistent with those for Referers under the CommonType of ReferersType. We recommend using ReferersType to specify the Referer list. If you specify SharedConfig, you cannot specify this parameter.
    referersType Property Map
    Indicates a ReferersType object. It contains a CommonType object and a RegularType object, representing a standard Referer list and a Referer regular expression list, respectively. If you specify SharedConfig, you cannot specify this parameter.
    ruleType String
    Indicates the type of Referer list. This parameter is required when Switch is true. This parameter has the following values: allow: indicates Allowlist. deny: indicates Denylist.
    sharedConfig Property Map
    Represents a global configuration. If you specify this parameter, you cannot specify Referers or ReferersType.
    switch Boolean
    Indicates whether this feature is enabled. This parameter has the following values: true: enables the feature. false: disables the feature.

    GetDomainRefererAccessRuleReferersType

    CommonType Byteplus.GetDomainRefererAccessRuleReferersTypeCommonType
    Indicates a CommonType object that contains a list of standard Referers.
    RegularType Byteplus.GetDomainRefererAccessRuleReferersTypeRegularType
    Specifies a RegularType object, which contains a list of regular expressions used to match the Referer header value in requests This parameter provides the allowlist feature To use this parameter, submit a ticket Note that if the Referer header value in a request matches the Referers list under CommonType or the Referers list under RegularType, the content delivery network considers it a match
    CommonType GetDomainRefererAccessRuleReferersTypeCommonType
    Indicates a CommonType object that contains a list of standard Referers.
    RegularType GetDomainRefererAccessRuleReferersTypeRegularType
    Specifies a RegularType object, which contains a list of regular expressions used to match the Referer header value in requests This parameter provides the allowlist feature To use this parameter, submit a ticket Note that if the Referer header value in a request matches the Referers list under CommonType or the Referers list under RegularType, the content delivery network considers it a match
    commonType GetDomainRefererAccessRuleReferersTypeCommonType
    Indicates a CommonType object that contains a list of standard Referers.
    regularType GetDomainRefererAccessRuleReferersTypeRegularType
    Specifies a RegularType object, which contains a list of regular expressions used to match the Referer header value in requests This parameter provides the allowlist feature To use this parameter, submit a ticket Note that if the Referer header value in a request matches the Referers list under CommonType or the Referers list under RegularType, the content delivery network considers it a match
    commonType GetDomainRefererAccessRuleReferersTypeCommonType
    Indicates a CommonType object that contains a list of standard Referers.
    regularType GetDomainRefererAccessRuleReferersTypeRegularType
    Specifies a RegularType object, which contains a list of regular expressions used to match the Referer header value in requests This parameter provides the allowlist feature To use this parameter, submit a ticket Note that if the Referer header value in a request matches the Referers list under CommonType or the Referers list under RegularType, the content delivery network considers it a match
    common_type GetDomainRefererAccessRuleReferersTypeCommonType
    Indicates a CommonType object that contains a list of standard Referers.
    regular_type GetDomainRefererAccessRuleReferersTypeRegularType
    Specifies a RegularType object, which contains a list of regular expressions used to match the Referer header value in requests This parameter provides the allowlist feature To use this parameter, submit a ticket Note that if the Referer header value in a request matches the Referers list under CommonType or the Referers list under RegularType, the content delivery network considers it a match
    commonType Property Map
    Indicates a CommonType object that contains a list of standard Referers.
    regularType Property Map
    Specifies a RegularType object, which contains a list of regular expressions used to match the Referer header value in requests This parameter provides the allowlist feature To use this parameter, submit a ticket Note that if the Referer header value in a request matches the Referers list under CommonType or the Referers list under RegularType, the content delivery network considers it a match

    GetDomainRefererAccessRuleReferersTypeCommonType

    IgnoreCase bool
    Specifies whether the Referers list under CommonType is case sensitive during matching. The parameter supports the following values: true: not case sensitive. false: case sensitive. The default value is true.
    IgnoreScheme bool
    Indicates whether the Referer header value in this Referers list under CommonType must start with HTTP or HTTPS. This parameter has the following values: true: Referer header values that do not start with HTTP or HTTPS are valid. In this case, the content delivery network will attempt to match them with the Referers list. false: Referer header values that do not start with HTTP or HTTPS are invalid. In this case, the content delivery network determines that they do not match the Referers list under CommonType. The default value is false.
    Referers List<string>
    Represents a standard Referer list. In this list, you can specify one or more IP addresses, CIDR blocks, domain names, and wildcard domains. Domain names can include second-level domains. IP addresses can be in IPv4 or IPv6 format. You can enter up to 1,000 IP addresses. The domain names entered must not include http:// or https://. During matching, the content delivery network compares the domain name in the Referer header of the request with the Referer list. The value of this parameter must not exceed 30,000 characters.
    IgnoreCase bool
    Specifies whether the Referers list under CommonType is case sensitive during matching. The parameter supports the following values: true: not case sensitive. false: case sensitive. The default value is true.
    IgnoreScheme bool
    Indicates whether the Referer header value in this Referers list under CommonType must start with HTTP or HTTPS. This parameter has the following values: true: Referer header values that do not start with HTTP or HTTPS are valid. In this case, the content delivery network will attempt to match them with the Referers list. false: Referer header values that do not start with HTTP or HTTPS are invalid. In this case, the content delivery network determines that they do not match the Referers list under CommonType. The default value is false.
    Referers []string
    Represents a standard Referer list. In this list, you can specify one or more IP addresses, CIDR blocks, domain names, and wildcard domains. Domain names can include second-level domains. IP addresses can be in IPv4 or IPv6 format. You can enter up to 1,000 IP addresses. The domain names entered must not include http:// or https://. During matching, the content delivery network compares the domain name in the Referer header of the request with the Referer list. The value of this parameter must not exceed 30,000 characters.
    ignoreCase Boolean
    Specifies whether the Referers list under CommonType is case sensitive during matching. The parameter supports the following values: true: not case sensitive. false: case sensitive. The default value is true.
    ignoreScheme Boolean
    Indicates whether the Referer header value in this Referers list under CommonType must start with HTTP or HTTPS. This parameter has the following values: true: Referer header values that do not start with HTTP or HTTPS are valid. In this case, the content delivery network will attempt to match them with the Referers list. false: Referer header values that do not start with HTTP or HTTPS are invalid. In this case, the content delivery network determines that they do not match the Referers list under CommonType. The default value is false.
    referers List<String>
    Represents a standard Referer list. In this list, you can specify one or more IP addresses, CIDR blocks, domain names, and wildcard domains. Domain names can include second-level domains. IP addresses can be in IPv4 or IPv6 format. You can enter up to 1,000 IP addresses. The domain names entered must not include http:// or https://. During matching, the content delivery network compares the domain name in the Referer header of the request with the Referer list. The value of this parameter must not exceed 30,000 characters.
    ignoreCase boolean
    Specifies whether the Referers list under CommonType is case sensitive during matching. The parameter supports the following values: true: not case sensitive. false: case sensitive. The default value is true.
    ignoreScheme boolean
    Indicates whether the Referer header value in this Referers list under CommonType must start with HTTP or HTTPS. This parameter has the following values: true: Referer header values that do not start with HTTP or HTTPS are valid. In this case, the content delivery network will attempt to match them with the Referers list. false: Referer header values that do not start with HTTP or HTTPS are invalid. In this case, the content delivery network determines that they do not match the Referers list under CommonType. The default value is false.
    referers string[]
    Represents a standard Referer list. In this list, you can specify one or more IP addresses, CIDR blocks, domain names, and wildcard domains. Domain names can include second-level domains. IP addresses can be in IPv4 or IPv6 format. You can enter up to 1,000 IP addresses. The domain names entered must not include http:// or https://. During matching, the content delivery network compares the domain name in the Referer header of the request with the Referer list. The value of this parameter must not exceed 30,000 characters.
    ignore_case bool
    Specifies whether the Referers list under CommonType is case sensitive during matching. The parameter supports the following values: true: not case sensitive. false: case sensitive. The default value is true.
    ignore_scheme bool
    Indicates whether the Referer header value in this Referers list under CommonType must start with HTTP or HTTPS. This parameter has the following values: true: Referer header values that do not start with HTTP or HTTPS are valid. In this case, the content delivery network will attempt to match them with the Referers list. false: Referer header values that do not start with HTTP or HTTPS are invalid. In this case, the content delivery network determines that they do not match the Referers list under CommonType. The default value is false.
    referers Sequence[str]
    Represents a standard Referer list. In this list, you can specify one or more IP addresses, CIDR blocks, domain names, and wildcard domains. Domain names can include second-level domains. IP addresses can be in IPv4 or IPv6 format. You can enter up to 1,000 IP addresses. The domain names entered must not include http:// or https://. During matching, the content delivery network compares the domain name in the Referer header of the request with the Referer list. The value of this parameter must not exceed 30,000 characters.
    ignoreCase Boolean
    Specifies whether the Referers list under CommonType is case sensitive during matching. The parameter supports the following values: true: not case sensitive. false: case sensitive. The default value is true.
    ignoreScheme Boolean
    Indicates whether the Referer header value in this Referers list under CommonType must start with HTTP or HTTPS. This parameter has the following values: true: Referer header values that do not start with HTTP or HTTPS are valid. In this case, the content delivery network will attempt to match them with the Referers list. false: Referer header values that do not start with HTTP or HTTPS are invalid. In this case, the content delivery network determines that they do not match the Referers list under CommonType. The default value is false.
    referers List<String>
    Represents a standard Referer list. In this list, you can specify one or more IP addresses, CIDR blocks, domain names, and wildcard domains. Domain names can include second-level domains. IP addresses can be in IPv4 or IPv6 format. You can enter up to 1,000 IP addresses. The domain names entered must not include http:// or https://. During matching, the content delivery network compares the domain name in the Referer header of the request with the Referer list. The value of this parameter must not exceed 30,000 characters.

    GetDomainRefererAccessRuleReferersTypeRegularType

    Referers List<string>
    Indicates a list of Referer regular expressions. The value of this parameter cannot exceed 30,000 characters.
    Referers []string
    Indicates a list of Referer regular expressions. The value of this parameter cannot exceed 30,000 characters.
    referers List<String>
    Indicates a list of Referer regular expressions. The value of this parameter cannot exceed 30,000 characters.
    referers string[]
    Indicates a list of Referer regular expressions. The value of this parameter cannot exceed 30,000 characters.
    referers Sequence[str]
    Indicates a list of Referer regular expressions. The value of this parameter cannot exceed 30,000 characters.
    referers List<String>
    Indicates a list of Referer regular expressions. The value of this parameter cannot exceed 30,000 characters.

    GetDomainRefererAccessRuleSharedConfig

    ConfigName string
    Indicates the name of a global configuration.
    ConfigName string
    Indicates the name of a global configuration.
    configName String
    Indicates the name of a global configuration.
    configName string
    Indicates the name of a global configuration.
    config_name str
    Indicates the name of a global configuration.
    configName String
    Indicates the name of a global configuration.

    GetDomainRemoteAuth

    RemoteAuthRules List<Byteplus.GetDomainRemoteAuthRemoteAuthRule>
    Specifies the list of remote authentication configuration rules. When Switch is true, this parameter is required. You can add only one configuration rule.
    Switch bool
    Indicates whether this feature is enabled. The parameter values are as follows: true: enables the feature. false: disables the feature.
    RemoteAuthRules []GetDomainRemoteAuthRemoteAuthRule
    Specifies the list of remote authentication configuration rules. When Switch is true, this parameter is required. You can add only one configuration rule.
    Switch bool
    Indicates whether this feature is enabled. The parameter values are as follows: true: enables the feature. false: disables the feature.
    remoteAuthRules List<GetDomainRemoteAuthRemoteAuthRule>
    Specifies the list of remote authentication configuration rules. When Switch is true, this parameter is required. You can add only one configuration rule.
    switch_ Boolean
    Indicates whether this feature is enabled. The parameter values are as follows: true: enables the feature. false: disables the feature.
    remoteAuthRules GetDomainRemoteAuthRemoteAuthRule[]
    Specifies the list of remote authentication configuration rules. When Switch is true, this parameter is required. You can add only one configuration rule.
    switch boolean
    Indicates whether this feature is enabled. The parameter values are as follows: true: enables the feature. false: disables the feature.
    remote_auth_rules Sequence[GetDomainRemoteAuthRemoteAuthRule]
    Specifies the list of remote authentication configuration rules. When Switch is true, this parameter is required. You can add only one configuration rule.
    switch bool
    Indicates whether this feature is enabled. The parameter values are as follows: true: enables the feature. false: disables the feature.
    remoteAuthRules List<Property Map>
    Specifies the list of remote authentication configuration rules. When Switch is true, this parameter is required. You can add only one configuration rule.
    switch Boolean
    Indicates whether this feature is enabled. The parameter values are as follows: true: enables the feature. false: disables the feature.

    GetDomainRemoteAuthRemoteAuthRule

    Condition Byteplus.GetDomainRemoteAuthRemoteAuthRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    RemoteAuthRuleAction Byteplus.GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleAction
    Indicates the specific authentication configuration.
    Condition GetDomainRemoteAuthRemoteAuthRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    RemoteAuthRuleAction GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleAction
    Indicates the specific authentication configuration.
    condition GetDomainRemoteAuthRemoteAuthRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    remoteAuthRuleAction GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleAction
    Indicates the specific authentication configuration.
    condition GetDomainRemoteAuthRemoteAuthRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    remoteAuthRuleAction GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleAction
    Indicates the specific authentication configuration.
    condition GetDomainRemoteAuthRemoteAuthRuleCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    remote_auth_rule_action GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleAction
    Indicates the specific authentication configuration.
    condition Property Map
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    remoteAuthRuleAction Property Map
    Indicates the specific authentication configuration.

    GetDomainRemoteAuthRemoteAuthRuleCondition

    ConditionRules List<Byteplus.GetDomainRemoteAuthRemoteAuthRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainRemoteAuthRemoteAuthRuleConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainRemoteAuthRemoteAuthRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainRemoteAuthRemoteAuthRuleConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainRemoteAuthRemoteAuthRuleConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainRemoteAuthRemoteAuthRuleConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleAction

    AuthModeConfig Byteplus.GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthModeConfig
    Indicates the configuration of the authentication server.
    AuthResponseConfig Byteplus.GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfig
    The content delivery network needs to handle the authentication status codes returned by the authentication server. This parameter specifies the relevant configuration.
    QueryStringRules Byteplus.GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRules
    Represents the parameter settings for authentication requests.
    RequestBodyRules string
    Indicates the rule for the authentication request body. You can leave this parameter unspecified or set its value to default. default means the request body is empty ("").
    RequestHeaderRules Byteplus.GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRules
    Indicates the settings for authentication request headers. You can set up to 50 request headers.
    AuthModeConfig GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthModeConfig
    Indicates the configuration of the authentication server.
    AuthResponseConfig GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfig
    The content delivery network needs to handle the authentication status codes returned by the authentication server. This parameter specifies the relevant configuration.
    QueryStringRules GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRules
    Represents the parameter settings for authentication requests.
    RequestBodyRules string
    Indicates the rule for the authentication request body. You can leave this parameter unspecified or set its value to default. default means the request body is empty ("").
    RequestHeaderRules GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRules
    Indicates the settings for authentication request headers. You can set up to 50 request headers.
    authModeConfig GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthModeConfig
    Indicates the configuration of the authentication server.
    authResponseConfig GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfig
    The content delivery network needs to handle the authentication status codes returned by the authentication server. This parameter specifies the relevant configuration.
    queryStringRules GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRules
    Represents the parameter settings for authentication requests.
    requestBodyRules String
    Indicates the rule for the authentication request body. You can leave this parameter unspecified or set its value to default. default means the request body is empty ("").
    requestHeaderRules GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRules
    Indicates the settings for authentication request headers. You can set up to 50 request headers.
    authModeConfig GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthModeConfig
    Indicates the configuration of the authentication server.
    authResponseConfig GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfig
    The content delivery network needs to handle the authentication status codes returned by the authentication server. This parameter specifies the relevant configuration.
    queryStringRules GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRules
    Represents the parameter settings for authentication requests.
    requestBodyRules string
    Indicates the rule for the authentication request body. You can leave this parameter unspecified or set its value to default. default means the request body is empty ("").
    requestHeaderRules GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRules
    Indicates the settings for authentication request headers. You can set up to 50 request headers.
    auth_mode_config GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthModeConfig
    Indicates the configuration of the authentication server.
    auth_response_config GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfig
    The content delivery network needs to handle the authentication status codes returned by the authentication server. This parameter specifies the relevant configuration.
    query_string_rules GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRules
    Represents the parameter settings for authentication requests.
    request_body_rules str
    Indicates the rule for the authentication request body. You can leave this parameter unspecified or set its value to default. default means the request body is empty ("").
    request_header_rules GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRules
    Indicates the settings for authentication request headers. You can set up to 50 request headers.
    authModeConfig Property Map
    Indicates the configuration of the authentication server.
    authResponseConfig Property Map
    The content delivery network needs to handle the authentication status codes returned by the authentication server. This parameter specifies the relevant configuration.
    queryStringRules Property Map
    Represents the parameter settings for authentication requests.
    requestBodyRules String
    Indicates the rule for the authentication request body. You can leave this parameter unspecified or set its value to default. default means the request body is empty ("").
    requestHeaderRules Property Map
    Indicates the settings for authentication request headers. You can set up to 50 request headers.

    GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthModeConfig

    BackupRemoteAddr string
    Indicates the backup address of the authentication server. The address format and requirements are the same as the primary address.
    MasterRemoteAddr string
    Indicates the primary address of the authentication server. The length must not exceed 100 characters. The primary address format is \n\n://\n\n:\n\n or \n\n://\n\n:\n\n, where: \n\n is http or https. \n\n cannot be localhost. \n\n cannot be 127.0.0.1. \n\n is optional.
    PathType string
    Indicates the path for the authentication request. The authentication address and request path together form the complete authentication URL. The content delivery network forwards the user's request to this authentication URL. The parameter accepts the following values: constant: The path in the authentication request is the same as the path in the user's request. variable: You need to specify a path for the authentication request in the pathValue parameter.
    PathValue string
    Represents the path for an authentication request. The path cannot exceed 100 characters. It must start with a slash (/), and can include any printable ASCII characters except the following: consecutive slashes (//), percent sign (%), dollar sign ($), space, question mark (?), and Delete (ASCII code 127).
    RequestMethod string
    Indicates the request method used by the content delivery network when sending authentication requests. The parameter has the following values: default: uses the same method as the user's request. get: uses the GET method. post: uses the POST method. head: uses the HEAD method.
    BackupRemoteAddr string
    Indicates the backup address of the authentication server. The address format and requirements are the same as the primary address.
    MasterRemoteAddr string
    Indicates the primary address of the authentication server. The length must not exceed 100 characters. The primary address format is \n\n://\n\n:\n\n or \n\n://\n\n:\n\n, where: \n\n is http or https. \n\n cannot be localhost. \n\n cannot be 127.0.0.1. \n\n is optional.
    PathType string
    Indicates the path for the authentication request. The authentication address and request path together form the complete authentication URL. The content delivery network forwards the user's request to this authentication URL. The parameter accepts the following values: constant: The path in the authentication request is the same as the path in the user's request. variable: You need to specify a path for the authentication request in the pathValue parameter.
    PathValue string
    Represents the path for an authentication request. The path cannot exceed 100 characters. It must start with a slash (/), and can include any printable ASCII characters except the following: consecutive slashes (//), percent sign (%), dollar sign ($), space, question mark (?), and Delete (ASCII code 127).
    RequestMethod string
    Indicates the request method used by the content delivery network when sending authentication requests. The parameter has the following values: default: uses the same method as the user's request. get: uses the GET method. post: uses the POST method. head: uses the HEAD method.
    backupRemoteAddr String
    Indicates the backup address of the authentication server. The address format and requirements are the same as the primary address.
    masterRemoteAddr String
    Indicates the primary address of the authentication server. The length must not exceed 100 characters. The primary address format is \n\n://\n\n:\n\n or \n\n://\n\n:\n\n, where: \n\n is http or https. \n\n cannot be localhost. \n\n cannot be 127.0.0.1. \n\n is optional.
    pathType String
    Indicates the path for the authentication request. The authentication address and request path together form the complete authentication URL. The content delivery network forwards the user's request to this authentication URL. The parameter accepts the following values: constant: The path in the authentication request is the same as the path in the user's request. variable: You need to specify a path for the authentication request in the pathValue parameter.
    pathValue String
    Represents the path for an authentication request. The path cannot exceed 100 characters. It must start with a slash (/), and can include any printable ASCII characters except the following: consecutive slashes (//), percent sign (%), dollar sign ($), space, question mark (?), and Delete (ASCII code 127).
    requestMethod String
    Indicates the request method used by the content delivery network when sending authentication requests. The parameter has the following values: default: uses the same method as the user's request. get: uses the GET method. post: uses the POST method. head: uses the HEAD method.
    backupRemoteAddr string
    Indicates the backup address of the authentication server. The address format and requirements are the same as the primary address.
    masterRemoteAddr string
    Indicates the primary address of the authentication server. The length must not exceed 100 characters. The primary address format is \n\n://\n\n:\n\n or \n\n://\n\n:\n\n, where: \n\n is http or https. \n\n cannot be localhost. \n\n cannot be 127.0.0.1. \n\n is optional.
    pathType string
    Indicates the path for the authentication request. The authentication address and request path together form the complete authentication URL. The content delivery network forwards the user's request to this authentication URL. The parameter accepts the following values: constant: The path in the authentication request is the same as the path in the user's request. variable: You need to specify a path for the authentication request in the pathValue parameter.
    pathValue string
    Represents the path for an authentication request. The path cannot exceed 100 characters. It must start with a slash (/), and can include any printable ASCII characters except the following: consecutive slashes (//), percent sign (%), dollar sign ($), space, question mark (?), and Delete (ASCII code 127).
    requestMethod string
    Indicates the request method used by the content delivery network when sending authentication requests. The parameter has the following values: default: uses the same method as the user's request. get: uses the GET method. post: uses the POST method. head: uses the HEAD method.
    backup_remote_addr str
    Indicates the backup address of the authentication server. The address format and requirements are the same as the primary address.
    master_remote_addr str
    Indicates the primary address of the authentication server. The length must not exceed 100 characters. The primary address format is \n\n://\n\n:\n\n or \n\n://\n\n:\n\n, where: \n\n is http or https. \n\n cannot be localhost. \n\n cannot be 127.0.0.1. \n\n is optional.
    path_type str
    Indicates the path for the authentication request. The authentication address and request path together form the complete authentication URL. The content delivery network forwards the user's request to this authentication URL. The parameter accepts the following values: constant: The path in the authentication request is the same as the path in the user's request. variable: You need to specify a path for the authentication request in the pathValue parameter.
    path_value str
    Represents the path for an authentication request. The path cannot exceed 100 characters. It must start with a slash (/), and can include any printable ASCII characters except the following: consecutive slashes (//), percent sign (%), dollar sign ($), space, question mark (?), and Delete (ASCII code 127).
    request_method str
    Indicates the request method used by the content delivery network when sending authentication requests. The parameter has the following values: default: uses the same method as the user's request. get: uses the GET method. post: uses the POST method. head: uses the HEAD method.
    backupRemoteAddr String
    Indicates the backup address of the authentication server. The address format and requirements are the same as the primary address.
    masterRemoteAddr String
    Indicates the primary address of the authentication server. The length must not exceed 100 characters. The primary address format is \n\n://\n\n:\n\n or \n\n://\n\n:\n\n, where: \n\n is http or https. \n\n cannot be localhost. \n\n cannot be 127.0.0.1. \n\n is optional.
    pathType String
    Indicates the path for the authentication request. The authentication address and request path together form the complete authentication URL. The content delivery network forwards the user's request to this authentication URL. The parameter accepts the following values: constant: The path in the authentication request is the same as the path in the user's request. variable: You need to specify a path for the authentication request in the pathValue parameter.
    pathValue String
    Represents the path for an authentication request. The path cannot exceed 100 characters. It must start with a slash (/), and can include any printable ASCII characters except the following: consecutive slashes (//), percent sign (%), dollar sign ($), space, question mark (?), and Delete (ASCII code 127).
    requestMethod String
    Indicates the request method used by the content delivery network when sending authentication requests. The parameter has the following values: default: uses the same method as the user's request. get: uses the GET method. post: uses the POST method. head: uses the HEAD method.

    GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfig

    CacheAction Byteplus.GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigCacheAction
    The content delivery network can cache authentication status codes. This parameter indicates the related configuration.
    ResponseAction Byteplus.GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigResponseAction
    Indicates how the content delivery network responds to users when authentication fails.
    StatusCodeAction Byteplus.GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigStatusCodeAction
    Specifies how the content delivery network handles authentication status codes.
    TimeOutAction Byteplus.GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigTimeOutAction
    Specifies how the content delivery network handles authentication requests after authentication timeout.
    CacheAction GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigCacheAction
    The content delivery network can cache authentication status codes. This parameter indicates the related configuration.
    ResponseAction GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigResponseAction
    Indicates how the content delivery network responds to users when authentication fails.
    StatusCodeAction GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigStatusCodeAction
    Specifies how the content delivery network handles authentication status codes.
    TimeOutAction GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigTimeOutAction
    Specifies how the content delivery network handles authentication requests after authentication timeout.
    cacheAction GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigCacheAction
    The content delivery network can cache authentication status codes. This parameter indicates the related configuration.
    responseAction GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigResponseAction
    Indicates how the content delivery network responds to users when authentication fails.
    statusCodeAction GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigStatusCodeAction
    Specifies how the content delivery network handles authentication status codes.
    timeOutAction GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigTimeOutAction
    Specifies how the content delivery network handles authentication requests after authentication timeout.
    cacheAction GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigCacheAction
    The content delivery network can cache authentication status codes. This parameter indicates the related configuration.
    responseAction GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigResponseAction
    Indicates how the content delivery network responds to users when authentication fails.
    statusCodeAction GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigStatusCodeAction
    Specifies how the content delivery network handles authentication status codes.
    timeOutAction GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigTimeOutAction
    Specifies how the content delivery network handles authentication requests after authentication timeout.
    cache_action GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigCacheAction
    The content delivery network can cache authentication status codes. This parameter indicates the related configuration.
    response_action GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigResponseAction
    Indicates how the content delivery network responds to users when authentication fails.
    status_code_action GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigStatusCodeAction
    Specifies how the content delivery network handles authentication status codes.
    time_out_action GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigTimeOutAction
    Specifies how the content delivery network handles authentication requests after authentication timeout.
    cacheAction Property Map
    The content delivery network can cache authentication status codes. This parameter indicates the related configuration.
    responseAction Property Map
    Indicates how the content delivery network responds to users when authentication fails.
    statusCodeAction Property Map
    Specifies how the content delivery network handles authentication status codes.
    timeOutAction Property Map
    Specifies how the content delivery network handles authentication requests after authentication timeout.

    GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigCacheAction

    Action string
    Indicates whether the CDN caches authentication status codes. The parameter values are: nocache: CDN does not cache authentication status codes. cache: CDN caches authentication status codes.
    CacheKeys List<string>
    The cache key specifies the query parameters used to distinguish different request URIs. Each parameter must start with $.
    Ttl int
    Indicates the cache duration for authentication status codes, measured in seconds. The range is 1–86400. 86400 seconds equals 24 hours.
    Action string
    Indicates whether the CDN caches authentication status codes. The parameter values are: nocache: CDN does not cache authentication status codes. cache: CDN caches authentication status codes.
    CacheKeys []string
    The cache key specifies the query parameters used to distinguish different request URIs. Each parameter must start with $.
    Ttl int
    Indicates the cache duration for authentication status codes, measured in seconds. The range is 1–86400. 86400 seconds equals 24 hours.
    action String
    Indicates whether the CDN caches authentication status codes. The parameter values are: nocache: CDN does not cache authentication status codes. cache: CDN caches authentication status codes.
    cacheKeys List<String>
    The cache key specifies the query parameters used to distinguish different request URIs. Each parameter must start with $.
    ttl Integer
    Indicates the cache duration for authentication status codes, measured in seconds. The range is 1–86400. 86400 seconds equals 24 hours.
    action string
    Indicates whether the CDN caches authentication status codes. The parameter values are: nocache: CDN does not cache authentication status codes. cache: CDN caches authentication status codes.
    cacheKeys string[]
    The cache key specifies the query parameters used to distinguish different request URIs. Each parameter must start with $.
    ttl number
    Indicates the cache duration for authentication status codes, measured in seconds. The range is 1–86400. 86400 seconds equals 24 hours.
    action str
    Indicates whether the CDN caches authentication status codes. The parameter values are: nocache: CDN does not cache authentication status codes. cache: CDN caches authentication status codes.
    cache_keys Sequence[str]
    The cache key specifies the query parameters used to distinguish different request URIs. Each parameter must start with $.
    ttl int
    Indicates the cache duration for authentication status codes, measured in seconds. The range is 1–86400. 86400 seconds equals 24 hours.
    action String
    Indicates whether the CDN caches authentication status codes. The parameter values are: nocache: CDN does not cache authentication status codes. cache: CDN caches authentication status codes.
    cacheKeys List<String>
    The cache key specifies the query parameters used to distinguish different request URIs. Each parameter must start with $.
    ttl Number
    Indicates the cache duration for authentication status codes, measured in seconds. The range is 1–86400. 86400 seconds equals 24 hours.

    GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigResponseAction

    StatusCode string
    Indicates the status code returned by the content delivery network to the user when authentication fails. You can specify any status code in the range 400–499. The default value is 403.
    StatusCode string
    Indicates the status code returned by the content delivery network to the user when authentication fails. You can specify any status code in the range 400–499. The default value is 403.
    statusCode String
    Indicates the status code returned by the content delivery network to the user when authentication fails. You can specify any status code in the range 400–499. The default value is 403.
    statusCode string
    Indicates the status code returned by the content delivery network to the user when authentication fails. You can specify any status code in the range 400–499. The default value is 403.
    status_code str
    Indicates the status code returned by the content delivery network to the user when authentication fails. You can specify any status code in the range 400–499. The default value is 403.
    statusCode String
    Indicates the status code returned by the content delivery network to the user when authentication fails. You can specify any status code in the range 400–499. The default value is 403.

    GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigStatusCodeAction

    DefaultAction string
    Specifies how the content delivery network handles authentication requests when the authentication status code is neither FailCode nor SuccessCode. This parameter has the following values: reject: the content delivery network considers authentication failed; pass: the content delivery network considers authentication successful.
    FailCode string
    Indicates the authentication status code returned when authentication fails. You can specify one or more status codes in the range 400–499. Separate multiple status codes with a semicolon (;). You can also specify 4xx to indicate any status code between 400 and 499. The default value for this parameter is 401.
    SuccessCode string
    Indicates the authentication status code for successful authentication. You can specify one or more status codes in the range 200–299. Separate multiple status codes with a semicolon (;). You can also specify 2xx to represent any status code from 200–299. The default value is 200.
    DefaultAction string
    Specifies how the content delivery network handles authentication requests when the authentication status code is neither FailCode nor SuccessCode. This parameter has the following values: reject: the content delivery network considers authentication failed; pass: the content delivery network considers authentication successful.
    FailCode string
    Indicates the authentication status code returned when authentication fails. You can specify one or more status codes in the range 400–499. Separate multiple status codes with a semicolon (;). You can also specify 4xx to indicate any status code between 400 and 499. The default value for this parameter is 401.
    SuccessCode string
    Indicates the authentication status code for successful authentication. You can specify one or more status codes in the range 200–299. Separate multiple status codes with a semicolon (;). You can also specify 2xx to represent any status code from 200–299. The default value is 200.
    defaultAction String
    Specifies how the content delivery network handles authentication requests when the authentication status code is neither FailCode nor SuccessCode. This parameter has the following values: reject: the content delivery network considers authentication failed; pass: the content delivery network considers authentication successful.
    failCode String
    Indicates the authentication status code returned when authentication fails. You can specify one or more status codes in the range 400–499. Separate multiple status codes with a semicolon (;). You can also specify 4xx to indicate any status code between 400 and 499. The default value for this parameter is 401.
    successCode String
    Indicates the authentication status code for successful authentication. You can specify one or more status codes in the range 200–299. Separate multiple status codes with a semicolon (;). You can also specify 2xx to represent any status code from 200–299. The default value is 200.
    defaultAction string
    Specifies how the content delivery network handles authentication requests when the authentication status code is neither FailCode nor SuccessCode. This parameter has the following values: reject: the content delivery network considers authentication failed; pass: the content delivery network considers authentication successful.
    failCode string
    Indicates the authentication status code returned when authentication fails. You can specify one or more status codes in the range 400–499. Separate multiple status codes with a semicolon (;). You can also specify 4xx to indicate any status code between 400 and 499. The default value for this parameter is 401.
    successCode string
    Indicates the authentication status code for successful authentication. You can specify one or more status codes in the range 200–299. Separate multiple status codes with a semicolon (;). You can also specify 2xx to represent any status code from 200–299. The default value is 200.
    default_action str
    Specifies how the content delivery network handles authentication requests when the authentication status code is neither FailCode nor SuccessCode. This parameter has the following values: reject: the content delivery network considers authentication failed; pass: the content delivery network considers authentication successful.
    fail_code str
    Indicates the authentication status code returned when authentication fails. You can specify one or more status codes in the range 400–499. Separate multiple status codes with a semicolon (;). You can also specify 4xx to indicate any status code between 400 and 499. The default value for this parameter is 401.
    success_code str
    Indicates the authentication status code for successful authentication. You can specify one or more status codes in the range 200–299. Separate multiple status codes with a semicolon (;). You can also specify 2xx to represent any status code from 200–299. The default value is 200.
    defaultAction String
    Specifies how the content delivery network handles authentication requests when the authentication status code is neither FailCode nor SuccessCode. This parameter has the following values: reject: the content delivery network considers authentication failed; pass: the content delivery network considers authentication successful.
    failCode String
    Indicates the authentication status code returned when authentication fails. You can specify one or more status codes in the range 400–499. Separate multiple status codes with a semicolon (;). You can also specify 4xx to indicate any status code between 400 and 499. The default value for this parameter is 401.
    successCode String
    Indicates the authentication status code for successful authentication. You can specify one or more status codes in the range 200–299. Separate multiple status codes with a semicolon (;). You can also specify 2xx to represent any status code from 200–299. The default value is 200.

    GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthResponseConfigTimeOutAction

    Action string
    Indicates the strategy for handling authentication requests after a timeout in the content delivery network. This parameter supports the following values: reject: The content delivery network considers authentication failed. pass: The content delivery network considers authentication successful.
    Time int
    Specifies the authentication timeout in milliseconds. The default value is 200. The valid range is 200–3600.
    Action string
    Indicates the strategy for handling authentication requests after a timeout in the content delivery network. This parameter supports the following values: reject: The content delivery network considers authentication failed. pass: The content delivery network considers authentication successful.
    Time int
    Specifies the authentication timeout in milliseconds. The default value is 200. The valid range is 200–3600.
    action String
    Indicates the strategy for handling authentication requests after a timeout in the content delivery network. This parameter supports the following values: reject: The content delivery network considers authentication failed. pass: The content delivery network considers authentication successful.
    time Integer
    Specifies the authentication timeout in milliseconds. The default value is 200. The valid range is 200–3600.
    action string
    Indicates the strategy for handling authentication requests after a timeout in the content delivery network. This parameter supports the following values: reject: The content delivery network considers authentication failed. pass: The content delivery network considers authentication successful.
    time number
    Specifies the authentication timeout in milliseconds. The default value is 200. The valid range is 200–3600.
    action str
    Indicates the strategy for handling authentication requests after a timeout in the content delivery network. This parameter supports the following values: reject: The content delivery network considers authentication failed. pass: The content delivery network considers authentication successful.
    time int
    Specifies the authentication timeout in milliseconds. The default value is 200. The valid range is 200–3600.
    action String
    Indicates the strategy for handling authentication requests after a timeout in the content delivery network. This parameter supports the following values: reject: The content delivery network considers authentication failed. pass: The content delivery network considers authentication successful.
    time Number
    Specifies the authentication timeout in milliseconds. The default value is 200. The valid range is 200–3600.

    GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRules

    QueryStringComponents Byteplus.GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringComponents
    Indicates the strategy for setting authentication request parameters.
    QueryStringInstances List<Byteplus.GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringInstance>
    Indicates additional parameter settings in the authentication request. You can set up to 50 parameters.
    QueryStringComponents GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringComponents
    Indicates the strategy for setting authentication request parameters.
    QueryStringInstances []GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringInstance
    Indicates additional parameter settings in the authentication request. You can set up to 50 parameters.
    queryStringComponents GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringComponents
    Indicates the strategy for setting authentication request parameters.
    queryStringInstances List<GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringInstance>
    Indicates additional parameter settings in the authentication request. You can set up to 50 parameters.
    queryStringComponents GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringComponents
    Indicates the strategy for setting authentication request parameters.
    queryStringInstances GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringInstance[]
    Indicates additional parameter settings in the authentication request. You can set up to 50 parameters.
    query_string_components GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringComponents
    Indicates the strategy for setting authentication request parameters.
    query_string_instances Sequence[GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringInstance]
    Indicates additional parameter settings in the authentication request. You can set up to 50 parameters.
    queryStringComponents Property Map
    Indicates the strategy for setting authentication request parameters.
    queryStringInstances List<Property Map>
    Indicates additional parameter settings in the authentication request. You can set up to 50 parameters.

    GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringComponents

    Action string
    Indicates whether the authentication request includes query parameters from the user's request URL. The parameter accepts the following values: exclude: The authentication request does not include any query parameters. include: The authentication request includes all query parameters. includePart: The authentication request includes specified query parameters.
    Value string
    Indicates the parameter value corresponding to the Action parameter. The length cannot exceed 1,024 characters. The parameter accepts the following values: If Action is exclude or include, Value must be *. If Action is includePart, you need to specify one or more query parameters from the user's request URL in the Value parameter, separated by semicolons (;). You cannot specify *. Query parameters are case-sensitive and can include printable ASCII characters except for the following: double quotes (") , spaces, and Delete (ASCII code 127). The default value for this parameter is *.
    Action string
    Indicates whether the authentication request includes query parameters from the user's request URL. The parameter accepts the following values: exclude: The authentication request does not include any query parameters. include: The authentication request includes all query parameters. includePart: The authentication request includes specified query parameters.
    Value string
    Indicates the parameter value corresponding to the Action parameter. The length cannot exceed 1,024 characters. The parameter accepts the following values: If Action is exclude or include, Value must be *. If Action is includePart, you need to specify one or more query parameters from the user's request URL in the Value parameter, separated by semicolons (;). You cannot specify *. Query parameters are case-sensitive and can include printable ASCII characters except for the following: double quotes (") , spaces, and Delete (ASCII code 127). The default value for this parameter is *.
    action String
    Indicates whether the authentication request includes query parameters from the user's request URL. The parameter accepts the following values: exclude: The authentication request does not include any query parameters. include: The authentication request includes all query parameters. includePart: The authentication request includes specified query parameters.
    value String
    Indicates the parameter value corresponding to the Action parameter. The length cannot exceed 1,024 characters. The parameter accepts the following values: If Action is exclude or include, Value must be *. If Action is includePart, you need to specify one or more query parameters from the user's request URL in the Value parameter, separated by semicolons (;). You cannot specify *. Query parameters are case-sensitive and can include printable ASCII characters except for the following: double quotes (") , spaces, and Delete (ASCII code 127). The default value for this parameter is *.
    action string
    Indicates whether the authentication request includes query parameters from the user's request URL. The parameter accepts the following values: exclude: The authentication request does not include any query parameters. include: The authentication request includes all query parameters. includePart: The authentication request includes specified query parameters.
    value string
    Indicates the parameter value corresponding to the Action parameter. The length cannot exceed 1,024 characters. The parameter accepts the following values: If Action is exclude or include, Value must be *. If Action is includePart, you need to specify one or more query parameters from the user's request URL in the Value parameter, separated by semicolons (;). You cannot specify *. Query parameters are case-sensitive and can include printable ASCII characters except for the following: double quotes (") , spaces, and Delete (ASCII code 127). The default value for this parameter is *.
    action str
    Indicates whether the authentication request includes query parameters from the user's request URL. The parameter accepts the following values: exclude: The authentication request does not include any query parameters. include: The authentication request includes all query parameters. includePart: The authentication request includes specified query parameters.
    value str
    Indicates the parameter value corresponding to the Action parameter. The length cannot exceed 1,024 characters. The parameter accepts the following values: If Action is exclude or include, Value must be *. If Action is includePart, you need to specify one or more query parameters from the user's request URL in the Value parameter, separated by semicolons (;). You cannot specify *. Query parameters are case-sensitive and can include printable ASCII characters except for the following: double quotes (") , spaces, and Delete (ASCII code 127). The default value for this parameter is *.
    action String
    Indicates whether the authentication request includes query parameters from the user's request URL. The parameter accepts the following values: exclude: The authentication request does not include any query parameters. include: The authentication request includes all query parameters. includePart: The authentication request includes specified query parameters.
    value String
    Indicates the parameter value corresponding to the Action parameter. The length cannot exceed 1,024 characters. The parameter accepts the following values: If Action is exclude or include, Value must be *. If Action is includePart, you need to specify one or more query parameters from the user's request URL in the Value parameter, separated by semicolons (;). You cannot specify *. Query parameters are case-sensitive and can include printable ASCII characters except for the following: double quotes (") , spaces, and Delete (ASCII code 127). The default value for this parameter is *.

    GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionQueryStringRulesQueryStringInstance

    Action string
    Describes how to set authentication request parameters. Currently, you can only set Action to set. set means to configure parameters. You need to specify the authentication request parameter to set in Key. If the specified authentication request parameter does not exist, the content delivery network adds the parameter to the authentication request. If the specified authentication request parameter already exists, the content delivery network uses the value of Value as the parameter's value.
    Key string
    Indicates the authentication request parameter you need to set. The length must not exceed 1,024 characters. The authentication request parameter can contain printable ASCII characters except for the following: double quotes ("), space, and Delete (ASCII code 127)
    Value string
    Indicates the value of the authentication request parameter. The length cannot exceed 1,024 characters and is case-sensitive. Value has the following options: When ValueType is constant, the authentication request parameter value is a constant. You need to specify this constant value. The constant value cannot start with a dollar sign ($) and can include any printable ASCII character except the following: double quotes (") and Delete (ASCII code 127). When ValueType is variable, the authentication request parameter value comes from a variable. You can specify a variable from the variable list. When ValueType is customize, the authentication request parameter value is a string formed by concatenating variables from the list with fixed strings. In the concatenated string, variables are represented as ${variablename}. Example value: bind${requesturi}to${local_ip}done
    ValueType string
    Indicates the type of authentication request parameter set in Key. ValueType has the following options: constant: The authentication request parameter is a constant. In this case, you need to specify the constant value in Value. variable: The authentication request parameter value comes from a variable. See the description for Value. customize: The authentication request parameter value is a string formed by concatenating a variable and a fixed string.
    Action string
    Describes how to set authentication request parameters. Currently, you can only set Action to set. set means to configure parameters. You need to specify the authentication request parameter to set in Key. If the specified authentication request parameter does not exist, the content delivery network adds the parameter to the authentication request. If the specified authentication request parameter already exists, the content delivery network uses the value of Value as the parameter's value.
    Key string
    Indicates the authentication request parameter you need to set. The length must not exceed 1,024 characters. The authentication request parameter can contain printable ASCII characters except for the following: double quotes ("), space, and Delete (ASCII code 127)
    Value string
    Indicates the value of the authentication request parameter. The length cannot exceed 1,024 characters and is case-sensitive. Value has the following options: When ValueType is constant, the authentication request parameter value is a constant. You need to specify this constant value. The constant value cannot start with a dollar sign ($) and can include any printable ASCII character except the following: double quotes (") and Delete (ASCII code 127). When ValueType is variable, the authentication request parameter value comes from a variable. You can specify a variable from the variable list. When ValueType is customize, the authentication request parameter value is a string formed by concatenating variables from the list with fixed strings. In the concatenated string, variables are represented as ${variablename}. Example value: bind${requesturi}to${local_ip}done
    ValueType string
    Indicates the type of authentication request parameter set in Key. ValueType has the following options: constant: The authentication request parameter is a constant. In this case, you need to specify the constant value in Value. variable: The authentication request parameter value comes from a variable. See the description for Value. customize: The authentication request parameter value is a string formed by concatenating a variable and a fixed string.
    action String
    Describes how to set authentication request parameters. Currently, you can only set Action to set. set means to configure parameters. You need to specify the authentication request parameter to set in Key. If the specified authentication request parameter does not exist, the content delivery network adds the parameter to the authentication request. If the specified authentication request parameter already exists, the content delivery network uses the value of Value as the parameter's value.
    key String
    Indicates the authentication request parameter you need to set. The length must not exceed 1,024 characters. The authentication request parameter can contain printable ASCII characters except for the following: double quotes ("), space, and Delete (ASCII code 127)
    value String
    Indicates the value of the authentication request parameter. The length cannot exceed 1,024 characters and is case-sensitive. Value has the following options: When ValueType is constant, the authentication request parameter value is a constant. You need to specify this constant value. The constant value cannot start with a dollar sign ($) and can include any printable ASCII character except the following: double quotes (") and Delete (ASCII code 127). When ValueType is variable, the authentication request parameter value comes from a variable. You can specify a variable from the variable list. When ValueType is customize, the authentication request parameter value is a string formed by concatenating variables from the list with fixed strings. In the concatenated string, variables are represented as ${variablename}. Example value: bind${requesturi}to${local_ip}done
    valueType String
    Indicates the type of authentication request parameter set in Key. ValueType has the following options: constant: The authentication request parameter is a constant. In this case, you need to specify the constant value in Value. variable: The authentication request parameter value comes from a variable. See the description for Value. customize: The authentication request parameter value is a string formed by concatenating a variable and a fixed string.
    action string
    Describes how to set authentication request parameters. Currently, you can only set Action to set. set means to configure parameters. You need to specify the authentication request parameter to set in Key. If the specified authentication request parameter does not exist, the content delivery network adds the parameter to the authentication request. If the specified authentication request parameter already exists, the content delivery network uses the value of Value as the parameter's value.
    key string
    Indicates the authentication request parameter you need to set. The length must not exceed 1,024 characters. The authentication request parameter can contain printable ASCII characters except for the following: double quotes ("), space, and Delete (ASCII code 127)
    value string
    Indicates the value of the authentication request parameter. The length cannot exceed 1,024 characters and is case-sensitive. Value has the following options: When ValueType is constant, the authentication request parameter value is a constant. You need to specify this constant value. The constant value cannot start with a dollar sign ($) and can include any printable ASCII character except the following: double quotes (") and Delete (ASCII code 127). When ValueType is variable, the authentication request parameter value comes from a variable. You can specify a variable from the variable list. When ValueType is customize, the authentication request parameter value is a string formed by concatenating variables from the list with fixed strings. In the concatenated string, variables are represented as ${variablename}. Example value: bind${requesturi}to${local_ip}done
    valueType string
    Indicates the type of authentication request parameter set in Key. ValueType has the following options: constant: The authentication request parameter is a constant. In this case, you need to specify the constant value in Value. variable: The authentication request parameter value comes from a variable. See the description for Value. customize: The authentication request parameter value is a string formed by concatenating a variable and a fixed string.
    action str
    Describes how to set authentication request parameters. Currently, you can only set Action to set. set means to configure parameters. You need to specify the authentication request parameter to set in Key. If the specified authentication request parameter does not exist, the content delivery network adds the parameter to the authentication request. If the specified authentication request parameter already exists, the content delivery network uses the value of Value as the parameter's value.
    key str
    Indicates the authentication request parameter you need to set. The length must not exceed 1,024 characters. The authentication request parameter can contain printable ASCII characters except for the following: double quotes ("), space, and Delete (ASCII code 127)
    value str
    Indicates the value of the authentication request parameter. The length cannot exceed 1,024 characters and is case-sensitive. Value has the following options: When ValueType is constant, the authentication request parameter value is a constant. You need to specify this constant value. The constant value cannot start with a dollar sign ($) and can include any printable ASCII character except the following: double quotes (") and Delete (ASCII code 127). When ValueType is variable, the authentication request parameter value comes from a variable. You can specify a variable from the variable list. When ValueType is customize, the authentication request parameter value is a string formed by concatenating variables from the list with fixed strings. In the concatenated string, variables are represented as ${variablename}. Example value: bind${requesturi}to${local_ip}done
    value_type str
    Indicates the type of authentication request parameter set in Key. ValueType has the following options: constant: The authentication request parameter is a constant. In this case, you need to specify the constant value in Value. variable: The authentication request parameter value comes from a variable. See the description for Value. customize: The authentication request parameter value is a string formed by concatenating a variable and a fixed string.
    action String
    Describes how to set authentication request parameters. Currently, you can only set Action to set. set means to configure parameters. You need to specify the authentication request parameter to set in Key. If the specified authentication request parameter does not exist, the content delivery network adds the parameter to the authentication request. If the specified authentication request parameter already exists, the content delivery network uses the value of Value as the parameter's value.
    key String
    Indicates the authentication request parameter you need to set. The length must not exceed 1,024 characters. The authentication request parameter can contain printable ASCII characters except for the following: double quotes ("), space, and Delete (ASCII code 127)
    value String
    Indicates the value of the authentication request parameter. The length cannot exceed 1,024 characters and is case-sensitive. Value has the following options: When ValueType is constant, the authentication request parameter value is a constant. You need to specify this constant value. The constant value cannot start with a dollar sign ($) and can include any printable ASCII character except the following: double quotes (") and Delete (ASCII code 127). When ValueType is variable, the authentication request parameter value comes from a variable. You can specify a variable from the variable list. When ValueType is customize, the authentication request parameter value is a string formed by concatenating variables from the list with fixed strings. In the concatenated string, variables are represented as ${variablename}. Example value: bind${requesturi}to${local_ip}done
    valueType String
    Indicates the type of authentication request parameter set in Key. ValueType has the following options: constant: The authentication request parameter is a constant. In this case, you need to specify the constant value in Value. variable: The authentication request parameter value comes from a variable. See the description for Value. customize: The authentication request parameter value is a string formed by concatenating a variable and a fixed string.

    GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRules

    RequestHeaderComponents Byteplus.GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderComponents
    Indicates the configuration policy for authentication request headers.
    RequestHeaderInstances List<Byteplus.GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderInstance>
    Specifies a set of authentication request header settings Note that when the content delivery network initiates an authentication request, the following headers may already be included in the request: X-Forwarded-Protocol, X-Forwarded-Proto, X-Client-Scheme: all three headers indicate the protocol used by the user request and are equivalent X-Real-IP: indicates the user's real IP address This header value is not affected by proxy servers X-Forwarded-For: indicates the user's IP address If the user's request passes through a proxy server, this header value becomes the proxy server's IP address It is not recommended to configure these headers in this parameter If you set these headers, their original values will be overwritten
    RequestHost string
    Indicates the value of the HOST header in authentication requests. The default value for this parameter is default, meaning the HOST header matches your acceleration domain name.
    RequestHeaderComponents GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderComponents
    Indicates the configuration policy for authentication request headers.
    RequestHeaderInstances []GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderInstance
    Specifies a set of authentication request header settings Note that when the content delivery network initiates an authentication request, the following headers may already be included in the request: X-Forwarded-Protocol, X-Forwarded-Proto, X-Client-Scheme: all three headers indicate the protocol used by the user request and are equivalent X-Real-IP: indicates the user's real IP address This header value is not affected by proxy servers X-Forwarded-For: indicates the user's IP address If the user's request passes through a proxy server, this header value becomes the proxy server's IP address It is not recommended to configure these headers in this parameter If you set these headers, their original values will be overwritten
    RequestHost string
    Indicates the value of the HOST header in authentication requests. The default value for this parameter is default, meaning the HOST header matches your acceleration domain name.
    requestHeaderComponents GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderComponents
    Indicates the configuration policy for authentication request headers.
    requestHeaderInstances List<GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderInstance>
    Specifies a set of authentication request header settings Note that when the content delivery network initiates an authentication request, the following headers may already be included in the request: X-Forwarded-Protocol, X-Forwarded-Proto, X-Client-Scheme: all three headers indicate the protocol used by the user request and are equivalent X-Real-IP: indicates the user's real IP address This header value is not affected by proxy servers X-Forwarded-For: indicates the user's IP address If the user's request passes through a proxy server, this header value becomes the proxy server's IP address It is not recommended to configure these headers in this parameter If you set these headers, their original values will be overwritten
    requestHost String
    Indicates the value of the HOST header in authentication requests. The default value for this parameter is default, meaning the HOST header matches your acceleration domain name.
    requestHeaderComponents GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderComponents
    Indicates the configuration policy for authentication request headers.
    requestHeaderInstances GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderInstance[]
    Specifies a set of authentication request header settings Note that when the content delivery network initiates an authentication request, the following headers may already be included in the request: X-Forwarded-Protocol, X-Forwarded-Proto, X-Client-Scheme: all three headers indicate the protocol used by the user request and are equivalent X-Real-IP: indicates the user's real IP address This header value is not affected by proxy servers X-Forwarded-For: indicates the user's IP address If the user's request passes through a proxy server, this header value becomes the proxy server's IP address It is not recommended to configure these headers in this parameter If you set these headers, their original values will be overwritten
    requestHost string
    Indicates the value of the HOST header in authentication requests. The default value for this parameter is default, meaning the HOST header matches your acceleration domain name.
    request_header_components GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderComponents
    Indicates the configuration policy for authentication request headers.
    request_header_instances Sequence[GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderInstance]
    Specifies a set of authentication request header settings Note that when the content delivery network initiates an authentication request, the following headers may already be included in the request: X-Forwarded-Protocol, X-Forwarded-Proto, X-Client-Scheme: all three headers indicate the protocol used by the user request and are equivalent X-Real-IP: indicates the user's real IP address This header value is not affected by proxy servers X-Forwarded-For: indicates the user's IP address If the user's request passes through a proxy server, this header value becomes the proxy server's IP address It is not recommended to configure these headers in this parameter If you set these headers, their original values will be overwritten
    request_host str
    Indicates the value of the HOST header in authentication requests. The default value for this parameter is default, meaning the HOST header matches your acceleration domain name.
    requestHeaderComponents Property Map
    Indicates the configuration policy for authentication request headers.
    requestHeaderInstances List<Property Map>
    Specifies a set of authentication request header settings Note that when the content delivery network initiates an authentication request, the following headers may already be included in the request: X-Forwarded-Protocol, X-Forwarded-Proto, X-Client-Scheme: all three headers indicate the protocol used by the user request and are equivalent X-Real-IP: indicates the user's real IP address This header value is not affected by proxy servers X-Forwarded-For: indicates the user's IP address If the user's request passes through a proxy server, this header value becomes the proxy server's IP address It is not recommended to configure these headers in this parameter If you set these headers, their original values will be overwritten
    requestHost String
    Indicates the value of the HOST header in authentication requests. The default value for this parameter is default, meaning the HOST header matches your acceleration domain name.

    GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderComponents

    Action string
    Indicates whether the authentication request header includes user request headers. The parameter values are: exclude: the authentication request header does not include any user request headers. include: the authentication request header includes all user request headers. includePart: the authentication request header includes specified user request headers.
    Value string
    Indicates the parameter value corresponding to the Action parameter. The length must not exceed 1,024 characters. The parameter has the following notes: If Action is exclude or include, Value must be *. If Action is includePart, the Value parameter can be one or more headers from the user's request. Multiple headers are separated by a semicolon (;). The value cannot be only *, and can include printable ASCII characters except for the following: underscore (_), space, double quotes ("), Delete (ASCII code 127). The default value for this parameter is *.
    Action string
    Indicates whether the authentication request header includes user request headers. The parameter values are: exclude: the authentication request header does not include any user request headers. include: the authentication request header includes all user request headers. includePart: the authentication request header includes specified user request headers.
    Value string
    Indicates the parameter value corresponding to the Action parameter. The length must not exceed 1,024 characters. The parameter has the following notes: If Action is exclude or include, Value must be *. If Action is includePart, the Value parameter can be one or more headers from the user's request. Multiple headers are separated by a semicolon (;). The value cannot be only *, and can include printable ASCII characters except for the following: underscore (_), space, double quotes ("), Delete (ASCII code 127). The default value for this parameter is *.
    action String
    Indicates whether the authentication request header includes user request headers. The parameter values are: exclude: the authentication request header does not include any user request headers. include: the authentication request header includes all user request headers. includePart: the authentication request header includes specified user request headers.
    value String
    Indicates the parameter value corresponding to the Action parameter. The length must not exceed 1,024 characters. The parameter has the following notes: If Action is exclude or include, Value must be *. If Action is includePart, the Value parameter can be one or more headers from the user's request. Multiple headers are separated by a semicolon (;). The value cannot be only *, and can include printable ASCII characters except for the following: underscore (_), space, double quotes ("), Delete (ASCII code 127). The default value for this parameter is *.
    action string
    Indicates whether the authentication request header includes user request headers. The parameter values are: exclude: the authentication request header does not include any user request headers. include: the authentication request header includes all user request headers. includePart: the authentication request header includes specified user request headers.
    value string
    Indicates the parameter value corresponding to the Action parameter. The length must not exceed 1,024 characters. The parameter has the following notes: If Action is exclude or include, Value must be *. If Action is includePart, the Value parameter can be one or more headers from the user's request. Multiple headers are separated by a semicolon (;). The value cannot be only *, and can include printable ASCII characters except for the following: underscore (_), space, double quotes ("), Delete (ASCII code 127). The default value for this parameter is *.
    action str
    Indicates whether the authentication request header includes user request headers. The parameter values are: exclude: the authentication request header does not include any user request headers. include: the authentication request header includes all user request headers. includePart: the authentication request header includes specified user request headers.
    value str
    Indicates the parameter value corresponding to the Action parameter. The length must not exceed 1,024 characters. The parameter has the following notes: If Action is exclude or include, Value must be *. If Action is includePart, the Value parameter can be one or more headers from the user's request. Multiple headers are separated by a semicolon (;). The value cannot be only *, and can include printable ASCII characters except for the following: underscore (_), space, double quotes ("), Delete (ASCII code 127). The default value for this parameter is *.
    action String
    Indicates whether the authentication request header includes user request headers. The parameter values are: exclude: the authentication request header does not include any user request headers. include: the authentication request header includes all user request headers. includePart: the authentication request header includes specified user request headers.
    value String
    Indicates the parameter value corresponding to the Action parameter. The length must not exceed 1,024 characters. The parameter has the following notes: If Action is exclude or include, Value must be *. If Action is includePart, the Value parameter can be one or more headers from the user's request. Multiple headers are separated by a semicolon (;). The value cannot be only *, and can include printable ASCII characters except for the following: underscore (_), space, double quotes ("), Delete (ASCII code 127). The default value for this parameter is *.

    GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionRequestHeaderRulesRequestHeaderInstance

    Action string
    Indicates how to set the authentication request header. Currently, you can only set this parameter to set. set means to configure the request header. You need to specify the request header in Key. If the request header does not exist, the content delivery network adds it to the authentication request. If the request header already exists, the content delivery network uses the value specified in Value as the header value.
    Key string
    Specifies the name of a header. The name cannot exceed 1,024 characters and is case insensitive. It can contain any printable ASCII character except: underscore (_), space, double quotes ("), and Delete (ASCII code 127).
    Value string
    Indicates the value of the Key. This parameter is only valid when Action equals "set". If Action does not equal "set", this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can contain any printable ASCII character except the following: dollar sign ($), Delete (ASCII code 127)
    ValueType string
    Specifies the value type for the Key. This parameter is only valid when Action is set to 'set'. If Action is not 'set', this parameter is invalid. The parameter has the following values: constant: the Key value is a fixed string. variable: the Key value comes from a variable. customize: the Key value is a string formed by concatenating a variable and a fixed string.
    Action string
    Indicates how to set the authentication request header. Currently, you can only set this parameter to set. set means to configure the request header. You need to specify the request header in Key. If the request header does not exist, the content delivery network adds it to the authentication request. If the request header already exists, the content delivery network uses the value specified in Value as the header value.
    Key string
    Specifies the name of a header. The name cannot exceed 1,024 characters and is case insensitive. It can contain any printable ASCII character except: underscore (_), space, double quotes ("), and Delete (ASCII code 127).
    Value string
    Indicates the value of the Key. This parameter is only valid when Action equals "set". If Action does not equal "set", this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can contain any printable ASCII character except the following: dollar sign ($), Delete (ASCII code 127)
    ValueType string
    Specifies the value type for the Key. This parameter is only valid when Action is set to 'set'. If Action is not 'set', this parameter is invalid. The parameter has the following values: constant: the Key value is a fixed string. variable: the Key value comes from a variable. customize: the Key value is a string formed by concatenating a variable and a fixed string.
    action String
    Indicates how to set the authentication request header. Currently, you can only set this parameter to set. set means to configure the request header. You need to specify the request header in Key. If the request header does not exist, the content delivery network adds it to the authentication request. If the request header already exists, the content delivery network uses the value specified in Value as the header value.
    key String
    Specifies the name of a header. The name cannot exceed 1,024 characters and is case insensitive. It can contain any printable ASCII character except: underscore (_), space, double quotes ("), and Delete (ASCII code 127).
    value String
    Indicates the value of the Key. This parameter is only valid when Action equals "set". If Action does not equal "set", this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can contain any printable ASCII character except the following: dollar sign ($), Delete (ASCII code 127)
    valueType String
    Specifies the value type for the Key. This parameter is only valid when Action is set to 'set'. If Action is not 'set', this parameter is invalid. The parameter has the following values: constant: the Key value is a fixed string. variable: the Key value comes from a variable. customize: the Key value is a string formed by concatenating a variable and a fixed string.
    action string
    Indicates how to set the authentication request header. Currently, you can only set this parameter to set. set means to configure the request header. You need to specify the request header in Key. If the request header does not exist, the content delivery network adds it to the authentication request. If the request header already exists, the content delivery network uses the value specified in Value as the header value.
    key string
    Specifies the name of a header. The name cannot exceed 1,024 characters and is case insensitive. It can contain any printable ASCII character except: underscore (_), space, double quotes ("), and Delete (ASCII code 127).
    value string
    Indicates the value of the Key. This parameter is only valid when Action equals "set". If Action does not equal "set", this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can contain any printable ASCII character except the following: dollar sign ($), Delete (ASCII code 127)
    valueType string
    Specifies the value type for the Key. This parameter is only valid when Action is set to 'set'. If Action is not 'set', this parameter is invalid. The parameter has the following values: constant: the Key value is a fixed string. variable: the Key value comes from a variable. customize: the Key value is a string formed by concatenating a variable and a fixed string.
    action str
    Indicates how to set the authentication request header. Currently, you can only set this parameter to set. set means to configure the request header. You need to specify the request header in Key. If the request header does not exist, the content delivery network adds it to the authentication request. If the request header already exists, the content delivery network uses the value specified in Value as the header value.
    key str
    Specifies the name of a header. The name cannot exceed 1,024 characters and is case insensitive. It can contain any printable ASCII character except: underscore (_), space, double quotes ("), and Delete (ASCII code 127).
    value str
    Indicates the value of the Key. This parameter is only valid when Action equals "set". If Action does not equal "set", this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can contain any printable ASCII character except the following: dollar sign ($), Delete (ASCII code 127)
    value_type str
    Specifies the value type for the Key. This parameter is only valid when Action is set to 'set'. If Action is not 'set', this parameter is invalid. The parameter has the following values: constant: the Key value is a fixed string. variable: the Key value comes from a variable. customize: the Key value is a string formed by concatenating a variable and a fixed string.
    action String
    Indicates how to set the authentication request header. Currently, you can only set this parameter to set. set means to configure the request header. You need to specify the request header in Key. If the request header does not exist, the content delivery network adds it to the authentication request. If the request header already exists, the content delivery network uses the value specified in Value as the header value.
    key String
    Specifies the name of a header. The name cannot exceed 1,024 characters and is case insensitive. It can contain any printable ASCII character except: underscore (_), space, double quotes ("), and Delete (ASCII code 127).
    value String
    Indicates the value of the Key. This parameter is only valid when Action equals "set". If Action does not equal "set", this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can contain any printable ASCII character except the following: dollar sign ($), Delete (ASCII code 127)
    valueType String
    Specifies the value type for the Key. This parameter is only valid when Action is set to 'set'. If Action is not 'set', this parameter is invalid. The parameter has the following values: constant: the Key value is a fixed string. variable: the Key value comes from a variable. customize: the Key value is a string formed by concatenating a variable and a fixed string.

    GetDomainRequestBlockRule

    BlockRules List<Byteplus.GetDomainRequestBlockRuleBlockRule>
    Represents a list of interception rules. The list can contain up to 10 rules. When Switch is true, this parameter is required.
    Switch bool
    Indicates the configuration switch for this module. This parameter has the following values: true: enables the module. false: disables the module. The default value is false.
    BlockRules []GetDomainRequestBlockRuleBlockRule
    Represents a list of interception rules. The list can contain up to 10 rules. When Switch is true, this parameter is required.
    Switch bool
    Indicates the configuration switch for this module. This parameter has the following values: true: enables the module. false: disables the module. The default value is false.
    blockRules List<GetDomainRequestBlockRuleBlockRule>
    Represents a list of interception rules. The list can contain up to 10 rules. When Switch is true, this parameter is required.
    switch_ Boolean
    Indicates the configuration switch for this module. This parameter has the following values: true: enables the module. false: disables the module. The default value is false.
    blockRules GetDomainRequestBlockRuleBlockRule[]
    Represents a list of interception rules. The list can contain up to 10 rules. When Switch is true, this parameter is required.
    switch boolean
    Indicates the configuration switch for this module. This parameter has the following values: true: enables the module. false: disables the module. The default value is false.
    block_rules Sequence[GetDomainRequestBlockRuleBlockRule]
    Represents a list of interception rules. The list can contain up to 10 rules. When Switch is true, this parameter is required.
    switch bool
    Indicates the configuration switch for this module. This parameter has the following values: true: enables the module. false: disables the module. The default value is false.
    blockRules List<Property Map>
    Represents a list of interception rules. The list can contain up to 10 rules. When Switch is true, this parameter is required.
    switch Boolean
    Indicates the configuration switch for this module. This parameter has the following values: true: enables the module. false: disables the module. The default value is false.

    GetDomainRequestBlockRuleBlockRule

    BlockAction Byteplus.GetDomainRequestBlockRuleBlockRuleBlockAction
    Indicates the interception configuration for a rule in the list.
    Condition Byteplus.GetDomainRequestBlockRuleBlockRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    RuleName string
    Indicates the name of the rule, which must not exceed 20 characters and can include letters, numbers, underscores (_), hyphens (-), and Chinese characters. One Chinese character counts as 3 characters.
    BlockAction GetDomainRequestBlockRuleBlockRuleBlockAction
    Indicates the interception configuration for a rule in the list.
    Condition GetDomainRequestBlockRuleBlockRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    RuleName string
    Indicates the name of the rule, which must not exceed 20 characters and can include letters, numbers, underscores (_), hyphens (-), and Chinese characters. One Chinese character counts as 3 characters.
    blockAction GetDomainRequestBlockRuleBlockRuleBlockAction
    Indicates the interception configuration for a rule in the list.
    condition GetDomainRequestBlockRuleBlockRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    ruleName String
    Indicates the name of the rule, which must not exceed 20 characters and can include letters, numbers, underscores (_), hyphens (-), and Chinese characters. One Chinese character counts as 3 characters.
    blockAction GetDomainRequestBlockRuleBlockRuleBlockAction
    Indicates the interception configuration for a rule in the list.
    condition GetDomainRequestBlockRuleBlockRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    ruleName string
    Indicates the name of the rule, which must not exceed 20 characters and can include letters, numbers, underscores (_), hyphens (-), and Chinese characters. One Chinese character counts as 3 characters.
    block_action GetDomainRequestBlockRuleBlockRuleBlockAction
    Indicates the interception configuration for a rule in the list.
    condition GetDomainRequestBlockRuleBlockRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    rule_name str
    Indicates the name of the rule, which must not exceed 20 characters and can include letters, numbers, underscores (_), hyphens (-), and Chinese characters. One Chinese character counts as 3 characters.
    blockAction Property Map
    Indicates the interception configuration for a rule in the list.
    condition Property Map
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    ruleName String
    Indicates the name of the rule, which must not exceed 20 characters and can include letters, numbers, underscores (_), hyphens (-), and Chinese characters. One Chinese character counts as 3 characters.

    GetDomainRequestBlockRuleBlockRuleBlockAction

    Action string
    Specifies how the content delivery network intercepts matching requests. This parameter has the following values: refuse: The content delivery network rejects the request and returns a 4xx error code. The error code is specified in StatusCode. redirect: The content delivery network redirects the request to the URL specified in RedirectUrl.
    ErrorPage string
    When Action is refuse, this parameter is optional, as explained below: If specified, this parameter indicates the name of a custom response page under global configuration. When the content delivery network refuses a request, it returns this custom page. Note that 'global configuration' is an Allowlist feature. To use this feature, submit a ticket. If this parameter is not specified, the content delivery network uses the standard response body for the error code specified in StatusCode. When Action is redirect, this parameter is invalid and can be omitted.
    RedirectUrl string
    When Action is redirect, this parameter is required and specifies the redirect URL. The URL must start with http:// or https:// and cannot exceed 1,024 characters. When Action is refuse, this parameter is invalid and can be omitted.
    StatusCode string
    Represents the response status code from the content delivery network for intercepted requests. When Action is refuse, this parameter specifies an error code in the range 400–499. When Action is redirect, this parameter can be: 301: The response status code is 301. 302: The response status code is 302.
    Action string
    Specifies how the content delivery network intercepts matching requests. This parameter has the following values: refuse: The content delivery network rejects the request and returns a 4xx error code. The error code is specified in StatusCode. redirect: The content delivery network redirects the request to the URL specified in RedirectUrl.
    ErrorPage string
    When Action is refuse, this parameter is optional, as explained below: If specified, this parameter indicates the name of a custom response page under global configuration. When the content delivery network refuses a request, it returns this custom page. Note that 'global configuration' is an Allowlist feature. To use this feature, submit a ticket. If this parameter is not specified, the content delivery network uses the standard response body for the error code specified in StatusCode. When Action is redirect, this parameter is invalid and can be omitted.
    RedirectUrl string
    When Action is redirect, this parameter is required and specifies the redirect URL. The URL must start with http:// or https:// and cannot exceed 1,024 characters. When Action is refuse, this parameter is invalid and can be omitted.
    StatusCode string
    Represents the response status code from the content delivery network for intercepted requests. When Action is refuse, this parameter specifies an error code in the range 400–499. When Action is redirect, this parameter can be: 301: The response status code is 301. 302: The response status code is 302.
    action String
    Specifies how the content delivery network intercepts matching requests. This parameter has the following values: refuse: The content delivery network rejects the request and returns a 4xx error code. The error code is specified in StatusCode. redirect: The content delivery network redirects the request to the URL specified in RedirectUrl.
    errorPage String
    When Action is refuse, this parameter is optional, as explained below: If specified, this parameter indicates the name of a custom response page under global configuration. When the content delivery network refuses a request, it returns this custom page. Note that 'global configuration' is an Allowlist feature. To use this feature, submit a ticket. If this parameter is not specified, the content delivery network uses the standard response body for the error code specified in StatusCode. When Action is redirect, this parameter is invalid and can be omitted.
    redirectUrl String
    When Action is redirect, this parameter is required and specifies the redirect URL. The URL must start with http:// or https:// and cannot exceed 1,024 characters. When Action is refuse, this parameter is invalid and can be omitted.
    statusCode String
    Represents the response status code from the content delivery network for intercepted requests. When Action is refuse, this parameter specifies an error code in the range 400–499. When Action is redirect, this parameter can be: 301: The response status code is 301. 302: The response status code is 302.
    action string
    Specifies how the content delivery network intercepts matching requests. This parameter has the following values: refuse: The content delivery network rejects the request and returns a 4xx error code. The error code is specified in StatusCode. redirect: The content delivery network redirects the request to the URL specified in RedirectUrl.
    errorPage string
    When Action is refuse, this parameter is optional, as explained below: If specified, this parameter indicates the name of a custom response page under global configuration. When the content delivery network refuses a request, it returns this custom page. Note that 'global configuration' is an Allowlist feature. To use this feature, submit a ticket. If this parameter is not specified, the content delivery network uses the standard response body for the error code specified in StatusCode. When Action is redirect, this parameter is invalid and can be omitted.
    redirectUrl string
    When Action is redirect, this parameter is required and specifies the redirect URL. The URL must start with http:// or https:// and cannot exceed 1,024 characters. When Action is refuse, this parameter is invalid and can be omitted.
    statusCode string
    Represents the response status code from the content delivery network for intercepted requests. When Action is refuse, this parameter specifies an error code in the range 400–499. When Action is redirect, this parameter can be: 301: The response status code is 301. 302: The response status code is 302.
    action str
    Specifies how the content delivery network intercepts matching requests. This parameter has the following values: refuse: The content delivery network rejects the request and returns a 4xx error code. The error code is specified in StatusCode. redirect: The content delivery network redirects the request to the URL specified in RedirectUrl.
    error_page str
    When Action is refuse, this parameter is optional, as explained below: If specified, this parameter indicates the name of a custom response page under global configuration. When the content delivery network refuses a request, it returns this custom page. Note that 'global configuration' is an Allowlist feature. To use this feature, submit a ticket. If this parameter is not specified, the content delivery network uses the standard response body for the error code specified in StatusCode. When Action is redirect, this parameter is invalid and can be omitted.
    redirect_url str
    When Action is redirect, this parameter is required and specifies the redirect URL. The URL must start with http:// or https:// and cannot exceed 1,024 characters. When Action is refuse, this parameter is invalid and can be omitted.
    status_code str
    Represents the response status code from the content delivery network for intercepted requests. When Action is refuse, this parameter specifies an error code in the range 400–499. When Action is redirect, this parameter can be: 301: The response status code is 301. 302: The response status code is 302.
    action String
    Specifies how the content delivery network intercepts matching requests. This parameter has the following values: refuse: The content delivery network rejects the request and returns a 4xx error code. The error code is specified in StatusCode. redirect: The content delivery network redirects the request to the URL specified in RedirectUrl.
    errorPage String
    When Action is refuse, this parameter is optional, as explained below: If specified, this parameter indicates the name of a custom response page under global configuration. When the content delivery network refuses a request, it returns this custom page. Note that 'global configuration' is an Allowlist feature. To use this feature, submit a ticket. If this parameter is not specified, the content delivery network uses the standard response body for the error code specified in StatusCode. When Action is redirect, this parameter is invalid and can be omitted.
    redirectUrl String
    When Action is redirect, this parameter is required and specifies the redirect URL. The URL must start with http:// or https:// and cannot exceed 1,024 characters. When Action is refuse, this parameter is invalid and can be omitted.
    statusCode String
    Represents the response status code from the content delivery network for intercepted requests. When Action is refuse, this parameter specifies an error code in the range 400–499. When Action is redirect, this parameter can be: 301: The response status code is 301. 302: The response status code is 302.

    GetDomainRequestBlockRuleBlockRuleCondition

    ConditionRules List<Byteplus.GetDomainRequestBlockRuleBlockRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainRequestBlockRuleBlockRuleConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainRequestBlockRuleBlockRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainRequestBlockRuleBlockRuleConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainRequestBlockRuleBlockRuleConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainRequestBlockRuleBlockRuleConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainRequestHeader

    Condition Byteplus.GetDomainRequestHeaderCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    RequestHeaderAction Byteplus.GetDomainRequestHeaderRequestHeaderAction
    Represents a list of configuration rules for request headers. Each rule includes settings for header operations. You can add up to 50 rules.
    Condition GetDomainRequestHeaderCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    RequestHeaderAction GetDomainRequestHeaderRequestHeaderAction
    Represents a list of configuration rules for request headers. Each rule includes settings for header operations. You can add up to 50 rules.
    condition GetDomainRequestHeaderCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    requestHeaderAction GetDomainRequestHeaderRequestHeaderAction
    Represents a list of configuration rules for request headers. Each rule includes settings for header operations. You can add up to 50 rules.
    condition GetDomainRequestHeaderCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    requestHeaderAction GetDomainRequestHeaderRequestHeaderAction
    Represents a list of configuration rules for request headers. Each rule includes settings for header operations. You can add up to 50 rules.
    condition GetDomainRequestHeaderCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    request_header_action GetDomainRequestHeaderRequestHeaderAction
    Represents a list of configuration rules for request headers. Each rule includes settings for header operations. You can add up to 50 rules.
    condition Property Map
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    requestHeaderAction Property Map
    Represents a list of configuration rules for request headers. Each rule includes settings for header operations. You can add up to 50 rules.

    GetDomainRequestHeaderCondition

    ConditionRules List<Byteplus.GetDomainRequestHeaderConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainRequestHeaderConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainRequestHeaderConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainRequestHeaderConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainRequestHeaderConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainRequestHeaderConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainRequestHeaderRequestHeaderAction

    RequestHeaderInstances List<Byteplus.GetDomainRequestHeaderRequestHeaderActionRequestHeaderInstance>
    Indicates a list of configuration rules for request headers. Each rule includes settings for header-related operations. You can add up to 50 rules.
    RequestHeaderInstances []GetDomainRequestHeaderRequestHeaderActionRequestHeaderInstance
    Indicates a list of configuration rules for request headers. Each rule includes settings for header-related operations. You can add up to 50 rules.
    requestHeaderInstances List<GetDomainRequestHeaderRequestHeaderActionRequestHeaderInstance>
    Indicates a list of configuration rules for request headers. Each rule includes settings for header-related operations. You can add up to 50 rules.
    requestHeaderInstances GetDomainRequestHeaderRequestHeaderActionRequestHeaderInstance[]
    Indicates a list of configuration rules for request headers. Each rule includes settings for header-related operations. You can add up to 50 rules.
    request_header_instances Sequence[GetDomainRequestHeaderRequestHeaderActionRequestHeaderInstance]
    Indicates a list of configuration rules for request headers. Each rule includes settings for header-related operations. You can add up to 50 rules.
    requestHeaderInstances List<Property Map>
    Indicates a list of configuration rules for request headers. Each rule includes settings for header-related operations. You can add up to 50 rules.

    GetDomainRequestHeaderRequestHeaderActionRequestHeaderInstance

    Action string
    Indicates how to set the authentication request header. Currently, you can only set this parameter to set. set means to configure the request header. You need to specify the request header in Key. If the request header does not exist, the content delivery network adds it to the authentication request. If the request header already exists, the content delivery network uses the value specified in Value as the header value.
    Key string
    Specifies the name of a header. The name cannot exceed 1,024 characters and is case insensitive. It can contain any printable ASCII character except: underscore (_), space, double quotes ("), and Delete (ASCII code 127).
    Value string
    Indicates the value of the Key. This parameter is only valid when Action equals "set". If Action does not equal "set", this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can contain any printable ASCII character except the following: dollar sign ($), Delete (ASCII code 127)
    ValueType string
    Specifies the value type for the Key. This parameter is only valid when Action is set to 'set'. If Action is not 'set', this parameter is invalid. The parameter has the following values: constant: the Key value is a fixed string. variable: the Key value comes from a variable. customize: the Key value is a string formed by concatenating a variable and a fixed string.
    Action string
    Indicates how to set the authentication request header. Currently, you can only set this parameter to set. set means to configure the request header. You need to specify the request header in Key. If the request header does not exist, the content delivery network adds it to the authentication request. If the request header already exists, the content delivery network uses the value specified in Value as the header value.
    Key string
    Specifies the name of a header. The name cannot exceed 1,024 characters and is case insensitive. It can contain any printable ASCII character except: underscore (_), space, double quotes ("), and Delete (ASCII code 127).
    Value string
    Indicates the value of the Key. This parameter is only valid when Action equals "set". If Action does not equal "set", this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can contain any printable ASCII character except the following: dollar sign ($), Delete (ASCII code 127)
    ValueType string
    Specifies the value type for the Key. This parameter is only valid when Action is set to 'set'. If Action is not 'set', this parameter is invalid. The parameter has the following values: constant: the Key value is a fixed string. variable: the Key value comes from a variable. customize: the Key value is a string formed by concatenating a variable and a fixed string.
    action String
    Indicates how to set the authentication request header. Currently, you can only set this parameter to set. set means to configure the request header. You need to specify the request header in Key. If the request header does not exist, the content delivery network adds it to the authentication request. If the request header already exists, the content delivery network uses the value specified in Value as the header value.
    key String
    Specifies the name of a header. The name cannot exceed 1,024 characters and is case insensitive. It can contain any printable ASCII character except: underscore (_), space, double quotes ("), and Delete (ASCII code 127).
    value String
    Indicates the value of the Key. This parameter is only valid when Action equals "set". If Action does not equal "set", this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can contain any printable ASCII character except the following: dollar sign ($), Delete (ASCII code 127)
    valueType String
    Specifies the value type for the Key. This parameter is only valid when Action is set to 'set'. If Action is not 'set', this parameter is invalid. The parameter has the following values: constant: the Key value is a fixed string. variable: the Key value comes from a variable. customize: the Key value is a string formed by concatenating a variable and a fixed string.
    action string
    Indicates how to set the authentication request header. Currently, you can only set this parameter to set. set means to configure the request header. You need to specify the request header in Key. If the request header does not exist, the content delivery network adds it to the authentication request. If the request header already exists, the content delivery network uses the value specified in Value as the header value.
    key string
    Specifies the name of a header. The name cannot exceed 1,024 characters and is case insensitive. It can contain any printable ASCII character except: underscore (_), space, double quotes ("), and Delete (ASCII code 127).
    value string
    Indicates the value of the Key. This parameter is only valid when Action equals "set". If Action does not equal "set", this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can contain any printable ASCII character except the following: dollar sign ($), Delete (ASCII code 127)
    valueType string
    Specifies the value type for the Key. This parameter is only valid when Action is set to 'set'. If Action is not 'set', this parameter is invalid. The parameter has the following values: constant: the Key value is a fixed string. variable: the Key value comes from a variable. customize: the Key value is a string formed by concatenating a variable and a fixed string.
    action str
    Indicates how to set the authentication request header. Currently, you can only set this parameter to set. set means to configure the request header. You need to specify the request header in Key. If the request header does not exist, the content delivery network adds it to the authentication request. If the request header already exists, the content delivery network uses the value specified in Value as the header value.
    key str
    Specifies the name of a header. The name cannot exceed 1,024 characters and is case insensitive. It can contain any printable ASCII character except: underscore (_), space, double quotes ("), and Delete (ASCII code 127).
    value str
    Indicates the value of the Key. This parameter is only valid when Action equals "set". If Action does not equal "set", this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can contain any printable ASCII character except the following: dollar sign ($), Delete (ASCII code 127)
    value_type str
    Specifies the value type for the Key. This parameter is only valid when Action is set to 'set'. If Action is not 'set', this parameter is invalid. The parameter has the following values: constant: the Key value is a fixed string. variable: the Key value comes from a variable. customize: the Key value is a string formed by concatenating a variable and a fixed string.
    action String
    Indicates how to set the authentication request header. Currently, you can only set this parameter to set. set means to configure the request header. You need to specify the request header in Key. If the request header does not exist, the content delivery network adds it to the authentication request. If the request header already exists, the content delivery network uses the value specified in Value as the header value.
    key String
    Specifies the name of a header. The name cannot exceed 1,024 characters and is case insensitive. It can contain any printable ASCII character except: underscore (_), space, double quotes ("), and Delete (ASCII code 127).
    value String
    Indicates the value of the Key. This parameter is only valid when Action equals "set". If Action does not equal "set", this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can contain any printable ASCII character except the following: dollar sign ($), Delete (ASCII code 127)
    valueType String
    Specifies the value type for the Key. This parameter is only valid when Action is set to 'set'. If Action is not 'set', this parameter is invalid. The parameter has the following values: constant: the Key value is a fixed string. variable: the Key value comes from a variable. customize: the Key value is a string formed by concatenating a variable and a fixed string.

    GetDomainResponseHeader

    Condition Byteplus.GetDomainResponseHeaderCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    ResponseHeaderAction Byteplus.GetDomainResponseHeaderResponseHeaderAction
    Indicates operations on the response header performed by the Content Delivery Network when responding to user requests.
    Condition GetDomainResponseHeaderCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    ResponseHeaderAction GetDomainResponseHeaderResponseHeaderAction
    Indicates operations on the response header performed by the Content Delivery Network when responding to user requests.
    condition GetDomainResponseHeaderCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    responseHeaderAction GetDomainResponseHeaderResponseHeaderAction
    Indicates operations on the response header performed by the Content Delivery Network when responding to user requests.
    condition GetDomainResponseHeaderCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    responseHeaderAction GetDomainResponseHeaderResponseHeaderAction
    Indicates operations on the response header performed by the Content Delivery Network when responding to user requests.
    condition GetDomainResponseHeaderCondition
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    response_header_action GetDomainResponseHeaderResponseHeaderAction
    Indicates operations on the response header performed by the Content Delivery Network when responding to user requests.
    condition Property Map
    Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
    responseHeaderAction Property Map
    Indicates operations on the response header performed by the Content Delivery Network when responding to user requests.

    GetDomainResponseHeaderCondition

    ConditionRules List<Byteplus.GetDomainResponseHeaderConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainResponseHeaderConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainResponseHeaderConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainResponseHeaderConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainResponseHeaderConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainResponseHeaderConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainResponseHeaderResponseHeaderAction

    ResponseHeaderInstances List<Byteplus.GetDomainResponseHeaderResponseHeaderActionResponseHeaderInstance>
    Specifies a list of configuration rules for response headers Each rule includes settings for header-related operations You can add up to 50 rules
    ResponseHeaderInstances []GetDomainResponseHeaderResponseHeaderActionResponseHeaderInstance
    Specifies a list of configuration rules for response headers Each rule includes settings for header-related operations You can add up to 50 rules
    responseHeaderInstances List<GetDomainResponseHeaderResponseHeaderActionResponseHeaderInstance>
    Specifies a list of configuration rules for response headers Each rule includes settings for header-related operations You can add up to 50 rules
    responseHeaderInstances GetDomainResponseHeaderResponseHeaderActionResponseHeaderInstance[]
    Specifies a list of configuration rules for response headers Each rule includes settings for header-related operations You can add up to 50 rules
    response_header_instances Sequence[GetDomainResponseHeaderResponseHeaderActionResponseHeaderInstance]
    Specifies a list of configuration rules for response headers Each rule includes settings for header-related operations You can add up to 50 rules
    responseHeaderInstances List<Property Map>
    Specifies a list of configuration rules for response headers Each rule includes settings for header-related operations You can add up to 50 rules

    GetDomainResponseHeaderResponseHeaderActionResponseHeaderInstance

    AccessOriginControl bool
    Indicates whether the Origin field in the request header is validated when the content delivery network responds to user requests. Valid values are: true: The content delivery network validates the Origin field. If validation succeeds, the response header includes the Access-Control-Allow-Origin field, with the value matching the Origin field. If validation fails, the response header does not include the Access-Control-Allow-Origin field. false: The content delivery network does not validate the Origin field. The response header includes the Access-Control-Allow-Origin field, with the value set to your configured Access-Control-Allow-Origin content. The default value is false. This parameter is only effective when all the following conditions are met: Action is set. Key is Access-Control-Allow-Origin. ValueType is constant.
    Action string
    Specifies the operation on the response header. This parameter has the following values: set: sets a header. The set operation includes adding and modifying. If the header already exists in the origin response, its value will be overwritten. If the header does not exist in the origin response, it will be added. delete: deletes a header
    Key string
    Specifies the name of a header. The name cannot exceed 1,024 characters, is case-insensitive, and can include any printable ASCII character except the following: underscore (_), space, double quotes ("), and Delete (ASCII code 127)
    Value string
    Indicates the value of the Key. This parameter is valid only when Action is set. If Action is not set, this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can include printable ASCII characters except for the following: dollar sign ($), Delete (ASCII code 127).
    ValueType string
    Specifies the value type for Key. This parameter is only valid when Action is set. If Action is not set, this parameter is invalid. The parameter supports the following values: constant: Key is a fixed string. variable: Key is sourced from a variable. customize: Key is a string formed by concatenating a variable and a fixed string.
    AccessOriginControl bool
    Indicates whether the Origin field in the request header is validated when the content delivery network responds to user requests. Valid values are: true: The content delivery network validates the Origin field. If validation succeeds, the response header includes the Access-Control-Allow-Origin field, with the value matching the Origin field. If validation fails, the response header does not include the Access-Control-Allow-Origin field. false: The content delivery network does not validate the Origin field. The response header includes the Access-Control-Allow-Origin field, with the value set to your configured Access-Control-Allow-Origin content. The default value is false. This parameter is only effective when all the following conditions are met: Action is set. Key is Access-Control-Allow-Origin. ValueType is constant.
    Action string
    Specifies the operation on the response header. This parameter has the following values: set: sets a header. The set operation includes adding and modifying. If the header already exists in the origin response, its value will be overwritten. If the header does not exist in the origin response, it will be added. delete: deletes a header
    Key string
    Specifies the name of a header. The name cannot exceed 1,024 characters, is case-insensitive, and can include any printable ASCII character except the following: underscore (_), space, double quotes ("), and Delete (ASCII code 127)
    Value string
    Indicates the value of the Key. This parameter is valid only when Action is set. If Action is not set, this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can include printable ASCII characters except for the following: dollar sign ($), Delete (ASCII code 127).
    ValueType string
    Specifies the value type for Key. This parameter is only valid when Action is set. If Action is not set, this parameter is invalid. The parameter supports the following values: constant: Key is a fixed string. variable: Key is sourced from a variable. customize: Key is a string formed by concatenating a variable and a fixed string.
    accessOriginControl Boolean
    Indicates whether the Origin field in the request header is validated when the content delivery network responds to user requests. Valid values are: true: The content delivery network validates the Origin field. If validation succeeds, the response header includes the Access-Control-Allow-Origin field, with the value matching the Origin field. If validation fails, the response header does not include the Access-Control-Allow-Origin field. false: The content delivery network does not validate the Origin field. The response header includes the Access-Control-Allow-Origin field, with the value set to your configured Access-Control-Allow-Origin content. The default value is false. This parameter is only effective when all the following conditions are met: Action is set. Key is Access-Control-Allow-Origin. ValueType is constant.
    action String
    Specifies the operation on the response header. This parameter has the following values: set: sets a header. The set operation includes adding and modifying. If the header already exists in the origin response, its value will be overwritten. If the header does not exist in the origin response, it will be added. delete: deletes a header
    key String
    Specifies the name of a header. The name cannot exceed 1,024 characters, is case-insensitive, and can include any printable ASCII character except the following: underscore (_), space, double quotes ("), and Delete (ASCII code 127)
    value String
    Indicates the value of the Key. This parameter is valid only when Action is set. If Action is not set, this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can include printable ASCII characters except for the following: dollar sign ($), Delete (ASCII code 127).
    valueType String
    Specifies the value type for Key. This parameter is only valid when Action is set. If Action is not set, this parameter is invalid. The parameter supports the following values: constant: Key is a fixed string. variable: Key is sourced from a variable. customize: Key is a string formed by concatenating a variable and a fixed string.
    accessOriginControl boolean
    Indicates whether the Origin field in the request header is validated when the content delivery network responds to user requests. Valid values are: true: The content delivery network validates the Origin field. If validation succeeds, the response header includes the Access-Control-Allow-Origin field, with the value matching the Origin field. If validation fails, the response header does not include the Access-Control-Allow-Origin field. false: The content delivery network does not validate the Origin field. The response header includes the Access-Control-Allow-Origin field, with the value set to your configured Access-Control-Allow-Origin content. The default value is false. This parameter is only effective when all the following conditions are met: Action is set. Key is Access-Control-Allow-Origin. ValueType is constant.
    action string
    Specifies the operation on the response header. This parameter has the following values: set: sets a header. The set operation includes adding and modifying. If the header already exists in the origin response, its value will be overwritten. If the header does not exist in the origin response, it will be added. delete: deletes a header
    key string
    Specifies the name of a header. The name cannot exceed 1,024 characters, is case-insensitive, and can include any printable ASCII character except the following: underscore (_), space, double quotes ("), and Delete (ASCII code 127)
    value string
    Indicates the value of the Key. This parameter is valid only when Action is set. If Action is not set, this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can include printable ASCII characters except for the following: dollar sign ($), Delete (ASCII code 127).
    valueType string
    Specifies the value type for Key. This parameter is only valid when Action is set. If Action is not set, this parameter is invalid. The parameter supports the following values: constant: Key is a fixed string. variable: Key is sourced from a variable. customize: Key is a string formed by concatenating a variable and a fixed string.
    access_origin_control bool
    Indicates whether the Origin field in the request header is validated when the content delivery network responds to user requests. Valid values are: true: The content delivery network validates the Origin field. If validation succeeds, the response header includes the Access-Control-Allow-Origin field, with the value matching the Origin field. If validation fails, the response header does not include the Access-Control-Allow-Origin field. false: The content delivery network does not validate the Origin field. The response header includes the Access-Control-Allow-Origin field, with the value set to your configured Access-Control-Allow-Origin content. The default value is false. This parameter is only effective when all the following conditions are met: Action is set. Key is Access-Control-Allow-Origin. ValueType is constant.
    action str
    Specifies the operation on the response header. This parameter has the following values: set: sets a header. The set operation includes adding and modifying. If the header already exists in the origin response, its value will be overwritten. If the header does not exist in the origin response, it will be added. delete: deletes a header
    key str
    Specifies the name of a header. The name cannot exceed 1,024 characters, is case-insensitive, and can include any printable ASCII character except the following: underscore (_), space, double quotes ("), and Delete (ASCII code 127)
    value str
    Indicates the value of the Key. This parameter is valid only when Action is set. If Action is not set, this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can include printable ASCII characters except for the following: dollar sign ($), Delete (ASCII code 127).
    value_type str
    Specifies the value type for Key. This parameter is only valid when Action is set. If Action is not set, this parameter is invalid. The parameter supports the following values: constant: Key is a fixed string. variable: Key is sourced from a variable. customize: Key is a string formed by concatenating a variable and a fixed string.
    accessOriginControl Boolean
    Indicates whether the Origin field in the request header is validated when the content delivery network responds to user requests. Valid values are: true: The content delivery network validates the Origin field. If validation succeeds, the response header includes the Access-Control-Allow-Origin field, with the value matching the Origin field. If validation fails, the response header does not include the Access-Control-Allow-Origin field. false: The content delivery network does not validate the Origin field. The response header includes the Access-Control-Allow-Origin field, with the value set to your configured Access-Control-Allow-Origin content. The default value is false. This parameter is only effective when all the following conditions are met: Action is set. Key is Access-Control-Allow-Origin. ValueType is constant.
    action String
    Specifies the operation on the response header. This parameter has the following values: set: sets a header. The set operation includes adding and modifying. If the header already exists in the origin response, its value will be overwritten. If the header does not exist in the origin response, it will be added. delete: deletes a header
    key String
    Specifies the name of a header. The name cannot exceed 1,024 characters, is case-insensitive, and can include any printable ASCII character except the following: underscore (_), space, double quotes ("), and Delete (ASCII code 127)
    value String
    Indicates the value of the Key. This parameter is valid only when Action is set. If Action is not set, this parameter is invalid. When ValueType is constant, you must specify a fixed string as the header value. The header value cannot exceed 1,024 characters and can include printable ASCII characters except for the following: dollar sign ($), Delete (ASCII code 127).
    valueType String
    Specifies the value type for Key. This parameter is only valid when Action is set. If Action is not set, this parameter is invalid. The parameter supports the following values: constant: Key is a fixed string. variable: Key is sourced from a variable. customize: Key is a string formed by concatenating a variable and a fixed string.

    GetDomainRewriteHls

    SignName string
    Indicates the name of the signature parameter, which cannot exceed 100 characters. Parameter names are case-sensitive and can include letters, numbers, underscores (_), hyphens (-), commas (,), periods (.), and exclamation marks (!). The default value is DrmAuthToken.
    Switch bool
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.
    SignName string
    Indicates the name of the signature parameter, which cannot exceed 100 characters. Parameter names are case-sensitive and can include letters, numbers, underscores (_), hyphens (-), commas (,), periods (.), and exclamation marks (!). The default value is DrmAuthToken.
    Switch bool
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.
    signName String
    Indicates the name of the signature parameter, which cannot exceed 100 characters. Parameter names are case-sensitive and can include letters, numbers, underscores (_), hyphens (-), commas (,), periods (.), and exclamation marks (!). The default value is DrmAuthToken.
    switch_ Boolean
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.
    signName string
    Indicates the name of the signature parameter, which cannot exceed 100 characters. Parameter names are case-sensitive and can include letters, numbers, underscores (_), hyphens (-), commas (,), periods (.), and exclamation marks (!). The default value is DrmAuthToken.
    switch boolean
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.
    sign_name str
    Indicates the name of the signature parameter, which cannot exceed 100 characters. Parameter names are case-sensitive and can include letters, numbers, underscores (_), hyphens (-), commas (,), periods (.), and exclamation marks (!). The default value is DrmAuthToken.
    switch bool
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.
    signName String
    Indicates the name of the signature parameter, which cannot exceed 100 characters. Parameter names are case-sensitive and can include letters, numbers, underscores (_), hyphens (-), commas (,), periods (.), and exclamation marks (!). The default value is DrmAuthToken.
    switch Boolean
    Indicates whether this feature is enabled. This parameter has the following options: true: Enable this feature. false: Disable this feature. The default value for this parameter is false.

    GetDomainSignedUrlAuth

    SignedUrlAuthRules List<Byteplus.GetDomainSignedUrlAuthSignedUrlAuthRule>
    Represents the configuration module for the 'URL authentication' feature. This feature is disabled by default.
    Switch bool
    Indicates whether to enable this feature. This parameter has the following values: true: Enables this feature. false: Disables this feature.
    SignedUrlAuthRules []GetDomainSignedUrlAuthSignedUrlAuthRule
    Represents the configuration module for the 'URL authentication' feature. This feature is disabled by default.
    Switch bool
    Indicates whether to enable this feature. This parameter has the following values: true: Enables this feature. false: Disables this feature.
    signedUrlAuthRules List<GetDomainSignedUrlAuthSignedUrlAuthRule>
    Represents the configuration module for the 'URL authentication' feature. This feature is disabled by default.
    switch_ Boolean
    Indicates whether to enable this feature. This parameter has the following values: true: Enables this feature. false: Disables this feature.
    signedUrlAuthRules GetDomainSignedUrlAuthSignedUrlAuthRule[]
    Represents the configuration module for the 'URL authentication' feature. This feature is disabled by default.
    switch boolean
    Indicates whether to enable this feature. This parameter has the following values: true: Enables this feature. false: Disables this feature.
    signed_url_auth_rules Sequence[GetDomainSignedUrlAuthSignedUrlAuthRule]
    Represents the configuration module for the 'URL authentication' feature. This feature is disabled by default.
    switch bool
    Indicates whether to enable this feature. This parameter has the following values: true: Enables this feature. false: Disables this feature.
    signedUrlAuthRules List<Property Map>
    Represents the configuration module for the 'URL authentication' feature. This feature is disabled by default.
    switch Boolean
    Indicates whether to enable this feature. This parameter has the following values: true: Enables this feature. false: Disables this feature.

    GetDomainSignedUrlAuthSignedUrlAuthRule

    Condition Byteplus.GetDomainSignedUrlAuthSignedUrlAuthRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    SignedUrlAuthAction Byteplus.GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthAction
    Indicates the configuration for signature calculation.
    Condition GetDomainSignedUrlAuthSignedUrlAuthRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    SignedUrlAuthAction GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthAction
    Indicates the configuration for signature calculation.
    condition GetDomainSignedUrlAuthSignedUrlAuthRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    signedUrlAuthAction GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthAction
    Indicates the configuration for signature calculation.
    condition GetDomainSignedUrlAuthSignedUrlAuthRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    signedUrlAuthAction GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthAction
    Indicates the configuration for signature calculation.
    condition GetDomainSignedUrlAuthSignedUrlAuthRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    signed_url_auth_action GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthAction
    Indicates the configuration for signature calculation.
    condition Property Map
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    signedUrlAuthAction Property Map
    Indicates the configuration for signature calculation.

    GetDomainSignedUrlAuthSignedUrlAuthRuleCondition

    ConditionRules List<Byteplus.GetDomainSignedUrlAuthSignedUrlAuthRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainSignedUrlAuthSignedUrlAuthRuleConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainSignedUrlAuthSignedUrlAuthRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainSignedUrlAuthSignedUrlAuthRuleConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainSignedUrlAuthSignedUrlAuthRuleConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainSignedUrlAuthSignedUrlAuthRuleConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthAction

    AuthAlgorithm string
    Indicates the algorithm used for signature calculation. This configuration has the following values: md5: MD5 algorithm. sha256: SHA-256 algorithm. The default value for this parameter is md5.
    BackupSecretKey string
    Indicates the backup secret key. The backup secret key must be 6–40 characters long and can contain any printable ASCII character except Delete (ASCII code 127).
    CustomVariableRules Byteplus.GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRules
    Indicates custom signature calculation variables.
    Duration int
    The validity period of the signature, in seconds. This parameter is used with the timestamp included in the request to calculate the expiration time of the signature. The value range for this parameter is 0–315,360,000. Signature expiration time = timestamp + Duration. When the content delivery network receives a request, if the signature expiration time is less than the current time, the content delivery network determines that the signature has expired.
    KeepOriginArg bool
    This parameter is not currently available to external users. Do not use this parameter.
    MasterSecretKey string
    Indicates the primary key, with a length of 6–40 characters. It can include printable ASCII characters except Delete (ASCII code 127)
    RewriteM3U8 bool
    Indicates whether the content delivery network adds signature parameters to the URL of each segment file in a .m3u8 file when responding to a .m3u8 file request. The signature for each segment URL is calculated based on the rewritten segment URL using the signature rules. The parameter values are as follows: true: enabled. false: disabled.
    RewriteM3U8Rule Byteplus.GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionRewriteM3U8Rule
    Specifies the configuration for the 'M3U8 Rewrite' feature. This configuration is valid only when both of the following conditions are met: RewriteM3u8 is true; URLAuthType is not typee.
    SignName string
    Indicates the name of the signature parameter. The length cannot exceed 100 characters. Parameter names are case-sensitive and can include letters, numbers, underscores (_), hyphens (-), commas (,), periods (.), and exclamation marks (!).
    SignatureRules List<string>
    When URLAuthType is set to typee, this parameter is required and specifies the fields to be included in the signature calculation. The following fields must be included in the signature calculation: key: the secret key, which is the parameter value for MasterSecretKey or BackupSecretKey. uri: the URI of the resource requested by the user. If the URI contains Chinese characters, you need to encode the URI. TimeName: the parameter value for the timestamp. The following fields can optionally be included in the signature calculation: domain: the acceleration domain name. referer: the referer value carried in the user's request. ua: the User-Agent value carried in the user's request. ip: the client IP of the user's request. origin: the Origin value carried in the user's request. Custom variables: the variable names you define in CustomVariableInstances. The order in which the fields are listed determines the order of values in MD5() during signature calculation.
    TimeFormat string
    Numeral system configuration. This parameter has the following values: decimal: decimal system; hexadecimal: hexadecimal system. When URLAuthType is typed or typee, this parameter is required. When URLAuthType is typec, regardless of your setting, this parameter is forcibly set to hexadecimal. For other URLAuthType values, this parameter is not effective.
    TimeName string
    Indicates the name of the timestamp parameter. The value of TimeName can include English letters, numbers, underscores (_), hyphens (-), periods (.), commas (,), and exclamation marks (!), with a length of 1–100 characters. TimeName cannot be the same as SignName. When URLAuthType is typed or typee, this parameter is required. For other types, this parameter does not apply.
    UrlAuthType string
    Signature type
    AuthAlgorithm string
    Indicates the algorithm used for signature calculation. This configuration has the following values: md5: MD5 algorithm. sha256: SHA-256 algorithm. The default value for this parameter is md5.
    BackupSecretKey string
    Indicates the backup secret key. The backup secret key must be 6–40 characters long and can contain any printable ASCII character except Delete (ASCII code 127).
    CustomVariableRules GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRules
    Indicates custom signature calculation variables.
    Duration int
    The validity period of the signature, in seconds. This parameter is used with the timestamp included in the request to calculate the expiration time of the signature. The value range for this parameter is 0–315,360,000. Signature expiration time = timestamp + Duration. When the content delivery network receives a request, if the signature expiration time is less than the current time, the content delivery network determines that the signature has expired.
    KeepOriginArg bool
    This parameter is not currently available to external users. Do not use this parameter.
    MasterSecretKey string
    Indicates the primary key, with a length of 6–40 characters. It can include printable ASCII characters except Delete (ASCII code 127)
    RewriteM3U8 bool
    Indicates whether the content delivery network adds signature parameters to the URL of each segment file in a .m3u8 file when responding to a .m3u8 file request. The signature for each segment URL is calculated based on the rewritten segment URL using the signature rules. The parameter values are as follows: true: enabled. false: disabled.
    RewriteM3U8Rule GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionRewriteM3U8Rule
    Specifies the configuration for the 'M3U8 Rewrite' feature. This configuration is valid only when both of the following conditions are met: RewriteM3u8 is true; URLAuthType is not typee.
    SignName string
    Indicates the name of the signature parameter. The length cannot exceed 100 characters. Parameter names are case-sensitive and can include letters, numbers, underscores (_), hyphens (-), commas (,), periods (.), and exclamation marks (!).
    SignatureRules []string
    When URLAuthType is set to typee, this parameter is required and specifies the fields to be included in the signature calculation. The following fields must be included in the signature calculation: key: the secret key, which is the parameter value for MasterSecretKey or BackupSecretKey. uri: the URI of the resource requested by the user. If the URI contains Chinese characters, you need to encode the URI. TimeName: the parameter value for the timestamp. The following fields can optionally be included in the signature calculation: domain: the acceleration domain name. referer: the referer value carried in the user's request. ua: the User-Agent value carried in the user's request. ip: the client IP of the user's request. origin: the Origin value carried in the user's request. Custom variables: the variable names you define in CustomVariableInstances. The order in which the fields are listed determines the order of values in MD5() during signature calculation.
    TimeFormat string
    Numeral system configuration. This parameter has the following values: decimal: decimal system; hexadecimal: hexadecimal system. When URLAuthType is typed or typee, this parameter is required. When URLAuthType is typec, regardless of your setting, this parameter is forcibly set to hexadecimal. For other URLAuthType values, this parameter is not effective.
    TimeName string
    Indicates the name of the timestamp parameter. The value of TimeName can include English letters, numbers, underscores (_), hyphens (-), periods (.), commas (,), and exclamation marks (!), with a length of 1–100 characters. TimeName cannot be the same as SignName. When URLAuthType is typed or typee, this parameter is required. For other types, this parameter does not apply.
    UrlAuthType string
    Signature type
    authAlgorithm String
    Indicates the algorithm used for signature calculation. This configuration has the following values: md5: MD5 algorithm. sha256: SHA-256 algorithm. The default value for this parameter is md5.
    backupSecretKey String
    Indicates the backup secret key. The backup secret key must be 6–40 characters long and can contain any printable ASCII character except Delete (ASCII code 127).
    customVariableRules GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRules
    Indicates custom signature calculation variables.
    duration Integer
    The validity period of the signature, in seconds. This parameter is used with the timestamp included in the request to calculate the expiration time of the signature. The value range for this parameter is 0–315,360,000. Signature expiration time = timestamp + Duration. When the content delivery network receives a request, if the signature expiration time is less than the current time, the content delivery network determines that the signature has expired.
    keepOriginArg Boolean
    This parameter is not currently available to external users. Do not use this parameter.
    masterSecretKey String
    Indicates the primary key, with a length of 6–40 characters. It can include printable ASCII characters except Delete (ASCII code 127)
    rewriteM3U8 Boolean
    Indicates whether the content delivery network adds signature parameters to the URL of each segment file in a .m3u8 file when responding to a .m3u8 file request. The signature for each segment URL is calculated based on the rewritten segment URL using the signature rules. The parameter values are as follows: true: enabled. false: disabled.
    rewriteM3U8Rule GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionRewriteM3U8Rule
    Specifies the configuration for the 'M3U8 Rewrite' feature. This configuration is valid only when both of the following conditions are met: RewriteM3u8 is true; URLAuthType is not typee.
    signName String
    Indicates the name of the signature parameter. The length cannot exceed 100 characters. Parameter names are case-sensitive and can include letters, numbers, underscores (_), hyphens (-), commas (,), periods (.), and exclamation marks (!).
    signatureRules List<String>
    When URLAuthType is set to typee, this parameter is required and specifies the fields to be included in the signature calculation. The following fields must be included in the signature calculation: key: the secret key, which is the parameter value for MasterSecretKey or BackupSecretKey. uri: the URI of the resource requested by the user. If the URI contains Chinese characters, you need to encode the URI. TimeName: the parameter value for the timestamp. The following fields can optionally be included in the signature calculation: domain: the acceleration domain name. referer: the referer value carried in the user's request. ua: the User-Agent value carried in the user's request. ip: the client IP of the user's request. origin: the Origin value carried in the user's request. Custom variables: the variable names you define in CustomVariableInstances. The order in which the fields are listed determines the order of values in MD5() during signature calculation.
    timeFormat String
    Numeral system configuration. This parameter has the following values: decimal: decimal system; hexadecimal: hexadecimal system. When URLAuthType is typed or typee, this parameter is required. When URLAuthType is typec, regardless of your setting, this parameter is forcibly set to hexadecimal. For other URLAuthType values, this parameter is not effective.
    timeName String
    Indicates the name of the timestamp parameter. The value of TimeName can include English letters, numbers, underscores (_), hyphens (-), periods (.), commas (,), and exclamation marks (!), with a length of 1–100 characters. TimeName cannot be the same as SignName. When URLAuthType is typed or typee, this parameter is required. For other types, this parameter does not apply.
    urlAuthType String
    Signature type
    authAlgorithm string
    Indicates the algorithm used for signature calculation. This configuration has the following values: md5: MD5 algorithm. sha256: SHA-256 algorithm. The default value for this parameter is md5.
    backupSecretKey string
    Indicates the backup secret key. The backup secret key must be 6–40 characters long and can contain any printable ASCII character except Delete (ASCII code 127).
    customVariableRules GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRules
    Indicates custom signature calculation variables.
    duration number
    The validity period of the signature, in seconds. This parameter is used with the timestamp included in the request to calculate the expiration time of the signature. The value range for this parameter is 0–315,360,000. Signature expiration time = timestamp + Duration. When the content delivery network receives a request, if the signature expiration time is less than the current time, the content delivery network determines that the signature has expired.
    keepOriginArg boolean
    This parameter is not currently available to external users. Do not use this parameter.
    masterSecretKey string
    Indicates the primary key, with a length of 6–40 characters. It can include printable ASCII characters except Delete (ASCII code 127)
    rewriteM3U8 boolean
    Indicates whether the content delivery network adds signature parameters to the URL of each segment file in a .m3u8 file when responding to a .m3u8 file request. The signature for each segment URL is calculated based on the rewritten segment URL using the signature rules. The parameter values are as follows: true: enabled. false: disabled.
    rewriteM3U8Rule GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionRewriteM3U8Rule
    Specifies the configuration for the 'M3U8 Rewrite' feature. This configuration is valid only when both of the following conditions are met: RewriteM3u8 is true; URLAuthType is not typee.
    signName string
    Indicates the name of the signature parameter. The length cannot exceed 100 characters. Parameter names are case-sensitive and can include letters, numbers, underscores (_), hyphens (-), commas (,), periods (.), and exclamation marks (!).
    signatureRules string[]
    When URLAuthType is set to typee, this parameter is required and specifies the fields to be included in the signature calculation. The following fields must be included in the signature calculation: key: the secret key, which is the parameter value for MasterSecretKey or BackupSecretKey. uri: the URI of the resource requested by the user. If the URI contains Chinese characters, you need to encode the URI. TimeName: the parameter value for the timestamp. The following fields can optionally be included in the signature calculation: domain: the acceleration domain name. referer: the referer value carried in the user's request. ua: the User-Agent value carried in the user's request. ip: the client IP of the user's request. origin: the Origin value carried in the user's request. Custom variables: the variable names you define in CustomVariableInstances. The order in which the fields are listed determines the order of values in MD5() during signature calculation.
    timeFormat string
    Numeral system configuration. This parameter has the following values: decimal: decimal system; hexadecimal: hexadecimal system. When URLAuthType is typed or typee, this parameter is required. When URLAuthType is typec, regardless of your setting, this parameter is forcibly set to hexadecimal. For other URLAuthType values, this parameter is not effective.
    timeName string
    Indicates the name of the timestamp parameter. The value of TimeName can include English letters, numbers, underscores (_), hyphens (-), periods (.), commas (,), and exclamation marks (!), with a length of 1–100 characters. TimeName cannot be the same as SignName. When URLAuthType is typed or typee, this parameter is required. For other types, this parameter does not apply.
    urlAuthType string
    Signature type
    auth_algorithm str
    Indicates the algorithm used for signature calculation. This configuration has the following values: md5: MD5 algorithm. sha256: SHA-256 algorithm. The default value for this parameter is md5.
    backup_secret_key str
    Indicates the backup secret key. The backup secret key must be 6–40 characters long and can contain any printable ASCII character except Delete (ASCII code 127).
    custom_variable_rules GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRules
    Indicates custom signature calculation variables.
    duration int
    The validity period of the signature, in seconds. This parameter is used with the timestamp included in the request to calculate the expiration time of the signature. The value range for this parameter is 0–315,360,000. Signature expiration time = timestamp + Duration. When the content delivery network receives a request, if the signature expiration time is less than the current time, the content delivery network determines that the signature has expired.
    keep_origin_arg bool
    This parameter is not currently available to external users. Do not use this parameter.
    master_secret_key str
    Indicates the primary key, with a length of 6–40 characters. It can include printable ASCII characters except Delete (ASCII code 127)
    rewrite_m3_u8 bool
    Indicates whether the content delivery network adds signature parameters to the URL of each segment file in a .m3u8 file when responding to a .m3u8 file request. The signature for each segment URL is calculated based on the rewritten segment URL using the signature rules. The parameter values are as follows: true: enabled. false: disabled.
    rewrite_m3_u8_rule GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionRewriteM3U8Rule
    Specifies the configuration for the 'M3U8 Rewrite' feature. This configuration is valid only when both of the following conditions are met: RewriteM3u8 is true; URLAuthType is not typee.
    sign_name str
    Indicates the name of the signature parameter. The length cannot exceed 100 characters. Parameter names are case-sensitive and can include letters, numbers, underscores (_), hyphens (-), commas (,), periods (.), and exclamation marks (!).
    signature_rules Sequence[str]
    When URLAuthType is set to typee, this parameter is required and specifies the fields to be included in the signature calculation. The following fields must be included in the signature calculation: key: the secret key, which is the parameter value for MasterSecretKey or BackupSecretKey. uri: the URI of the resource requested by the user. If the URI contains Chinese characters, you need to encode the URI. TimeName: the parameter value for the timestamp. The following fields can optionally be included in the signature calculation: domain: the acceleration domain name. referer: the referer value carried in the user's request. ua: the User-Agent value carried in the user's request. ip: the client IP of the user's request. origin: the Origin value carried in the user's request. Custom variables: the variable names you define in CustomVariableInstances. The order in which the fields are listed determines the order of values in MD5() during signature calculation.
    time_format str
    Numeral system configuration. This parameter has the following values: decimal: decimal system; hexadecimal: hexadecimal system. When URLAuthType is typed or typee, this parameter is required. When URLAuthType is typec, regardless of your setting, this parameter is forcibly set to hexadecimal. For other URLAuthType values, this parameter is not effective.
    time_name str
    Indicates the name of the timestamp parameter. The value of TimeName can include English letters, numbers, underscores (_), hyphens (-), periods (.), commas (,), and exclamation marks (!), with a length of 1–100 characters. TimeName cannot be the same as SignName. When URLAuthType is typed or typee, this parameter is required. For other types, this parameter does not apply.
    url_auth_type str
    Signature type
    authAlgorithm String
    Indicates the algorithm used for signature calculation. This configuration has the following values: md5: MD5 algorithm. sha256: SHA-256 algorithm. The default value for this parameter is md5.
    backupSecretKey String
    Indicates the backup secret key. The backup secret key must be 6–40 characters long and can contain any printable ASCII character except Delete (ASCII code 127).
    customVariableRules Property Map
    Indicates custom signature calculation variables.
    duration Number
    The validity period of the signature, in seconds. This parameter is used with the timestamp included in the request to calculate the expiration time of the signature. The value range for this parameter is 0–315,360,000. Signature expiration time = timestamp + Duration. When the content delivery network receives a request, if the signature expiration time is less than the current time, the content delivery network determines that the signature has expired.
    keepOriginArg Boolean
    This parameter is not currently available to external users. Do not use this parameter.
    masterSecretKey String
    Indicates the primary key, with a length of 6–40 characters. It can include printable ASCII characters except Delete (ASCII code 127)
    rewriteM3U8 Boolean
    Indicates whether the content delivery network adds signature parameters to the URL of each segment file in a .m3u8 file when responding to a .m3u8 file request. The signature for each segment URL is calculated based on the rewritten segment URL using the signature rules. The parameter values are as follows: true: enabled. false: disabled.
    rewriteM3U8Rule Property Map
    Specifies the configuration for the 'M3U8 Rewrite' feature. This configuration is valid only when both of the following conditions are met: RewriteM3u8 is true; URLAuthType is not typee.
    signName String
    Indicates the name of the signature parameter. The length cannot exceed 100 characters. Parameter names are case-sensitive and can include letters, numbers, underscores (_), hyphens (-), commas (,), periods (.), and exclamation marks (!).
    signatureRules List<String>
    When URLAuthType is set to typee, this parameter is required and specifies the fields to be included in the signature calculation. The following fields must be included in the signature calculation: key: the secret key, which is the parameter value for MasterSecretKey or BackupSecretKey. uri: the URI of the resource requested by the user. If the URI contains Chinese characters, you need to encode the URI. TimeName: the parameter value for the timestamp. The following fields can optionally be included in the signature calculation: domain: the acceleration domain name. referer: the referer value carried in the user's request. ua: the User-Agent value carried in the user's request. ip: the client IP of the user's request. origin: the Origin value carried in the user's request. Custom variables: the variable names you define in CustomVariableInstances. The order in which the fields are listed determines the order of values in MD5() during signature calculation.
    timeFormat String
    Numeral system configuration. This parameter has the following values: decimal: decimal system; hexadecimal: hexadecimal system. When URLAuthType is typed or typee, this parameter is required. When URLAuthType is typec, regardless of your setting, this parameter is forcibly set to hexadecimal. For other URLAuthType values, this parameter is not effective.
    timeName String
    Indicates the name of the timestamp parameter. The value of TimeName can include English letters, numbers, underscores (_), hyphens (-), periods (.), commas (,), and exclamation marks (!), with a length of 1–100 characters. TimeName cannot be the same as SignName. When URLAuthType is typed or typee, this parameter is required. For other types, this parameter does not apply.
    urlAuthType String
    Signature type

    GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRules

    GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRulesCustomVariableInstance

    Operator string
    Indicates the matching method for the variable. The value of this parameter can only be match.
    Type string
    Indicates the variable type. This parameter has the following values: queryString: indicates the variable is a query parameter in the request. requestHeader: indicates the variable is a header field in the request.
    Value string
    Specifies the variable name, with a maximum length of 100 characters. Variable name requirements are as follows: If Type is queryString, the variable name can include letters, numbers, hyphens (-), commas (,), periods (.), and exclamation marks (!). If Type is requestHeader, the variable name can include any printable ASCII character except: underscore (_), space, double quotes ("), colon (:), and Delete (ASCII code 127).
    Operator string
    Indicates the matching method for the variable. The value of this parameter can only be match.
    Type string
    Indicates the variable type. This parameter has the following values: queryString: indicates the variable is a query parameter in the request. requestHeader: indicates the variable is a header field in the request.
    Value string
    Specifies the variable name, with a maximum length of 100 characters. Variable name requirements are as follows: If Type is queryString, the variable name can include letters, numbers, hyphens (-), commas (,), periods (.), and exclamation marks (!). If Type is requestHeader, the variable name can include any printable ASCII character except: underscore (_), space, double quotes ("), colon (:), and Delete (ASCII code 127).
    operator String
    Indicates the matching method for the variable. The value of this parameter can only be match.
    type String
    Indicates the variable type. This parameter has the following values: queryString: indicates the variable is a query parameter in the request. requestHeader: indicates the variable is a header field in the request.
    value String
    Specifies the variable name, with a maximum length of 100 characters. Variable name requirements are as follows: If Type is queryString, the variable name can include letters, numbers, hyphens (-), commas (,), periods (.), and exclamation marks (!). If Type is requestHeader, the variable name can include any printable ASCII character except: underscore (_), space, double quotes ("), colon (:), and Delete (ASCII code 127).
    operator string
    Indicates the matching method for the variable. The value of this parameter can only be match.
    type string
    Indicates the variable type. This parameter has the following values: queryString: indicates the variable is a query parameter in the request. requestHeader: indicates the variable is a header field in the request.
    value string
    Specifies the variable name, with a maximum length of 100 characters. Variable name requirements are as follows: If Type is queryString, the variable name can include letters, numbers, hyphens (-), commas (,), periods (.), and exclamation marks (!). If Type is requestHeader, the variable name can include any printable ASCII character except: underscore (_), space, double quotes ("), colon (:), and Delete (ASCII code 127).
    operator str
    Indicates the matching method for the variable. The value of this parameter can only be match.
    type str
    Indicates the variable type. This parameter has the following values: queryString: indicates the variable is a query parameter in the request. requestHeader: indicates the variable is a header field in the request.
    value str
    Specifies the variable name, with a maximum length of 100 characters. Variable name requirements are as follows: If Type is queryString, the variable name can include letters, numbers, hyphens (-), commas (,), periods (.), and exclamation marks (!). If Type is requestHeader, the variable name can include any printable ASCII character except: underscore (_), space, double quotes ("), colon (:), and Delete (ASCII code 127).
    operator String
    Indicates the matching method for the variable. The value of this parameter can only be match.
    type String
    Indicates the variable type. This parameter has the following values: queryString: indicates the variable is a query parameter in the request. requestHeader: indicates the variable is a header field in the request.
    value String
    Specifies the variable name, with a maximum length of 100 characters. Variable name requirements are as follows: If Type is queryString, the variable name can include letters, numbers, hyphens (-), commas (,), periods (.), and exclamation marks (!). If Type is requestHeader, the variable name can include any printable ASCII character except: underscore (_), space, double quotes ("), colon (:), and Delete (ASCII code 127).

    GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionRewriteM3U8Rule

    DeleteParam bool
    Indicates whether to retain the original parameters in the URL when rewriting the shard URL. This parameter has the following values: true: removes the original parameters. false: retains the original parameters.
    KeepM3U8Param bool
    Indicates whether to add unsigned query parameters from the M3U8 file request to the segment URL. The parameter has the following options: true: add query parameters to the segment URL. false: do not add query parameters.
    DeleteParam bool
    Indicates whether to retain the original parameters in the URL when rewriting the shard URL. This parameter has the following values: true: removes the original parameters. false: retains the original parameters.
    KeepM3U8Param bool
    Indicates whether to add unsigned query parameters from the M3U8 file request to the segment URL. The parameter has the following options: true: add query parameters to the segment URL. false: do not add query parameters.
    deleteParam Boolean
    Indicates whether to retain the original parameters in the URL when rewriting the shard URL. This parameter has the following values: true: removes the original parameters. false: retains the original parameters.
    keepM3U8Param Boolean
    Indicates whether to add unsigned query parameters from the M3U8 file request to the segment URL. The parameter has the following options: true: add query parameters to the segment URL. false: do not add query parameters.
    deleteParam boolean
    Indicates whether to retain the original parameters in the URL when rewriting the shard URL. This parameter has the following values: true: removes the original parameters. false: retains the original parameters.
    keepM3U8Param boolean
    Indicates whether to add unsigned query parameters from the M3U8 file request to the segment URL. The parameter has the following options: true: add query parameters to the segment URL. false: do not add query parameters.
    delete_param bool
    Indicates whether to retain the original parameters in the URL when rewriting the shard URL. This parameter has the following values: true: removes the original parameters. false: retains the original parameters.
    keep_m3_u8_param bool
    Indicates whether to add unsigned query parameters from the M3U8 file request to the segment URL. The parameter has the following options: true: add query parameters to the segment URL. false: do not add query parameters.
    deleteParam Boolean
    Indicates whether to retain the original parameters in the URL when rewriting the shard URL. This parameter has the following values: true: removes the original parameters. false: retains the original parameters.
    keepM3U8Param Boolean
    Indicates whether to add unsigned query parameters from the M3U8 file request to the segment URL. The parameter has the following options: true: add query parameters to the segment URL. false: do not add query parameters.

    GetDomainTag

    Key string
    Tag key
    Value string
    Tag value.
    Key string
    Tag key
    Value string
    Tag value.
    key String
    Tag key
    value String
    Tag value.
    key string
    Tag key
    value string
    Tag value.
    key str
    Tag key
    value str
    Tag value.
    key String
    Tag key
    value String
    Tag value.

    GetDomainTimeout

    Switch bool
    Specify whether to enable origin timeout configuration. This parameter has the following values: true: enables origin timeout configuration. false: disables origin timeout configuration. In this case, the system default timeout values are used for TCP and HTTP requests, which are 2 seconds and 60 seconds respectively.
    TimeoutRules List<Byteplus.GetDomainTimeoutTimeoutRule>
    Represents a set of timeout configurations. Currently, you can specify only one configuration. This parameter is required when Switch is true.
    Switch bool
    Specify whether to enable origin timeout configuration. This parameter has the following values: true: enables origin timeout configuration. false: disables origin timeout configuration. In this case, the system default timeout values are used for TCP and HTTP requests, which are 2 seconds and 60 seconds respectively.
    TimeoutRules []GetDomainTimeoutTimeoutRule
    Represents a set of timeout configurations. Currently, you can specify only one configuration. This parameter is required when Switch is true.
    switch_ Boolean
    Specify whether to enable origin timeout configuration. This parameter has the following values: true: enables origin timeout configuration. false: disables origin timeout configuration. In this case, the system default timeout values are used for TCP and HTTP requests, which are 2 seconds and 60 seconds respectively.
    timeoutRules List<GetDomainTimeoutTimeoutRule>
    Represents a set of timeout configurations. Currently, you can specify only one configuration. This parameter is required when Switch is true.
    switch boolean
    Specify whether to enable origin timeout configuration. This parameter has the following values: true: enables origin timeout configuration. false: disables origin timeout configuration. In this case, the system default timeout values are used for TCP and HTTP requests, which are 2 seconds and 60 seconds respectively.
    timeoutRules GetDomainTimeoutTimeoutRule[]
    Represents a set of timeout configurations. Currently, you can specify only one configuration. This parameter is required when Switch is true.
    switch bool
    Specify whether to enable origin timeout configuration. This parameter has the following values: true: enables origin timeout configuration. false: disables origin timeout configuration. In this case, the system default timeout values are used for TCP and HTTP requests, which are 2 seconds and 60 seconds respectively.
    timeout_rules Sequence[GetDomainTimeoutTimeoutRule]
    Represents a set of timeout configurations. Currently, you can specify only one configuration. This parameter is required when Switch is true.
    switch Boolean
    Specify whether to enable origin timeout configuration. This parameter has the following values: true: enables origin timeout configuration. false: disables origin timeout configuration. In this case, the system default timeout values are used for TCP and HTTP requests, which are 2 seconds and 60 seconds respectively.
    timeoutRules List<Property Map>
    Represents a set of timeout configurations. Currently, you can specify only one configuration. This parameter is required when Switch is true.

    GetDomainTimeoutTimeoutRule

    Condition Byteplus.GetDomainTimeoutTimeoutRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    TimeoutAction Byteplus.GetDomainTimeoutTimeoutRuleTimeoutAction
    Indicates the timeout configuration.
    Condition GetDomainTimeoutTimeoutRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    TimeoutAction GetDomainTimeoutTimeoutRuleTimeoutAction
    Indicates the timeout configuration.
    condition GetDomainTimeoutTimeoutRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    timeoutAction GetDomainTimeoutTimeoutRuleTimeoutAction
    Indicates the timeout configuration.
    condition GetDomainTimeoutTimeoutRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    timeoutAction GetDomainTimeoutTimeoutRuleTimeoutAction
    Indicates the timeout configuration.
    condition GetDomainTimeoutTimeoutRuleCondition
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    timeout_action GetDomainTimeoutTimeoutRuleTimeoutAction
    Indicates the timeout configuration.
    condition Property Map
    Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
    timeoutAction Property Map
    Indicates the timeout configuration.

    GetDomainTimeoutTimeoutRuleCondition

    ConditionRules List<Byteplus.GetDomainTimeoutTimeoutRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    ConditionRules []GetDomainTimeoutTimeoutRuleConditionConditionRule
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    Connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<GetDomainTimeoutTimeoutRuleConditionConditionRule>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules GetDomainTimeoutTimeoutRuleConditionConditionRule[]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective string
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    condition_rules Sequence[GetDomainTimeoutTimeoutRuleConditionConditionRule]
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective str
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.
    conditionRules List<Property Map>
    Indicates a rule set. When a user request is received, the content delivery network matches the rules in the set to the request in order. If a rule matches the request, the content delivery network stops matching the remaining rules.
    connective String
    Represents the logical relationship between multiple ConditionRule entries. This parameter has the following values: AND: indicates the logical relationship is 'AND'. OR: indicates the logical relationship is 'OR'. The default value is OR.

    GetDomainTimeoutTimeoutRuleConditionConditionRule

    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    Name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    Object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    Operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    Type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    Value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name string
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object string
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator string
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type string
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value string
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name str
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object str
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator str
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type str
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value str
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).
    name String
    When Object is queryname or customize, this parameter is valid. If Object is queryname, this parameter indicates the name of a query parameter. If Object is customize, this parameter indicates the name of a custom header. The length of Name cannot exceed 256 characters and can include digits, letters, percent sign (%), underscore (_), and hyphen (-).
    object String
    Specifies the type of matching object. The content delivery network applies matching rules to objects of the specified type in the target. This parameter supports the following values: path: matches the path in the target. directory: matches the directory in the target. filetype: matches the file extension in the target.
    operator String
    Indicates the matching method. This parameter has the following value: match: If any value in Value exists, it is considered a match.
    type String
    Specifies the target type. The value of this parameter is url, indicating the target is a URL.
    value String
    Represents a set of values separated by semicolons (;). The total length must not exceed 1,024 characters. Printable ASCII characters are allowed, except for the following: consecutive slashes (//), spaces, dollar sign ($), question mark (?), and Delete (ASCII code 127). If any value in the set matches the request, it is considered a match. When Object is path, this parameter specifies one or more paths. Paths must start with a slash (/). You can use one or more asterisks () in the path, where each asterisk represents one or more characters. When Object is directory, this parameter specifies one or more directories. Directories must start and end with a slash (/). You can use one or more asterisks () in the directory, where each asterisk represents one or more characters. When Object is filetype, this parameter specifies one or more file extensions. Extensions do not need to start with a period (.).

    GetDomainTimeoutTimeoutRuleTimeoutAction

    HttpTimeout int
    Indicates the timeout period for HTTP requests. The value range for this parameter is 5–60.
    TcpTimeout int
    Indicates the timeout for TCP requests. The valid range for this parameter is 2–60.
    HttpTimeout int
    Indicates the timeout period for HTTP requests. The value range for this parameter is 5–60.
    TcpTimeout int
    Indicates the timeout for TCP requests. The valid range for this parameter is 2–60.
    httpTimeout Integer
    Indicates the timeout period for HTTP requests. The value range for this parameter is 5–60.
    tcpTimeout Integer
    Indicates the timeout for TCP requests. The valid range for this parameter is 2–60.
    httpTimeout number
    Indicates the timeout period for HTTP requests. The value range for this parameter is 5–60.
    tcpTimeout number
    Indicates the timeout for TCP requests. The valid range for this parameter is 2–60.
    http_timeout int
    Indicates the timeout period for HTTP requests. The value range for this parameter is 5–60.
    tcp_timeout int
    Indicates the timeout for TCP requests. The valid range for this parameter is 2–60.
    httpTimeout Number
    Indicates the timeout period for HTTP requests. The value range for this parameter is 5–60.
    tcpTimeout Number
    Indicates the timeout for TCP requests. The valid range for this parameter is 2–60.

    GetDomainUaAccessRule

    AllowEmpty bool
    Indicates whether requests with an empty UA ("") or without a UA field are allowed to access the acceleration domain. The parameter has the following values: true: allowed. false: not allowed. The default value is false.
    IgnoreCase bool
    Indicates whether the UA string is case-sensitive. The parameter has the following options: true: The UA string is case-insensitive. false: The UA string is case-sensitive. The default value for this parameter is false.
    RuleType string
    Specifies whether a denylist or allowlist is used. When Switch is true, this parameter is required. The parameter values are as follows: deny: specifies a denylist. allow: specifies an allowlist.
    Switch bool
    Indicates whether the UA allowlist and blocklist feature is enabled. This parameter has the following values: true: enabled. false: disabled.
    UserAgents List<string>
    Represents a list of UAs. When Switch is true, this parameter is required. The list can contain up to 1,000 UAs. The parameter details are as follows: The value length cannot exceed 30,000 characters. If RuleType is allow, only requests containing UAs in the list are permitted to access the acceleration domain. If RuleType is deny, requests containing UAs in the list are not permitted to access the acceleration domain. UA character restrictions are as follows: You can use * in a UA to represent one or more characters. * can only appear at the beginning or end of the UA. A UA cannot consist only of * or spaces. A UA can contain printable ASCII characters except Delete (ASCII code 127). If a UA contains symbols, the symbols must be HTML encoded.
    AllowEmpty bool
    Indicates whether requests with an empty UA ("") or without a UA field are allowed to access the acceleration domain. The parameter has the following values: true: allowed. false: not allowed. The default value is false.
    IgnoreCase bool
    Indicates whether the UA string is case-sensitive. The parameter has the following options: true: The UA string is case-insensitive. false: The UA string is case-sensitive. The default value for this parameter is false.
    RuleType string
    Specifies whether a denylist or allowlist is used. When Switch is true, this parameter is required. The parameter values are as follows: deny: specifies a denylist. allow: specifies an allowlist.
    Switch bool
    Indicates whether the UA allowlist and blocklist feature is enabled. This parameter has the following values: true: enabled. false: disabled.
    UserAgents []string
    Represents a list of UAs. When Switch is true, this parameter is required. The list can contain up to 1,000 UAs. The parameter details are as follows: The value length cannot exceed 30,000 characters. If RuleType is allow, only requests containing UAs in the list are permitted to access the acceleration domain. If RuleType is deny, requests containing UAs in the list are not permitted to access the acceleration domain. UA character restrictions are as follows: You can use * in a UA to represent one or more characters. * can only appear at the beginning or end of the UA. A UA cannot consist only of * or spaces. A UA can contain printable ASCII characters except Delete (ASCII code 127). If a UA contains symbols, the symbols must be HTML encoded.
    allowEmpty Boolean
    Indicates whether requests with an empty UA ("") or without a UA field are allowed to access the acceleration domain. The parameter has the following values: true: allowed. false: not allowed. The default value is false.
    ignoreCase Boolean
    Indicates whether the UA string is case-sensitive. The parameter has the following options: true: The UA string is case-insensitive. false: The UA string is case-sensitive. The default value for this parameter is false.
    ruleType String
    Specifies whether a denylist or allowlist is used. When Switch is true, this parameter is required. The parameter values are as follows: deny: specifies a denylist. allow: specifies an allowlist.
    switch_ Boolean
    Indicates whether the UA allowlist and blocklist feature is enabled. This parameter has the following values: true: enabled. false: disabled.
    userAgents List<String>
    Represents a list of UAs. When Switch is true, this parameter is required. The list can contain up to 1,000 UAs. The parameter details are as follows: The value length cannot exceed 30,000 characters. If RuleType is allow, only requests containing UAs in the list are permitted to access the acceleration domain. If RuleType is deny, requests containing UAs in the list are not permitted to access the acceleration domain. UA character restrictions are as follows: You can use * in a UA to represent one or more characters. * can only appear at the beginning or end of the UA. A UA cannot consist only of * or spaces. A UA can contain printable ASCII characters except Delete (ASCII code 127). If a UA contains symbols, the symbols must be HTML encoded.
    allowEmpty boolean
    Indicates whether requests with an empty UA ("") or without a UA field are allowed to access the acceleration domain. The parameter has the following values: true: allowed. false: not allowed. The default value is false.
    ignoreCase boolean
    Indicates whether the UA string is case-sensitive. The parameter has the following options: true: The UA string is case-insensitive. false: The UA string is case-sensitive. The default value for this parameter is false.
    ruleType string
    Specifies whether a denylist or allowlist is used. When Switch is true, this parameter is required. The parameter values are as follows: deny: specifies a denylist. allow: specifies an allowlist.
    switch boolean
    Indicates whether the UA allowlist and blocklist feature is enabled. This parameter has the following values: true: enabled. false: disabled.
    userAgents string[]
    Represents a list of UAs. When Switch is true, this parameter is required. The list can contain up to 1,000 UAs. The parameter details are as follows: The value length cannot exceed 30,000 characters. If RuleType is allow, only requests containing UAs in the list are permitted to access the acceleration domain. If RuleType is deny, requests containing UAs in the list are not permitted to access the acceleration domain. UA character restrictions are as follows: You can use * in a UA to represent one or more characters. * can only appear at the beginning or end of the UA. A UA cannot consist only of * or spaces. A UA can contain printable ASCII characters except Delete (ASCII code 127). If a UA contains symbols, the symbols must be HTML encoded.
    allow_empty bool
    Indicates whether requests with an empty UA ("") or without a UA field are allowed to access the acceleration domain. The parameter has the following values: true: allowed. false: not allowed. The default value is false.
    ignore_case bool
    Indicates whether the UA string is case-sensitive. The parameter has the following options: true: The UA string is case-insensitive. false: The UA string is case-sensitive. The default value for this parameter is false.
    rule_type str
    Specifies whether a denylist or allowlist is used. When Switch is true, this parameter is required. The parameter values are as follows: deny: specifies a denylist. allow: specifies an allowlist.
    switch bool
    Indicates whether the UA allowlist and blocklist feature is enabled. This parameter has the following values: true: enabled. false: disabled.
    user_agents Sequence[str]
    Represents a list of UAs. When Switch is true, this parameter is required. The list can contain up to 1,000 UAs. The parameter details are as follows: The value length cannot exceed 30,000 characters. If RuleType is allow, only requests containing UAs in the list are permitted to access the acceleration domain. If RuleType is deny, requests containing UAs in the list are not permitted to access the acceleration domain. UA character restrictions are as follows: You can use * in a UA to represent one or more characters. * can only appear at the beginning or end of the UA. A UA cannot consist only of * or spaces. A UA can contain printable ASCII characters except Delete (ASCII code 127). If a UA contains symbols, the symbols must be HTML encoded.
    allowEmpty Boolean
    Indicates whether requests with an empty UA ("") or without a UA field are allowed to access the acceleration domain. The parameter has the following values: true: allowed. false: not allowed. The default value is false.
    ignoreCase Boolean
    Indicates whether the UA string is case-sensitive. The parameter has the following options: true: The UA string is case-insensitive. false: The UA string is case-sensitive. The default value for this parameter is false.
    ruleType String
    Specifies whether a denylist or allowlist is used. When Switch is true, this parameter is required. The parameter values are as follows: deny: specifies a denylist. allow: specifies an allowlist.
    switch Boolean
    Indicates whether the UA allowlist and blocklist feature is enabled. This parameter has the following values: true: enabled. false: disabled.
    userAgents List<String>
    Represents a list of UAs. When Switch is true, this parameter is required. The list can contain up to 1,000 UAs. The parameter details are as follows: The value length cannot exceed 30,000 characters. If RuleType is allow, only requests containing UAs in the list are permitted to access the acceleration domain. If RuleType is deny, requests containing UAs in the list are not permitted to access the acceleration domain. UA character restrictions are as follows: You can use * in a UA to represent one or more characters. * can only appear at the beginning or end of the UA. A UA cannot consist only of * or spaces. A UA can contain printable ASCII characters except Delete (ASCII code 127). If a UA contains symbols, the symbols must be HTML encoded.

    GetDomainUrlNormalize

    NormalizeObjects List<string>
    This specifies the list of URL normalization options you need to enable. When Switch is true, this parameter is required. The list can include the following options: dotsegments: replaces the following in the request URL: /./: replaced with a single slash (/). /../: if there is a directory level before /../, removes /../ and that directory. If there is no directory before /../, the original URL is retained. backslashes: replaces backslashes () in the request URL with a single slash (/). successive_slashes: replaces consecutive slashes (//) in the request URL with a single slash (/).
    Switch bool
    This specifies the list of URL normalization options you need to enable. When Switch is true, this parameter is required. The list can include the following options: dotsegments: replaces the following in the request URL: /./: replaced with a single slash (/). /../: if there is a directory level before /../, removes /../ and that directory. If there is no directory before /../, the original URL is retained. backslashes: replaces backslashes () in the request URL with a single slash (/). successive_slashes: replaces consecutive slashes (//) in the request URL with a single slash (/).
    NormalizeObjects []string
    This specifies the list of URL normalization options you need to enable. When Switch is true, this parameter is required. The list can include the following options: dotsegments: replaces the following in the request URL: /./: replaced with a single slash (/). /../: if there is a directory level before /../, removes /../ and that directory. If there is no directory before /../, the original URL is retained. backslashes: replaces backslashes () in the request URL with a single slash (/). successive_slashes: replaces consecutive slashes (//) in the request URL with a single slash (/).
    Switch bool
    This specifies the list of URL normalization options you need to enable. When Switch is true, this parameter is required. The list can include the following options: dotsegments: replaces the following in the request URL: /./: replaced with a single slash (/). /../: if there is a directory level before /../, removes /../ and that directory. If there is no directory before /../, the original URL is retained. backslashes: replaces backslashes () in the request URL with a single slash (/). successive_slashes: replaces consecutive slashes (//) in the request URL with a single slash (/).
    normalizeObjects List<String>
    This specifies the list of URL normalization options you need to enable. When Switch is true, this parameter is required. The list can include the following options: dotsegments: replaces the following in the request URL: /./: replaced with a single slash (/). /../: if there is a directory level before /../, removes /../ and that directory. If there is no directory before /../, the original URL is retained. backslashes: replaces backslashes () in the request URL with a single slash (/). successive_slashes: replaces consecutive slashes (//) in the request URL with a single slash (/).
    switch_ Boolean
    This specifies the list of URL normalization options you need to enable. When Switch is true, this parameter is required. The list can include the following options: dotsegments: replaces the following in the request URL: /./: replaced with a single slash (/). /../: if there is a directory level before /../, removes /../ and that directory. If there is no directory before /../, the original URL is retained. backslashes: replaces backslashes () in the request URL with a single slash (/). successive_slashes: replaces consecutive slashes (//) in the request URL with a single slash (/).
    normalizeObjects string[]
    This specifies the list of URL normalization options you need to enable. When Switch is true, this parameter is required. The list can include the following options: dotsegments: replaces the following in the request URL: /./: replaced with a single slash (/). /../: if there is a directory level before /../, removes /../ and that directory. If there is no directory before /../, the original URL is retained. backslashes: replaces backslashes () in the request URL with a single slash (/). successive_slashes: replaces consecutive slashes (//) in the request URL with a single slash (/).
    switch boolean
    This specifies the list of URL normalization options you need to enable. When Switch is true, this parameter is required. The list can include the following options: dotsegments: replaces the following in the request URL: /./: replaced with a single slash (/). /../: if there is a directory level before /../, removes /../ and that directory. If there is no directory before /../, the original URL is retained. backslashes: replaces backslashes () in the request URL with a single slash (/). successive_slashes: replaces consecutive slashes (//) in the request URL with a single slash (/).
    normalize_objects Sequence[str]
    This specifies the list of URL normalization options you need to enable. When Switch is true, this parameter is required. The list can include the following options: dotsegments: replaces the following in the request URL: /./: replaced with a single slash (/). /../: if there is a directory level before /../, removes /../ and that directory. If there is no directory before /../, the original URL is retained. backslashes: replaces backslashes () in the request URL with a single slash (/). successive_slashes: replaces consecutive slashes (//) in the request URL with a single slash (/).
    switch bool
    This specifies the list of URL normalization options you need to enable. When Switch is true, this parameter is required. The list can include the following options: dotsegments: replaces the following in the request URL: /./: replaced with a single slash (/). /../: if there is a directory level before /../, removes /../ and that directory. If there is no directory before /../, the original URL is retained. backslashes: replaces backslashes () in the request URL with a single slash (/). successive_slashes: replaces consecutive slashes (//) in the request URL with a single slash (/).
    normalizeObjects List<String>
    This specifies the list of URL normalization options you need to enable. When Switch is true, this parameter is required. The list can include the following options: dotsegments: replaces the following in the request URL: /./: replaced with a single slash (/). /../: if there is a directory level before /../, removes /../ and that directory. If there is no directory before /../, the original URL is retained. backslashes: replaces backslashes () in the request URL with a single slash (/). successive_slashes: replaces consecutive slashes (//) in the request URL with a single slash (/).
    switch Boolean
    This specifies the list of URL normalization options you need to enable. When Switch is true, this parameter is required. The list can include the following options: dotsegments: replaces the following in the request URL: /./: replaced with a single slash (/). /../: if there is a directory level before /../, removes /../ and that directory. If there is no directory before /../, the original URL is retained. backslashes: replaces backslashes () in the request URL with a single slash (/). successive_slashes: replaces consecutive slashes (//) in the request URL with a single slash (/).

    GetDomainVideoDrag

    Switch bool
    Smart compression configuration switch. The parameter has the following options: true: enable video seeking. false: disable video seeking.
    Switch bool
    Smart compression configuration switch. The parameter has the following options: true: enable video seeking. false: disable video seeking.
    switch_ Boolean
    Smart compression configuration switch. The parameter has the following options: true: enable video seeking. false: disable video seeking.
    switch boolean
    Smart compression configuration switch. The parameter has the following options: true: enable video seeking. false: disable video seeking.
    switch bool
    Smart compression configuration switch. The parameter has the following options: true: enable video seeking. false: disable video seeking.
    switch Boolean
    Smart compression configuration switch. The parameter has the following options: true: enable video seeking. false: disable video seeking.

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.21
    published on Thursday, Apr 2, 2026 by Byteplus
      Try Pulumi Cloud free. Your team will thank you.