Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
published on Thursday, Apr 2, 2026 by Byteplus
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
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 dictionaryThe 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:
- Area
Access Byteplus.Rule Get Domain Area Access Rule - Indicates the configuration module for the 'regional access control' feature. This feature is disabled by default.
- Backup
Origins 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.
- Browser
Caches List<Byteplus.Get Domain Browser Cach> - 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 Byteplus.Get Domain Cache Host - Specifies the configuration module for the 'shared cache' feature. This feature is disabled by default.
- Cache
Keys List<Byteplus.Get Domain Cache Key> - 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.
- 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 ('').
- 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.
Get Domain Cach> - 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.
Get Domain Compression - Represents the configuration module for the 'Smart Compression' feature. This feature is disabled by default.
- Conditional
Origin Byteplus.Get Domain Conditional Origin - 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 Byteplus.Page Get Domain Custom Error Page - Indicates the configuration module for the "Custom Error Page" feature. This feature is disabled by default.
- Customize
Access Byteplus.Rule Get Domain Customize Access Rule - 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.
- Domain
Lock Byteplus.Get Domain Domain Lock - Indicates the lock status of this domain name.
- Download
Speed Byteplus.Limit Get Domain Download Speed Limit - 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 Byteplus.Redirect Get Domain Http Forced Redirect - Represents the configuration module for the 'Force HTTPS Redirect to HTTP' feature. This feature is disabled by default.
- Https
Byteplus.
Get Domain Https - Indicates the HTTPS configuration module. This feature is disabled by default.
- IPv6
Byteplus.
Get Domain IPv6 - Indicates the configuration module for the IPv6 feature.
- Id string
- Uniquely identifies the resource.
- Ip
Access Byteplus.Rule Get Domain Ip Access Rule - 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 boolDomain - 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 string - Indicates whether the configuration for this domain name can be changed. The parameter values are: on: Allowed. off: Not allowed.
- Method
Denied Byteplus.Rule Get Domain Method Denied Rule - Represents the configuration module for the 'Disable HTTP Method' feature. This feature is disabled by default.
- Multi
Range Byteplus.Get Domain Multi Range - Indicates the configuration module for the multi-range feature. This feature is disabled by default
- Negative
Caches List<Byteplus.Get Domain Negative Cach> - 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 Byteplus.Get Domain Offline Cache - Indicates the configuration module for the 'offline cache' feature.
- Origin
Access Byteplus.Rule Get Domain Origin Access Rule - Indicates the configuration module for the 'Origin allowlist and blacklist' feature. This feature is disabled by default.
- Origin
Args List<Byteplus.Get Domain Origin Arg> - 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 Byteplus.Check Get Domain Origin Cert Check - Origin certificate validation
- Origin
Host 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.
- Origin
IPv6 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.
- Origin
Protocol 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.
- 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 Byteplus.Get Domain Origin Retry - Indicates the configuration module for the "origin fetch retry settings" feature.
- Origin
Rewrite Byteplus.Get Domain Origin Rewrite - Indicates the configuration module for the 'Origin URL Rewrite' feature.
- Origin
Sni Byteplus.Get Domain Origin Sni - Indicates the configuration module for the 'origin SNI' feature.
- Origins
List<Byteplus.
Get Domain Origin> - Indicates the basic origin configuration module.
- Page
Optimization Byteplus.Get Domain Page Optimization - Specifies the configuration module for the 'page optimization' feature.
- Primary
Origins 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.
Get Domain Quic - Indicates the configuration module for the QUIC feature. This feature is disabled by default.
- Redirection
Rewrite Byteplus.Get Domain Redirection Rewrite - Represents the configuration module for the 'URL Redirect Rewrite' feature. This feature is disabled by default.
- Referer
Access Byteplus.Rule Get Domain Referer Access Rule - Indicates the configuration module for the "Referer Allowlist and Denylist" feature. This feature is disabled by default.
- Remote
Auth Byteplus.Get Domain Remote Auth - Indicates the configuration module for the 'remote authentication' feature. This feature is disabled by default.
- Request
Block Byteplus.Rule Get Domain Request Block Rule - Indicates the configuration module for the 'Custom Interception' feature. This feature is disabled by default
- Request
Headers List<Byteplus.Get Domain Request Header> - Indicates the configuration module for the 'origin HTTP request header' feature. This feature is disabled by default.
- Response
Headers List<Byteplus.Get Domain Response Header> - Indicates the configuration module for the 'HTTP response header' feature. This feature is disabled by default.
- Rewrite
Hls Byteplus.Get Domain Rewrite Hls - Indicates the configuration module for the "Standard HLS Encryption Rewrite" feature. This feature is disabled by default.
- Service
Region 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).
- Service
Type 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.
- Signed
Url Byteplus.Auth Get Domain Signed Url Auth - 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.
-
List<Byteplus.
Get Domain Tag> - Tag information
- Timeout
Byteplus.
Get Domain Timeout - Indicates the configuration module for the 'origin timeout' feature. This feature is disabled by default.
- Ua
Access Byteplus.Rule Get Domain Ua Access Rule - 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 Byteplus.Get Domain Url Normalize - Specifies the configuration module for the 'URL normalization' feature. This feature is disabled by default.
- Video
Drag Byteplus.Get Domain Video Drag - Indicates the configuration module for the "Video Drag" feature. This feature is disabled by default.
- Area
Access GetRule Domain Area Access Rule - Indicates the configuration module for the 'regional access control' feature. This feature is disabled by default.
- Backup
Origins []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.
- Browser
Caches []GetDomain Browser Cach - 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 GetDomain Cache Host - Specifies the configuration module for the 'shared cache' feature. This feature is disabled by default.
- Cache
Keys []GetDomain Cache Key - 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.
- 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 ('').
- 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
[]Get
Domain Cach - 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
Get
Domain Compression - Represents the configuration module for the 'Smart Compression' feature. This feature is disabled by default.
- Conditional
Origin GetDomain Conditional Origin - 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 GetPage Domain Custom Error Page - Indicates the configuration module for the "Custom Error Page" feature. This feature is disabled by default.
- Customize
Access GetRule Domain Customize Access Rule - 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.
- Domain
Lock GetDomain Domain Lock - Indicates the lock status of this domain name.
- Download
Speed GetLimit Domain Download Speed Limit - 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 GetRedirect Domain Http Forced Redirect - Represents the configuration module for the 'Force HTTPS Redirect to HTTP' feature. This feature is disabled by default.
- Https
Get
Domain Https - Indicates the HTTPS configuration module. This feature is disabled by default.
- IPv6
Get
Domain IPv6 - Indicates the configuration module for the IPv6 feature.
- Id string
- Uniquely identifies the resource.
- Ip
Access GetRule Domain Ip Access Rule - 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 boolDomain - 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 string - Indicates whether the configuration for this domain name can be changed. The parameter values are: on: Allowed. off: Not allowed.
- Method
Denied GetRule Domain Method Denied Rule - Represents the configuration module for the 'Disable HTTP Method' feature. This feature is disabled by default.
- Multi
Range GetDomain Multi Range - Indicates the configuration module for the multi-range feature. This feature is disabled by default
- Negative
Caches []GetDomain Negative Cach - 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 GetDomain Offline Cache - Indicates the configuration module for the 'offline cache' feature.
- Origin
Access GetRule Domain Origin Access Rule - Indicates the configuration module for the 'Origin allowlist and blacklist' feature. This feature is disabled by default.
- Origin
Args []GetDomain Origin Arg - 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 GetCheck Domain Origin Cert Check - Origin certificate validation
- Origin
Host 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.
- Origin
IPv6 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.
- Origin
Protocol 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.
- 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 GetDomain Origin Retry - Indicates the configuration module for the "origin fetch retry settings" feature.
- Origin
Rewrite GetDomain Origin Rewrite - Indicates the configuration module for the 'Origin URL Rewrite' feature.
- Origin
Sni GetDomain Origin Sni - Indicates the configuration module for the 'origin SNI' feature.
- Origins
[]Get
Domain Origin - Indicates the basic origin configuration module.
- Page
Optimization GetDomain Page Optimization - Specifies the configuration module for the 'page optimization' feature.
- Primary
Origins []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
Get
Domain Quic - Indicates the configuration module for the QUIC feature. This feature is disabled by default.
- Redirection
Rewrite GetDomain Redirection Rewrite - Represents the configuration module for the 'URL Redirect Rewrite' feature. This feature is disabled by default.
- Referer
Access GetRule Domain Referer Access Rule - Indicates the configuration module for the "Referer Allowlist and Denylist" feature. This feature is disabled by default.
- Remote
Auth GetDomain Remote Auth - Indicates the configuration module for the 'remote authentication' feature. This feature is disabled by default.
- Request
Block GetRule Domain Request Block Rule - Indicates the configuration module for the 'Custom Interception' feature. This feature is disabled by default
- Request
Headers []GetDomain Request Header - Indicates the configuration module for the 'origin HTTP request header' feature. This feature is disabled by default.
- Response
Headers []GetDomain Response Header - Indicates the configuration module for the 'HTTP response header' feature. This feature is disabled by default.
- Rewrite
Hls GetDomain Rewrite Hls - Indicates the configuration module for the "Standard HLS Encryption Rewrite" feature. This feature is disabled by default.
- Service
Region 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).
- Service
Type 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.
- Signed
Url GetAuth Domain Signed Url Auth - 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.
-
[]Get
Domain Tag - Tag information
- Timeout
Get
Domain Timeout - Indicates the configuration module for the 'origin timeout' feature. This feature is disabled by default.
- Ua
Access GetRule Domain Ua Access Rule - 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 GetDomain Url Normalize - Specifies the configuration module for the 'URL normalization' feature. This feature is disabled by default.
- Video
Drag GetDomain Video Drag - Indicates the configuration module for the "Video Drag" feature. This feature is disabled by default.
- area
Access GetRule Domain Area Access Rule - Indicates the configuration module for the 'regional access control' feature. This feature is disabled by default.
- backup
Origins 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.
- browser
Caches List<GetDomain Browser Cach> - 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 GetDomain Cache Host - Specifies the configuration module for the 'shared cache' feature. This feature is disabled by default.
- cache
Keys List<GetDomain Cache Key> - 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.
- 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 ('').
- 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<Get
Domain Cach> - 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
Get
Domain Compression - Represents the configuration module for the 'Smart Compression' feature. This feature is disabled by default.
- conditional
Origin GetDomain Conditional Origin - Specifies the configuration module for the 'Conditional Origin' feature.
- created
Time Integer - Indicates the creation time of this accelerated domain name, in Unix timestamp format.
- custom
Error GetPage Domain Custom Error Page - Indicates the configuration module for the "Custom Error Page" feature. This feature is disabled by default.
- customize
Access GetRule Domain Customize Access Rule - 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.
- domain
Lock GetDomain Domain Lock - Indicates the lock status of this domain name.
- download
Speed GetLimit Domain Download Speed Limit - Represents the configuration module for the 'Download Speed Limit' feature. This feature is disabled by default.
- follow
Redirect 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.
- http
Forced GetRedirect Domain Http Forced Redirect - Represents the configuration module for the 'Force HTTPS Redirect to HTTP' feature. This feature is disabled by default.
- https
Get
Domain Https - Indicates the HTTPS configuration module. This feature is disabled by default.
- i
Pv6 GetDomain IPv6 - Indicates the configuration module for the IPv6 feature.
- id String
- Uniquely identifies the resource.
- ip
Access GetRule Domain Ip Access Rule - 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 BooleanDomain - 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 String - Indicates whether the configuration for this domain name can be changed. The parameter values are: on: Allowed. off: Not allowed.
- method
Denied GetRule Domain Method Denied Rule - Represents the configuration module for the 'Disable HTTP Method' feature. This feature is disabled by default.
- multi
Range GetDomain Multi Range - Indicates the configuration module for the multi-range feature. This feature is disabled by default
- negative
Caches List<GetDomain Negative Cach> - 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 GetDomain Offline Cache - Indicates the configuration module for the 'offline cache' feature.
- origin
Access GetRule Domain Origin Access Rule - Indicates the configuration module for the 'Origin allowlist and blacklist' feature. This feature is disabled by default.
- origin
Args List<GetDomain Origin Arg> - 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 GetCheck Domain Origin Cert Check - Origin certificate validation
- origin
Host 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.
- origin
IPv6 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.
- origin
Protocol 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.
- origin
Range 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.
- origin
Retry GetDomain Origin Retry - Indicates the configuration module for the "origin fetch retry settings" feature.
- origin
Rewrite GetDomain Origin Rewrite - Indicates the configuration module for the 'Origin URL Rewrite' feature.
- origin
Sni GetDomain Origin Sni - Indicates the configuration module for the 'origin SNI' feature.
- origins
List<Get
Domain Origin> - Indicates the basic origin configuration module.
- page
Optimization GetDomain Page Optimization - Specifies the configuration module for the 'page optimization' feature.
- primary
Origins 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
Get
Domain Quic - Indicates the configuration module for the QUIC feature. This feature is disabled by default.
- redirection
Rewrite GetDomain Redirection Rewrite - Represents the configuration module for the 'URL Redirect Rewrite' feature. This feature is disabled by default.
- referer
Access GetRule Domain Referer Access Rule - Indicates the configuration module for the "Referer Allowlist and Denylist" feature. This feature is disabled by default.
- remote
Auth GetDomain Remote Auth - Indicates the configuration module for the 'remote authentication' feature. This feature is disabled by default.
- request
Block GetRule Domain Request Block Rule - Indicates the configuration module for the 'Custom Interception' feature. This feature is disabled by default
- request
Headers List<GetDomain Request Header> - Indicates the configuration module for the 'origin HTTP request header' feature. This feature is disabled by default.
- response
Headers List<GetDomain Response Header> - Indicates the configuration module for the 'HTTP response header' feature. This feature is disabled by default.
- rewrite
Hls GetDomain Rewrite Hls - Indicates the configuration module for the "Standard HLS Encryption Rewrite" feature. This feature is disabled by default.
- service
Region 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).
- service
Type 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.
- signed
Url GetAuth Domain Signed Url Auth - 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.
-
List<Get
Domain Tag> - Tag information
- timeout
Get
Domain Timeout - Indicates the configuration module for the 'origin timeout' feature. This feature is disabled by default.
- ua
Access GetRule Domain Ua Access Rule - Indicates the configuration module for the "UA allowlist and blocklist" feature. This feature is disabled by default.
- updated
Time Integer - Indicates the most recent update time for this domain configuration, in Unix timestamp format.
- url
Normalize GetDomain Url Normalize - Specifies the configuration module for the 'URL normalization' feature. This feature is disabled by default.
- video
Drag GetDomain Video Drag - Indicates the configuration module for the "Video Drag" feature. This feature is disabled by default.
- area
Access GetRule Domain Area Access Rule - Indicates the configuration module for the 'regional access control' feature. This feature is disabled by default.
- backup
Origins 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.
- browser
Caches GetDomain Browser Cach[] - 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 GetDomain Cache Host - Specifies the configuration module for the 'shared cache' feature. This feature is disabled by default.
- cache
Keys GetDomain Cache Key[] - 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.
- 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 ('').
- 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
Get
Domain Cach[] - 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
Get
Domain Compression - Represents the configuration module for the 'Smart Compression' feature. This feature is disabled by default.
- conditional
Origin GetDomain Conditional Origin - Specifies the configuration module for the 'Conditional Origin' feature.
- created
Time number - Indicates the creation time of this accelerated domain name, in Unix timestamp format.
- custom
Error GetPage Domain Custom Error Page - Indicates the configuration module for the "Custom Error Page" feature. This feature is disabled by default.
- customize
Access GetRule Domain Customize Access Rule - 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.
- domain
Lock GetDomain Domain Lock - Indicates the lock status of this domain name.
- download
Speed GetLimit Domain Download Speed Limit - Represents the configuration module for the 'Download Speed Limit' feature. This feature is disabled by default.
- follow
Redirect 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.
- http
Forced GetRedirect Domain Http Forced Redirect - Represents the configuration module for the 'Force HTTPS Redirect to HTTP' feature. This feature is disabled by default.
- https
Get
Domain Https - Indicates the HTTPS configuration module. This feature is disabled by default.
- i
Pv6 GetDomain IPv6 - Indicates the configuration module for the IPv6 feature.
- id string
- Uniquely identifies the resource.
- ip
Access GetRule Domain Ip Access Rule - 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 booleanDomain - 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 string - Indicates whether the configuration for this domain name can be changed. The parameter values are: on: Allowed. off: Not allowed.
- method
Denied GetRule Domain Method Denied Rule - Represents the configuration module for the 'Disable HTTP Method' feature. This feature is disabled by default.
- multi
Range GetDomain Multi Range - Indicates the configuration module for the multi-range feature. This feature is disabled by default
- negative
Caches GetDomain Negative Cach[] - 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 GetDomain Offline Cache - Indicates the configuration module for the 'offline cache' feature.
- origin
Access GetRule Domain Origin Access Rule - Indicates the configuration module for the 'Origin allowlist and blacklist' feature. This feature is disabled by default.
- origin
Args GetDomain Origin Arg[] - 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 GetCheck Domain Origin Cert Check - Origin certificate validation
- origin
Host 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.
- origin
IPv6 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.
- origin
Protocol 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.
- origin
Range 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.
- origin
Retry GetDomain Origin Retry - Indicates the configuration module for the "origin fetch retry settings" feature.
- origin
Rewrite GetDomain Origin Rewrite - Indicates the configuration module for the 'Origin URL Rewrite' feature.
- origin
Sni GetDomain Origin Sni - Indicates the configuration module for the 'origin SNI' feature.
- origins
Get
Domain Origin[] - Indicates the basic origin configuration module.
- page
Optimization GetDomain Page Optimization - Specifies the configuration module for the 'page optimization' feature.
- primary
Origins 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
Get
Domain Quic - Indicates the configuration module for the QUIC feature. This feature is disabled by default.
- redirection
Rewrite GetDomain Redirection Rewrite - Represents the configuration module for the 'URL Redirect Rewrite' feature. This feature is disabled by default.
- referer
Access GetRule Domain Referer Access Rule - Indicates the configuration module for the "Referer Allowlist and Denylist" feature. This feature is disabled by default.
- remote
Auth GetDomain Remote Auth - Indicates the configuration module for the 'remote authentication' feature. This feature is disabled by default.
- request
Block GetRule Domain Request Block Rule - Indicates the configuration module for the 'Custom Interception' feature. This feature is disabled by default
- request
Headers GetDomain Request Header[] - Indicates the configuration module for the 'origin HTTP request header' feature. This feature is disabled by default.
- response
Headers GetDomain Response Header[] - Indicates the configuration module for the 'HTTP response header' feature. This feature is disabled by default.
- rewrite
Hls GetDomain Rewrite Hls - Indicates the configuration module for the "Standard HLS Encryption Rewrite" feature. This feature is disabled by default.
- service
Region 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).
- service
Type 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.
- signed
Url GetAuth Domain Signed Url Auth - 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.
-
Get
Domain Tag[] - Tag information
- timeout
Get
Domain Timeout - Indicates the configuration module for the 'origin timeout' feature. This feature is disabled by default.
- ua
Access GetRule Domain Ua Access Rule - Indicates the configuration module for the "UA allowlist and blocklist" feature. This feature is disabled by default.
- updated
Time number - Indicates the most recent update time for this domain configuration, in Unix timestamp format.
- url
Normalize GetDomain Url Normalize - Specifies the configuration module for the 'URL normalization' feature. This feature is disabled by default.
- video
Drag GetDomain Video Drag - Indicates the configuration module for the "Video Drag" feature. This feature is disabled by default.
- area_
access_ Getrule Domain Area Access Rule - 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[GetDomain Browser Cach] - 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 GetDomain Cache Host - Specifies the configuration module for the 'shared cache' feature. This feature is disabled by default.
- cache_
keys Sequence[GetDomain Cache Key] - 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.
- 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 ('').
- 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[Get
Domain Cach] - 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
Get
Domain Compression - Represents the configuration module for the 'Smart Compression' feature. This feature is disabled by default.
- conditional_
origin GetDomain Conditional Origin - 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_ Getpage Domain Custom Error Page - Indicates the configuration module for the "Custom Error Page" feature. This feature is disabled by default.
- customize_
access_ Getrule Domain Customize Access Rule - 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 GetDomain Domain Lock - Indicates the lock status of this domain name.
- download_
speed_ Getlimit Domain Download Speed Limit - 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_ Getredirect Domain Http Forced Redirect - Represents the configuration module for the 'Force HTTPS Redirect to HTTP' feature. This feature is disabled by default.
- https
Get
Domain Https - Indicates the HTTPS configuration module. This feature is disabled by default.
- i_
pv6 GetDomain IPv6 - Indicates the configuration module for the IPv6 feature.
- id str
- Uniquely identifies the resource.
- ip_
access_ Getrule Domain Ip Access Rule - 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_ booldomain - 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_ Getrule Domain Method Denied Rule - Represents the configuration module for the 'Disable HTTP Method' feature. This feature is disabled by default.
- multi_
range GetDomain Multi Range - Indicates the configuration module for the multi-range feature. This feature is disabled by default
- negative_
caches Sequence[GetDomain Negative Cach] - 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 GetDomain Offline Cache - Indicates the configuration module for the 'offline cache' feature.
- origin_
access_ Getrule Domain Origin Access Rule - Indicates the configuration module for the 'Origin allowlist and blacklist' feature. This feature is disabled by default.
- origin_
args Sequence[GetDomain Origin Arg] - 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_ Getcheck Domain Origin Cert Check - 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_ strpv6 - 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 GetDomain Origin Retry - Indicates the configuration module for the "origin fetch retry settings" feature.
- origin_
rewrite GetDomain Origin Rewrite - Indicates the configuration module for the 'Origin URL Rewrite' feature.
- origin_
sni GetDomain Origin Sni - Indicates the configuration module for the 'origin SNI' feature.
- origins
Sequence[Get
Domain Origin] - Indicates the basic origin configuration module.
- page_
optimization GetDomain Page Optimization - 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
Get
Domain Quic - Indicates the configuration module for the QUIC feature. This feature is disabled by default.
- redirection_
rewrite GetDomain Redirection Rewrite - Represents the configuration module for the 'URL Redirect Rewrite' feature. This feature is disabled by default.
- referer_
access_ Getrule Domain Referer Access Rule - Indicates the configuration module for the "Referer Allowlist and Denylist" feature. This feature is disabled by default.
- remote_
auth GetDomain Remote Auth - Indicates the configuration module for the 'remote authentication' feature. This feature is disabled by default.
- request_
block_ Getrule Domain Request Block Rule - Indicates the configuration module for the 'Custom Interception' feature. This feature is disabled by default
- request_
headers Sequence[GetDomain Request Header] - Indicates the configuration module for the 'origin HTTP request header' feature. This feature is disabled by default.
- response_
headers Sequence[GetDomain Response Header] - Indicates the configuration module for the 'HTTP response header' feature. This feature is disabled by default.
- rewrite_
hls GetDomain Rewrite Hls - 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_ Getauth Domain Signed Url Auth - 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.
-
Sequence[Get
Domain Tag] - Tag information
- timeout
Get
Domain Timeout - Indicates the configuration module for the 'origin timeout' feature. This feature is disabled by default.
- ua_
access_ Getrule Domain Ua Access Rule - 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 GetDomain Url Normalize - Specifies the configuration module for the 'URL normalization' feature. This feature is disabled by default.
- video_
drag GetDomain Video Drag - Indicates the configuration module for the "Video Drag" feature. This feature is disabled by default.
- area
Access Property MapRule - Indicates the configuration module for the 'regional access control' feature. This feature is disabled by default.
- backup
Origins 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.
- browser
Caches 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.
- cache
Host Property Map - Specifies the configuration module for the 'shared cache' feature. This feature is disabled by default.
- cache
Keys 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.
- 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 ('').
- 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.
- conditional
Origin Property Map - Specifies the configuration module for the 'Conditional Origin' feature.
- created
Time Number - Indicates the creation time of this accelerated domain name, in Unix timestamp format.
- custom
Error Property MapPage - Indicates the configuration module for the "Custom Error Page" feature. This feature is disabled by default.
- customize
Access Property MapRule - 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.
- domain
Lock Property Map - Indicates the lock status of this domain name.
- download
Speed Property MapLimit - Represents the configuration module for the 'Download Speed Limit' feature. This feature is disabled by default.
- follow
Redirect 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.
- http
Forced Property MapRedirect - 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.
- i
Pv6 Property Map - Indicates the configuration module for the IPv6 feature.
- id String
- Uniquely identifies the resource.
- ip
Access Property MapRule - 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 BooleanDomain - 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 String - Indicates whether the configuration for this domain name can be changed. The parameter values are: on: Allowed. off: Not allowed.
- method
Denied Property MapRule - Represents the configuration module for the 'Disable HTTP Method' feature. This feature is disabled by default.
- multi
Range Property Map - Indicates the configuration module for the multi-range feature. This feature is disabled by default
- negative
Caches 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.
- offline
Cache Property Map - Indicates the configuration module for the 'offline cache' feature.
- origin
Access Property MapRule - Indicates the configuration module for the 'Origin allowlist and blacklist' feature. This feature is disabled by default.
- origin
Args 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.
- origin
Cert Property MapCheck - Origin certificate validation
- origin
Host 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.
- origin
IPv6 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.
- origin
Protocol 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.
- origin
Range 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.
- origin
Retry Property Map - Indicates the configuration module for the "origin fetch retry settings" feature.
- origin
Rewrite Property Map - Indicates the configuration module for the 'Origin URL Rewrite' feature.
- origin
Sni Property Map - Indicates the configuration module for the 'origin SNI' feature.
- origins List<Property Map>
- Indicates the basic origin configuration module.
- page
Optimization Property Map - Specifies the configuration module for the 'page optimization' feature.
- primary
Origins 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.
- redirection
Rewrite Property Map - Represents the configuration module for the 'URL Redirect Rewrite' feature. This feature is disabled by default.
- referer
Access Property MapRule - Indicates the configuration module for the "Referer Allowlist and Denylist" feature. This feature is disabled by default.
- remote
Auth Property Map - Indicates the configuration module for the 'remote authentication' feature. This feature is disabled by default.
- request
Block Property MapRule - Indicates the configuration module for the 'Custom Interception' feature. This feature is disabled by default
- request
Headers List<Property Map> - Indicates the configuration module for the 'origin HTTP request header' feature. This feature is disabled by default.
- response
Headers List<Property Map> - Indicates the configuration module for the 'HTTP response header' feature. This feature is disabled by default.
- rewrite
Hls Property Map - Indicates the configuration module for the "Standard HLS Encryption Rewrite" feature. This feature is disabled by default.
- service
Region 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).
- service
Type 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.
- signed
Url Property MapAuth - 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.
- List<Property Map>
- Tag information
- timeout Property Map
- Indicates the configuration module for the 'origin timeout' feature. This feature is disabled by default.
- ua
Access Property MapRule - Indicates the configuration module for the "UA allowlist and blocklist" feature. This feature is disabled by default.
- updated
Time Number - Indicates the most recent update time for this domain configuration, in Unix timestamp format.
- url
Normalize Property Map - Specifies the configuration module for the 'URL normalization' feature. This feature is disabled by default.
- video
Drag 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 (,).
- Rule
Type 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 (,).
- Rule
Type 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 (,).
- rule
Type 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 (,).
- rule
Type 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 (,).
- rule
Type 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
- Cache
Action Byteplus.Get Domain Browser Cach Cache Action - Indicates the relevant configuration for cache behavior.
- Condition
Byteplus.
Get Domain Browser Cach Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Cache
Action GetDomain Browser Cach Cache Action - Indicates the relevant configuration for cache behavior.
- Condition
Get
Domain Browser Cach Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- cache
Action GetDomain Browser Cach Cache Action - Indicates the relevant configuration for cache behavior.
- condition
Get
Domain Browser Cach Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- cache
Action GetDomain Browser Cach Cache Action - Indicates the relevant configuration for cache behavior.
- condition
Get
Domain Browser Cach Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- cache_
action GetDomain Browser Cach Cache Action - Indicates the relevant configuration for cache behavior.
- condition
Get
Domain Browser Cach Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- cache
Action 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.
- Default
Policy string - 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.
- Default
Policy string - 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.
- default
Policy String - This parameter is shared by multiple CDN features.
- ignore
Case 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.
- default
Policy string - This parameter is shared by multiple CDN features.
- ignore
Case 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.
- default
Policy String - This parameter is shared by multiple CDN features.
- ignore
Case 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
- Condition
Rules List<Byteplus.Get Domain Browser Cach Condition Condition Rule> - 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 []GetDomain Browser Cach Condition Condition Rule - 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 List<GetDomain Browser Cach Condition Condition Rule> - 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 GetDomain Browser Cach Condition Condition Rule[] - 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[GetDomain Browser Cach Condition Condition Rule] - 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.
- condition
Rules 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
- Cache
Action Byteplus.Get Domain Cach Cache Action - Indicates the relevant configuration for cache behavior.
- Condition
Byteplus.
Get Domain Cach Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Cache
Action GetDomain Cach Cache Action - Indicates the relevant configuration for cache behavior.
- Condition
Get
Domain Cach Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- cache
Action GetDomain Cach Cache Action - Indicates the relevant configuration for cache behavior.
- condition
Get
Domain Cach Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- cache
Action GetDomain Cach Cache Action - Indicates the relevant configuration for cache behavior.
- condition
Get
Domain Cach Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- cache_
action GetDomain Cach Cache Action - Indicates the relevant configuration for cache behavior.
- condition
Get
Domain Cach Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- cache
Action 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.
- Default
Policy string - 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.
- Default
Policy string - 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.
- default
Policy String - This parameter is shared by multiple CDN features.
- ignore
Case 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.
- default
Policy string - This parameter is shared by multiple CDN features.
- ignore
Case 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.
- default
Policy String - This parameter is shared by multiple CDN features.
- ignore
Case 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
- Condition
Rules List<Byteplus.Get Domain Cach Condition Condition Rule> - 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 []GetDomain Cach Condition Condition Rule - 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 List<GetDomain Cach Condition Condition Rule> - 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 GetDomain Cach Condition Condition Rule[] - 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[GetDomain Cach Condition Condition Rule] - 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.
- condition
Rules 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
- Cache
Host List<Byteplus.Rules Get Domain Cache Host Cache Host Rule> - 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.
- Cache
Host []GetRules Domain Cache Host Cache Host Rule - 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.
- cache
Host List<GetRules Domain Cache Host Cache Host Rule> - 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 GetRules Domain Cache Host Cache Host Rule[] - 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_ Sequence[Getrules Domain Cache Host Cache Host Rule] - 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.
- cache
Host List<Property Map>Rules - 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
- Cache
Host Byteplus.Action Get Domain Cache Host Cache Host Rule Cache Host Action - 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.
Get Domain Cache Host Cache Host Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- Cache
Host GetAction Domain Cache Host Cache Host Rule Cache Host Action - 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
Get
Domain Cache Host Cache Host Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- cache
Host GetAction Domain Cache Host Cache Host Rule Cache Host Action - 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
Get
Domain Cache Host Cache Host Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- cache
Host GetAction Domain Cache Host Cache Host Rule Cache Host Action - 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
Get
Domain Cache Host Cache Host Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- cache_
host_ Getaction Domain Cache Host Cache Host Rule Cache Host Action - 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
Get
Domain Cache Host Cache Host Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- cache
Host Property MapAction - 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
- Cache
Host 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 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 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 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.
- cache
Host 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
- Condition
Rules List<Byteplus.Get Domain Cache Host Cache Host Rule Condition Condition Rule> - 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 []GetDomain Cache Host Cache Host Rule Condition Condition Rule - 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 List<GetDomain Cache Host Cache Host Rule Condition Condition Rule> - 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 GetDomain Cache Host Cache Host Rule Condition Condition Rule[] - 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[GetDomain Cache Host Cache Host Rule Condition Condition Rule] - 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.
- condition
Rules 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
- Cache
Key Byteplus.Action Get Domain Cache Key Cache Key Action - Indicates the action performed by the content delivery network under the Condition scenario.
- Condition
Byteplus.
Get Domain Cache Key Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- Cache
Key GetAction Domain Cache Key Cache Key Action - Indicates the action performed by the content delivery network under the Condition scenario.
- Condition
Get
Domain Cache Key Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- cache
Key GetAction Domain Cache Key Cache Key Action - Indicates the action performed by the content delivery network under the Condition scenario.
- condition
Get
Domain Cache Key Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- cache
Key GetAction Domain Cache Key Cache Key Action - Indicates the action performed by the content delivery network under the Condition scenario.
- condition
Get
Domain Cache Key Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- cache_
key_ Getaction Domain Cache Key Cache Key Action - Indicates the action performed by the content delivery network under the Condition scenario.
- condition
Get
Domain Cache Key Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- cache
Key Property MapAction - 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
- Cache
Key List<Byteplus.Components Get Domain Cache Key Cache Key Action Cache Key Component> - Indicates a list of operation configurations. Currently, you can only set one operation configuration.
- Cache
Key []GetComponents Domain Cache Key Cache Key Action Cache Key Component - Indicates a list of operation configurations. Currently, you can only set one operation configuration.
- cache
Key List<GetComponents Domain Cache Key Cache Key Action Cache Key Component> - Indicates a list of operation configurations. Currently, you can only set one operation configuration.
- cache
Key GetComponents Domain Cache Key Cache Key Action Cache Key Component[] - Indicates a list of operation configurations. Currently, you can only set one operation configuration.
- cache_
key_ Sequence[Getcomponents Domain Cache Key Cache Key Action Cache Key Component] - Indicates a list of operation configurations. Currently, you can only set one operation configuration.
- cache
Key List<Property Map>Components - 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.
- 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 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.
- 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 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.
- ignore
Case 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.
- ignore
Case 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.
- ignore
Case 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
- Condition
Rules List<Byteplus.Get Domain Cache Key Condition Condition Rule> - 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 []GetDomain Cache Key Condition Condition Rule - 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 List<GetDomain Cache Key Condition Condition Rule> - 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 GetDomain Cache Key Condition Condition Rule[] - 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[GetDomain Cache Key Condition Condition Rule] - 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.
- condition
Rules 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
- Compression
Rules List<Byteplus.Get Domain Compression Compression Rule> - 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.
- Compression
Rules []GetDomain Compression Compression Rule - 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.
- compression
Rules List<GetDomain Compression Compression Rule> - 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 GetDomain Compression Compression Rule[] - 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[GetDomain Compression Compression Rule] - 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.
- compression
Rules 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
- Compression
Action Byteplus.Get Domain Compression Compression Rule Compression Action - Represents the configuration for compression operations.
- Condition
Byteplus.
Get Domain Compression Compression Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Compression
Action GetDomain Compression Compression Rule Compression Action - Represents the configuration for compression operations.
- Condition
Get
Domain Compression Compression Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- compression
Action GetDomain Compression Compression Rule Compression Action - Represents the configuration for compression operations.
- condition
Get
Domain Compression Compression Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- compression
Action GetDomain Compression Compression Rule Compression Action - Represents the configuration for compression operations.
- condition
Get
Domain Compression Compression Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- compression_
action GetDomain Compression Compression Rule Compression Action - Represents the configuration for compression operations.
- condition
Get
Domain Compression Compression Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- compression
Action 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
- Compression
Format 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.
- Compression
Target 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 *.
- Compression
Types 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]
- Max
File intSize Kb - 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 intSize Kb - 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 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.
- Compression
Target 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 *.
- Compression
Types []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]
- Max
File intSize Kb - 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 intSize Kb - 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 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.
- compression
Target 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 *.
- compression
Types 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]
- max
File IntegerSize Kb - 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 IntegerSize Kb - 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 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.
- compression
Target 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 *.
- compression
Types 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]
- max
File numberSize Kb - 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 numberSize Kb - 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_ intsize_ kb - 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_ intsize_ kb - 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 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.
- compression
Target 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 *.
- compression
Types 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]
- max
File NumberSize Kb - 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 NumberSize Kb - 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
- Condition
Rules List<Byteplus.Get Domain Compression Compression Rule Condition Condition Rule> - 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 []GetDomain Compression Compression Rule Condition Condition Rule - 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 List<GetDomain Compression Compression Rule Condition Condition Rule> - 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 GetDomain Compression Compression Rule Condition Condition Rule[] - 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[GetDomain Compression Compression Rule Condition Condition Rule] - 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.
- condition
Rules 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
- Origin
Rules List<Byteplus.Get Domain Conditional Origin Origin Rule> - 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.
- Origin
Rules []GetDomain Conditional Origin Origin Rule - 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.
- origin
Rules List<GetDomain Conditional Origin Origin Rule> - 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 GetDomain Conditional Origin Origin Rule[] - 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[GetDomain Conditional Origin Origin Rule] - 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.
- origin
Rules 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.
Get Domain Conditional Origin Origin Rule Actions - Indicates the operation configuration for a rule in the list.
- Condition
Byteplus.
Get Domain Conditional Origin Origin Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- Actions
Get
Domain Conditional Origin Origin Rule Actions - Indicates the operation configuration for a rule in the list.
- Condition
Get
Domain Conditional Origin Origin Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- actions
Get
Domain Conditional Origin Origin Rule Actions - Indicates the operation configuration for a rule in the list.
- condition
Get
Domain Conditional Origin Origin Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- actions
Get
Domain Conditional Origin Origin Rule Actions - Indicates the operation configuration for a rule in the list.
- condition
Get
Domain Conditional Origin Origin Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- actions
Get
Domain Conditional Origin Origin Rule Actions - Indicates the operation configuration for a rule in the list.
- condition
Get
Domain Conditional Origin Origin Rule Condition - 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
- Origin
Lines List<Byteplus.Get Domain Conditional Origin Origin Rule Actions Origin Line> - Indicates a list of origin configurations. Currently, the list can contain only one origin configuration.
- Origin
Lines []GetDomain Conditional Origin Origin Rule Actions Origin Line - Indicates a list of origin configurations. Currently, the list can contain only one origin configuration.
- origin
Lines List<GetDomain Conditional Origin Origin Rule Actions Origin Line> - Indicates a list of origin configurations. Currently, the list can contain only one origin configuration.
- origin
Lines GetDomain Conditional Origin Origin Rule Actions Origin Line[] - Indicates a list of origin configurations. Currently, the list can contain only one origin configuration.
- origin_
lines Sequence[GetDomain Conditional Origin Origin Rule Actions Origin Line] - Indicates a list of origin configurations. Currently, the list can contain only one origin configuration.
- origin
Lines 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.
- Http
Port 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.
- Https
Port 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.
- Instance
Type 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.
- Origin
Host 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.
- Http
Port 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.
- Https
Port 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.
- Instance
Type 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.
- Origin
Host 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.
- http
Port 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.
- https
Port 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.
- instance
Type 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.
- origin
Host 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.
- http
Port 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.
- https
Port 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.
- instance
Type 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.
- origin
Host 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.
- http
Port 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.
- https
Port 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.
- instance
Type 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.
- origin
Host 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
- Condition
Groups List<Byteplus.Get Domain Conditional Origin Origin Rule Condition Condition Group> - 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.
- 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.
- Condition
Groups []GetDomain Conditional Origin Origin Rule Condition Condition Group - 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.
- 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.
- condition
Groups List<GetDomain Conditional Origin Origin Rule Condition Condition Group> - 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.
- is
Group 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 GetDomain Conditional Origin Origin Rule Condition Condition Group[] - 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.
- is
Group 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[GetDomain Conditional Origin Origin Rule Condition Condition Group] - 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.
- condition
Groups 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.
- is
Group 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.
Get Domain Conditional Origin Origin Rule Condition Condition Group Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Condition
Get
Domain Conditional Origin Origin Rule Condition Condition Group Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- condition
Get
Domain Conditional Origin Origin Rule Condition Condition Group Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- condition
Get
Domain Conditional Origin Origin Rule Condition Condition Group Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- condition
Get
Domain Conditional Origin Origin Rule Condition Condition Group Condition - 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
- Error
Page List<Byteplus.Rules Get Domain Custom Error Page Error Page Rule> - 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.
- Error
Page []GetRules Domain Custom Error Page Error Page Rule - 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.
- error
Page List<GetRules Domain Custom Error Page Error Page Rule> - 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 GetRules Domain Custom Error Page Error Page Rule[] - 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_ Sequence[Getrules Domain Custom Error Page Error Page Rule] - 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.
- error
Page List<Property Map>Rules - 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
- Error
Page Byteplus.Action Get Domain Custom Error Page Error Page Rule Error Page Action - Indicates the relevant configuration for the rule.
- Error
Page GetAction Domain Custom Error Page Error Page Rule Error Page Action - Indicates the relevant configuration for the rule.
- error
Page GetAction Domain Custom Error Page Error Page Rule Error Page Action - Indicates the relevant configuration for the rule.
- error
Page GetAction Domain Custom Error Page Error Page Rule Error Page Action - Indicates the relevant configuration for the rule.
- error_
page_ Getaction Domain Custom Error Page Error Page Rule Error Page Action - Indicates the relevant configuration for the rule.
- error
Page Property MapAction - 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.
- Redirect
Code 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.
- Redirect
Url 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.
- Status
Code 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.
- Redirect
Code 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.
- Redirect
Url 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.
- Status
Code 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.
- redirect
Code 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.
- redirect
Url 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.
- status
Code 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.
- redirect
Code 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.
- redirect
Url 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.
- status
Code 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.
- redirect
Code 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.
- redirect
Url 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.
- status
Code 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
- Customize
Instances List<Byteplus.Get Domain Customize Access Rule Customize Instance> - 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.
- Customize
Instances []GetDomain Customize Access Rule Customize Instance - 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.
- customize
Instances List<GetDomain Customize Access Rule Customize Instance> - 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 GetDomain Customize Access Rule Customize Instance[] - 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[GetDomain Customize Access Rule Customize Instance] - 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.
- customize
Instances 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
- Customize
Rule Byteplus.Get Domain Customize Access Rule Customize Instance Customize Rule - Describes the configuration for a rule in the list.
- Customize
Rule GetDomain Customize Access Rule Customize Instance Customize Rule - Describes the configuration for a rule in the list.
- customize
Rule GetDomain Customize Access Rule Customize Instance Customize Rule - Describes the configuration for a rule in the list.
- customize
Rule GetDomain Customize Access Rule Customize Instance Customize Rule - Describes the configuration for a rule in the list.
- customize_
rule GetDomain Customize Access Rule Customize Instance Customize Rule - Describes the configuration for a rule in the list.
- customize
Rule Property Map - Describes the configuration for a rule in the list.
GetDomainCustomizeAccessRuleCustomizeInstanceCustomizeRule
- Access
Action Byteplus.Get Domain Customize Access Rule Customize Instance Customize Rule Access Action - Indicates the configuration of the denylist or allowlist in this rule.
- Condition
Byteplus.
Get Domain Customize Access Rule Customize Instance Customize Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Access
Action GetDomain Customize Access Rule Customize Instance Customize Rule Access Action - Indicates the configuration of the denylist or allowlist in this rule.
- Condition
Get
Domain Customize Access Rule Customize Instance Customize Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- access
Action GetDomain Customize Access Rule Customize Instance Customize Rule Access Action - Indicates the configuration of the denylist or allowlist in this rule.
- condition
Get
Domain Customize Access Rule Customize Instance Customize Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- access
Action GetDomain Customize Access Rule Customize Instance Customize Rule Access Action - Indicates the configuration of the denylist or allowlist in this rule.
- condition
Get
Domain Customize Access Rule Customize Instance Customize Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- access_
action GetDomain Customize Access Rule Customize Instance Customize Rule Access Action - Indicates the configuration of the denylist or allowlist in this rule.
- condition
Get
Domain Customize Access Rule Customize Instance Customize Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- access
Action 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
- 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 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.
- Request
Header 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.
- Rule
Type 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 []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.
- Request
Header 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.
- Rule
Type 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 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 ("").
- list
Rules 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.
- request
Header 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.
- rule
Type 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 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 ("").
- list
Rules 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.
- request
Header 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.
- rule
Type 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.
- allow
Empty 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 ("").
- list
Rules 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.
- request
Header 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.
- rule
Type 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
- Condition
Rules List<Byteplus.Get Domain Customize Access Rule Customize Instance Customize Rule Condition Condition Rule> - 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 []GetDomain Customize Access Rule Customize Instance Customize Rule Condition Condition Rule - 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 List<GetDomain Customize Access Rule Customize Instance Customize Rule Condition Condition Rule> - 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 GetDomain Customize Access Rule Customize Instance Customize Rule Condition Condition Rule[] - 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[GetDomain Customize Access Rule Customize Instance Customize Rule Condition Condition Rule] - 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.
- condition
Rules 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
- Download
Speed List<Byteplus.Limit Rules Get Domain Download Speed Limit Download Speed Limit Rule> - 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.
- Download
Speed []GetLimit Rules Domain Download Speed Limit Download Speed Limit Rule - 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.
- download
Speed List<GetLimit Rules Domain Download Speed Limit Download Speed Limit Rule> - 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 GetLimit Rules Domain Download Speed Limit Download Speed Limit Rule[] - 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_ Sequence[Getlimit_ rules Domain Download Speed Limit Download Speed Limit Rule] - 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.
- download
Speed List<Property Map>Limit Rules - 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.
Get Domain Download Speed Limit Download Speed Limit Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Download
Speed Byteplus.Limit Action Get Domain Download Speed Limit Download Speed Limit Rule Download Speed Limit Action - Indicates the rate limiting configuration.
- Condition
Get
Domain Download Speed Limit Download Speed Limit Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Download
Speed GetLimit Action Domain Download Speed Limit Download Speed Limit Rule Download Speed Limit Action - Indicates the rate limiting configuration.
- condition
Get
Domain Download Speed Limit Download Speed Limit Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- download
Speed GetLimit Action Domain Download Speed Limit Download Speed Limit Rule Download Speed Limit Action - Indicates the rate limiting configuration.
- condition
Get
Domain Download Speed Limit Download Speed Limit Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- download
Speed GetLimit Action Domain Download Speed Limit Download Speed Limit Rule Download Speed Limit Action - Indicates the rate limiting configuration.
- condition
Get
Domain Download Speed Limit Download Speed Limit Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- download_
speed_ Getlimit_ action Domain Download Speed Limit Download Speed Limit Rule Download Speed Limit Action - Indicates the rate limiting configuration.
- condition Property Map
- Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- download
Speed Property MapLimit Action - Indicates the rate limiting configuration.
GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleCondition
- Condition
Rules List<Byteplus.Get Domain Download Speed Limit Download Speed Limit Rule Condition Condition Rule> - 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 []GetDomain Download Speed Limit Download Speed Limit Rule Condition Condition Rule - 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 List<GetDomain Download Speed Limit Download Speed Limit Rule Condition Condition Rule> - 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 GetDomain Download Speed Limit Download Speed Limit Rule Condition Condition Rule[] - 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[GetDomain Download Speed Limit Download Speed Limit Rule Condition Condition Rule] - 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.
- condition
Rules 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
- Speed
Limit intRate - 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 intRate After - 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 Byteplus.Time Get Domain Download Speed Limit Download Speed Limit Rule Download Speed Limit Action Speed Limit Time - Indicates the date and time period when rate limiting occurs.
- Speed
Limit intRate - 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 intRate After - 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 GetTime Domain Download Speed Limit Download Speed Limit Rule Download Speed Limit Action Speed Limit Time - Indicates the date and time period when rate limiting occurs.
- speed
Limit IntegerRate - 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 IntegerRate After - 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 GetTime Domain Download Speed Limit Download Speed Limit Rule Download Speed Limit Action Speed Limit Time - Indicates the date and time period when rate limiting occurs.
- speed
Limit numberRate - 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 numberRate After - 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 GetTime Domain Download Speed Limit Download Speed Limit Rule Download Speed Limit Action Speed Limit Time - Indicates the date and time period when rate limiting occurs.
- speed_
limit_ intrate - 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_ intrate_ after - 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_ Gettime Domain Download Speed Limit Download Speed Limit Rule Download Speed Limit Action Speed Limit Time - Indicates the date and time period when rate limiting occurs.
- speed
Limit NumberRate - 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 NumberRate After - 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 Property MapTime - Indicates the date and time period when rate limiting occurs.
GetDomainDownloadSpeedLimitDownloadSpeedLimitRuleDownloadSpeedLimitActionSpeedLimitTime
- Begin
Time 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.
- Day
Week 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 (;).
- End
Time 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 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.
- Day
Week 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 (;).
- End
Time 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 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.
- day
Week 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 (;).
- end
Time 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 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.
- day
Week 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 (;).
- end
Time 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.
- begin
Time 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.
- day
Week 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 (;).
- end
Time 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
- Enable
Forced boolRedirect - 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 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 boolRedirect - 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 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 BooleanRedirect - 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 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 booleanRedirect - 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 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_ boolredirect - 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.
- enable
Forced BooleanRedirect - 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 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
- Cert
Check Byteplus.Get Domain Https Cert Check - Indicates the configuration module for the 'mutual authentication' feature. To configure 'mutual authentication'.
- Cert
Info Byteplus.Get Domain Https Cert Info - Indicates the single certificate to be associated with the acceleration domain name.
- Cert
Info List<Byteplus.Lists Get Domain Https Cert Info List> - 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 Byteplus.Get Domain Https Forced Redirect - Indicates the configuration module for the 'HTTP Forced Redirect to HTTPS' feature. This feature is disabled by default.
- Hsts
Byteplus.
Get Domain Https Hsts - 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 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"]
- Cert
Check GetDomain Https Cert Check - Indicates the configuration module for the 'mutual authentication' feature. To configure 'mutual authentication'.
- Cert
Info GetDomain Https Cert Info - Indicates the single certificate to be associated with the acceleration domain name.
- Cert
Info []GetLists Domain Https Cert Info List - 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 GetDomain Https Forced Redirect - Indicates the configuration module for the 'HTTP Forced Redirect to HTTPS' feature. This feature is disabled by default.
- Hsts
Get
Domain Https Hsts - 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 []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 GetDomain Https Cert Check - Indicates the configuration module for the 'mutual authentication' feature. To configure 'mutual authentication'.
- cert
Info GetDomain Https Cert Info - Indicates the single certificate to be associated with the acceleration domain name.
- cert
Info List<GetLists Domain Https Cert Info List> - Indicates the dual certificate to be associated with the acceleration domain name.
- disable
Http 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.
- forced
Redirect GetDomain Https Forced Redirect - Indicates the configuration module for the 'HTTP Forced Redirect to HTTPS' feature. This feature is disabled by default.
- hsts
Get
Domain Https Hsts - 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.
- tls
Versions 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"]
- cert
Check GetDomain Https Cert Check - Indicates the configuration module for the 'mutual authentication' feature. To configure 'mutual authentication'.
- cert
Info GetDomain Https Cert Info - Indicates the single certificate to be associated with the acceleration domain name.
- cert
Info GetLists Domain Https Cert Info List[] - Indicates the dual certificate to be associated with the acceleration domain name.
- disable
Http 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.
- forced
Redirect GetDomain Https Forced Redirect - Indicates the configuration module for the 'HTTP Forced Redirect to HTTPS' feature. This feature is disabled by default.
- hsts
Get
Domain Https Hsts - 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.
- tls
Versions 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 GetDomain Https Cert Check - Indicates the configuration module for the 'mutual authentication' feature. To configure 'mutual authentication'.
- cert_
info GetDomain Https Cert Info - Indicates the single certificate to be associated with the acceleration domain name.
- cert_
info_ Sequence[Getlists Domain Https Cert Info List] - 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 GetDomain Https Forced Redirect - Indicates the configuration module for the 'HTTP Forced Redirect to HTTPS' feature. This feature is disabled by default.
- hsts
Get
Domain Https Hsts - 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"]
- cert
Check Property Map - Indicates the configuration module for the 'mutual authentication' feature. To configure 'mutual authentication'.
- cert
Info Property Map - Indicates the single certificate to be associated with the acceleration domain name.
- cert
Info List<Property Map>Lists - Indicates the dual certificate to be associated with the acceleration domain name.
- disable
Http 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.
- forced
Redirect 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.
- tls
Versions 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
- Cert
Info List<Byteplus.Lists Get Domain Https Cert Check Cert Info List> - 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.
- Cert
Info []GetLists Domain Https Cert Check Cert Info List - 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.
- cert
Info List<GetLists Domain Https Cert Check Cert Info List> - 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 GetLists Domain Https Cert Check Cert Info List[] - 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_ Sequence[Getlists Domain Https Cert Check Cert Info List] - 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.
- cert
Info List<Property Map>Lists - 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
- Cert
Id string - Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
- Cert
Name string - Represents the content of the Common Name (CN) field in the CA certificate.
- Certificate
Byteplus.
Get Domain Https Cert Check Cert Info List Certificate - 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 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.
- Expire
Time 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.
- Cert
Id string - Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
- Cert
Name string - Represents the content of the Common Name (CN) field in the CA certificate.
- Certificate
Get
Domain Https Cert Check Cert Info List Certificate - 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 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.
- Expire
Time 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.
- cert
Id String - Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
- cert
Name String - Represents the content of the Common Name (CN) field in the CA certificate.
- certificate
Get
Domain Https Cert Check Cert Info List Certificate - Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.
- effective
Time Integer - Indicates the issuance time of the certificate, in Unix timestamp.
- encry
Type 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.
- expire
Time 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.
- cert
Id string - Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
- cert
Name string - Represents the content of the Common Name (CN) field in the CA certificate.
- certificate
Get
Domain Https Cert Check Cert Info List Certificate - Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.
- effective
Time number - Indicates the issuance time of the certificate, in Unix timestamp.
- encry
Type 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.
- expire
Time 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
Get
Domain Https Cert Check Cert Info List Certificate - 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.
- cert
Id String - Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
- cert
Name 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.
- effective
Time Number - Indicates the issuance time of the certificate, in Unix timestamp.
- encry
Type 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.
- expire
Time 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.
- Encryption
Cert 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
- Encryption
Key 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.
- Private
Key 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.
- Encryption
Cert 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
- Encryption
Key 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.
- Private
Key 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.
- encryption
Cert 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
- encryption
Key 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.
- private
Key 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.
- encryption
Cert 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
- encryption
Key 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.
- private
Key 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.
- encryption
Cert 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
- encryption
Key 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.
- private
Key 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
- Cert
Id string - Represents the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
- Cert
Name string - Indicates the content of the Common Name (CN) field in the CA certificate.
- Certificate
Byteplus.
Get Domain Https Cert Info Certificate - 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 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.
- Expire
Time 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.
- Cert
Id string - Represents the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
- Cert
Name string - Indicates the content of the Common Name (CN) field in the CA certificate.
- Certificate
Get
Domain Https Cert Info Certificate - 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 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.
- Expire
Time 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.
- cert
Id String - Represents the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
- cert
Name String - Indicates the content of the Common Name (CN) field in the CA certificate.
- certificate
Get
Domain Https Cert Info Certificate - Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the CDN.
- effective
Time Integer - Indicates the issuance time of the certificate, in Unix timestamp.
- encry
Type 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.
- expire
Time 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.
- cert
Id string - Represents the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
- cert
Name string - Indicates the content of the Common Name (CN) field in the CA certificate.
- certificate
Get
Domain Https Cert Info Certificate - Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the CDN.
- effective
Time number - Indicates the issuance time of the certificate, in Unix timestamp.
- encry
Type 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.
- expire
Time 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
Get
Domain Https Cert Info Certificate - 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.
- cert
Id String - Represents the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
- cert
Name 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.
- effective
Time Number - Indicates the issuance time of the certificate, in Unix timestamp.
- encry
Type 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.
- expire
Time 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.
- Encryption
Cert 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
- Encryption
Key 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.
- Private
Key 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.
- Encryption
Cert 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
- Encryption
Key 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.
- Private
Key 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.
- encryption
Cert 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
- encryption
Key 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.
- private
Key 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.
- encryption
Cert 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
- encryption
Key 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.
- private
Key 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.
- encryption
Cert 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
- encryption
Key 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.
- private
Key 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
- Cert
Id string - Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
- Cert
Name string - Represents the content of the Common Name (CN) field in the CA certificate.
- Certificate
Byteplus.
Get Domain Https Cert Info List Certificate - 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 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.
- Expire
Time 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.
- Cert
Id string - Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
- Cert
Name string - Represents the content of the Common Name (CN) field in the CA certificate.
- Certificate
Get
Domain Https Cert Info List Certificate - 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 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.
- Expire
Time 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.
- cert
Id String - Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
- cert
Name String - Represents the content of the Common Name (CN) field in the CA certificate.
- certificate
Get
Domain Https Cert Info List Certificate - Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.
- effective
Time Integer - Indicates the issuance time of the certificate, in Unix timestamp.
- encry
Type 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.
- expire
Time 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.
- cert
Id string - Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
- cert
Name string - Represents the content of the Common Name (CN) field in the CA certificate.
- certificate
Get
Domain Https Cert Info List Certificate - Indicates a CA certificate to be uploaded. The uploaded certificate is hosted on the content delivery network.
- effective
Time number - Indicates the issuance time of the certificate, in Unix timestamp.
- encry
Type 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.
- expire
Time 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
Get
Domain Https Cert Info List Certificate - 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.
- cert
Id String - Indicates the ID of a CA certificate hosted on the content delivery network. The ID starts with cert_hosting-.
- cert
Name 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.
- effective
Time Number - Indicates the issuance time of the certificate, in Unix timestamp.
- encry
Type 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.
- expire
Time 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.
- Encryption
Cert 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
- Encryption
Key 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.
- Private
Key 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.
- Encryption
Cert 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
- Encryption
Key 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.
- Private
Key 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.
- encryption
Cert 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
- encryption
Key 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.
- private
Key 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.
- encryption
Cert 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
- encryption
Key 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.
- private
Key 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.
- encryption
Cert 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
- encryption
Key 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.
- private
Key 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
- Enable
Forced boolRedirect - 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 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 boolRedirect - 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 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 BooleanRedirect - 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 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 booleanRedirect - 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 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_ boolredirect - 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.
- enable
Forced BooleanRedirect - 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 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.
- Rule
Type 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.
-
Byteplus.
Get Domain Ip Access Rule Shared Config - 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.
- Rule
Type 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.
-
Get
Domain Ip Access Rule Shared Config - 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.
- rule
Type 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.
-
Get
Domain Ip Access Rule Shared Config - 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.
- rule
Type 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.
-
Get
Domain Ip Access Rule Shared Config - 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.
-
Get
Domain Ip Access Rule Shared Config - 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.
- rule
Type 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.
- 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
- Config
Name string - Indicates the name of a global configuration.
- Config
Name string - Indicates the name of a global configuration.
- config
Name String - Indicates the name of a global configuration.
- config
Name string - Indicates the name of a global configuration.
- config_
name str - Indicates the name of a global configuration.
- config
Name 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.
Get Domain Negative Cach Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Negative
Cache Byteplus.Rule Get Domain Negative Cach Negative Cache Rule - Represents a list. Each element in the list is a status code cache rule.
- Condition
Get
Domain Negative Cach Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Negative
Cache GetRule Domain Negative Cach Negative Cache Rule - Represents a list. Each element in the list is a status code cache rule.
- condition
Get
Domain Negative Cach Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- negative
Cache GetRule Domain Negative Cach Negative Cache Rule - Represents a list. Each element in the list is a status code cache rule.
- condition
Get
Domain Negative Cach Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- negative
Cache GetRule Domain Negative Cach Negative Cache Rule - Represents a list. Each element in the list is a status code cache rule.
- condition
Get
Domain Negative Cach Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- negative_
cache_ Getrule Domain Negative Cach Negative Cache Rule - 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.
- negative
Cache Property MapRule - Represents a list. Each element in the list is a status code cache rule.
GetDomainNegativeCachCondition
- Condition
Rules List<Byteplus.Get Domain Negative Cach Condition Condition Rule> - 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 []GetDomain Negative Cach Condition Condition Rule - 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 List<GetDomain Negative Cach Condition Condition Rule> - 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 GetDomain Negative Cach Condition Condition Rule[] - 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[GetDomain Negative Cach Condition Condition Rule] - 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.
- condition
Rules 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.
- 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 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.
- 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 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.
- ignore
Case 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.
- status
Code 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.
- ignore
Case 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.
- status
Code 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.
- ignore
Case 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.
- status
Code 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.
- Status
Code 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.
- Status
Code 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.
- status
Code 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.
- status
Code 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.
- status
Code 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.
Get Domain Origin Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Origin
Action Byteplus.Get Domain Origin Origin Action - Indicates origin configuration.
- Condition
Get
Domain Origin Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Origin
Action GetDomain Origin Origin Action - Indicates origin configuration.
- condition
Get
Domain Origin Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- origin
Action GetDomain Origin Origin Action - Indicates origin configuration.
- condition
Get
Domain Origin Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- origin
Action GetDomain Origin Origin Action - Indicates origin configuration.
- condition
Get
Domain Origin Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- origin_
action GetDomain Origin Origin Action - Indicates origin configuration.
- condition Property Map
- Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- origin
Action Property Map - Indicates origin configuration.
GetDomainOriginAccessRule
- 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 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.
- Rule
Type 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.
- 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 []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.
- Rule
Type 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.
- allow
Empty 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.
- ignore
Case 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.
- rule
Type 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 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.
- ignore
Case 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.
- rule
Type 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.
- allow
Empty 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.
- ignore
Case 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.
- rule
Type 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.
Get Domain Origin Arg Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Origin
Arg Byteplus.Action Get Domain Origin Arg Origin Arg Action - Represents the action performed when the Condition is met.
- Condition
Get
Domain Origin Arg Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Origin
Arg GetAction Domain Origin Arg Origin Arg Action - Represents the action performed when the Condition is met.
- condition
Get
Domain Origin Arg Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- origin
Arg GetAction Domain Origin Arg Origin Arg Action - Represents the action performed when the Condition is met.
- condition
Get
Domain Origin Arg Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- origin
Arg GetAction Domain Origin Arg Origin Arg Action - Represents the action performed when the Condition is met.
- condition
Get
Domain Origin Arg Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- origin_
arg_ Getaction Domain Origin Arg Origin Arg Action - 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.
- origin
Arg Property MapAction - Represents the action performed when the Condition is met.
GetDomainOriginArgCondition
- Condition
Rules List<Byteplus.Get Domain Origin Arg Condition Condition Rule> - 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 []GetDomain Origin Arg Condition Condition Rule - 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 List<GetDomain Origin Arg Condition Condition Rule> - 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 GetDomain Origin Arg Condition Condition Rule[] - 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[GetDomain Origin Arg Condition Condition Rule] - 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.
- condition
Rules 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
- Origin
Arg List<Byteplus.Components Get Domain Origin Arg Origin Arg Action Origin Arg Component> - 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 []GetComponents Domain Origin Arg Origin Arg Action Origin Arg Component - 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 List<GetComponents Domain Origin Arg Origin Arg Action Origin Arg Component> - 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 GetComponents Domain Origin Arg Origin Arg Action Origin Arg Component[] - 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_ Sequence[Getcomponents Domain Origin Arg Origin Arg Action Origin Arg Component] - 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 List<Property Map>Components - 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
- Condition
Rules List<Byteplus.Get Domain Origin Condition Condition Rule> - 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 []GetDomain Origin Condition Condition Rule - 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 List<GetDomain Origin Condition Condition Rule> - 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 GetDomain Origin Condition Condition Rule[] - 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[GetDomain Origin Condition Condition Rule] - 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.
- condition
Rules 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
- Origin
Lines List<Byteplus.Get Domain Origin Origin Action Origin Line> - Indicates a list of origin configurations. Each configuration can include one or more origins.
- Origin
Lines []GetDomain Origin Origin Action Origin Line - Indicates a list of origin configurations. Each configuration can include one or more origins.
- origin
Lines List<GetDomain Origin Origin Action Origin Line> - Indicates a list of origin configurations. Each configuration can include one or more origins.
- origin
Lines GetDomain Origin Origin Action Origin Line[] - Indicates a list of origin configurations. Each configuration can include one or more origins.
- origin_
lines Sequence[GetDomain Origin Origin Action Origin Line] - Indicates a list of origin configurations. Each configuration can include one or more origins.
- origin
Lines 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.
- Http
Port 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.
- Https
Port 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.
- Instance
Type 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.
- Origin
Host 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.
- Origin
Type 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.
- Private
Bucket boolAccess - 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 Byteplus.Auth Get Domain Origin Origin Action Origin Line Private Bucket Auth - 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.
- Http
Port 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.
- Https
Port 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.
- Instance
Type 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.
- Origin
Host 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.
- Origin
Type 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.
- Private
Bucket boolAccess - 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 GetAuth Domain Origin Origin Action Origin Line Private Bucket Auth - 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.
- http
Port 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.
- https
Port 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.
- instance
Type 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.
- origin
Host 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.
- origin
Type 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.
- private
Bucket BooleanAccess - 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 GetAuth Domain Origin Origin Action Origin Line Private Bucket Auth - 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.
- http
Port 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.
- https
Port 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.
- instance
Type 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.
- origin
Host 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.
- origin
Type 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.
- private
Bucket booleanAccess - 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 GetAuth Domain Origin Origin Action Origin Line Private Bucket Auth - 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_ boolaccess - 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_ Getauth Domain Origin Origin Action Origin Line Private Bucket Auth - 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.
- http
Port 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.
- https
Port 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.
- instance
Type 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.
- origin
Host 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.
- origin
Type 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.
- private
Bucket BooleanAccess - 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 Property MapAuth - 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
- Auth
Type 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
- Tos
Auth Byteplus.Information Get Domain Origin Origin Action Origin Line Private Bucket Auth Tos Auth Information - Specifies the access key for the third-party cloud provider. This parameter is only valid when Switch is true.
- Auth
Type 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
- Tos
Auth GetInformation Domain Origin Origin Action Origin Line Private Bucket Auth Tos Auth Information - Specifies the access key for the third-party cloud provider. This parameter is only valid when Switch is true.
- auth
Type 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
- tos
Auth GetInformation Domain Origin Origin Action Origin Line Private Bucket Auth Tos Auth Information - Specifies the access key for the third-party cloud provider. This parameter is only valid when Switch is true.
- auth
Type 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
- tos
Auth GetInformation Domain Origin Origin Action Origin Line Private Bucket Auth Tos Auth Information - 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_ Getinformation Domain Origin Origin Action Origin Line Private Bucket Auth Tos Auth Information - Specifies the access key for the third-party cloud provider. This parameter is only valid when Switch is true.
- auth
Type 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
- tos
Auth Property MapInformation - Specifies the access key for the third-party cloud provider. This parameter is only valid when Switch is true.
GetDomainOriginOriginActionOriginLinePrivateBucketAuthTosAuthInformation
- Access
Key stringId - 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 stringSecret - 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 stringId - 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 stringSecret - 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 StringId - 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 StringSecret - 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 stringId - 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 stringSecret - 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_ strid - 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_ strsecret - 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 StringId - 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 StringSecret - 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
- Status
Code 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.
- Status
Code 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.
- status
Code 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 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.
- status
Code 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
- Origin
Rewrite List<Byteplus.Rules Get Domain Origin Rewrite Origin Rewrite Rule> - 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.
- Origin
Rewrite []GetRules Domain Origin Rewrite Origin Rewrite Rule - 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.
- origin
Rewrite List<GetRules Domain Origin Rewrite Origin Rewrite Rule> - 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 GetRules Domain Origin Rewrite Origin Rewrite Rule[] - 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_ Sequence[Getrules Domain Origin Rewrite Origin Rewrite Rule] - 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.
- origin
Rewrite List<Property Map>Rules - 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.
Get Domain Origin Rewrite Origin Rewrite Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Origin
Rewrite Byteplus.Action Get Domain Origin Rewrite Origin Rewrite Rule Origin Rewrite Action - Indicates a rule configuration for origin path rewrite.
- Condition
Get
Domain Origin Rewrite Origin Rewrite Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Origin
Rewrite GetAction Domain Origin Rewrite Origin Rewrite Rule Origin Rewrite Action - Indicates a rule configuration for origin path rewrite.
- condition
Get
Domain Origin Rewrite Origin Rewrite Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- origin
Rewrite GetAction Domain Origin Rewrite Origin Rewrite Rule Origin Rewrite Action - Indicates a rule configuration for origin path rewrite.
- condition
Get
Domain Origin Rewrite Origin Rewrite Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- origin
Rewrite GetAction Domain Origin Rewrite Origin Rewrite Rule Origin Rewrite Action - Indicates a rule configuration for origin path rewrite.
- condition
Get
Domain Origin Rewrite Origin Rewrite Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- origin_
rewrite_ Getaction Domain Origin Rewrite Origin Rewrite Rule Origin Rewrite Action - 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.
- origin
Rewrite Property MapAction - Indicates a rule configuration for origin path rewrite.
GetDomainOriginRewriteOriginRewriteRuleCondition
- Condition
Rules List<Byteplus.Get Domain Origin Rewrite Origin Rewrite Rule Condition Condition Rule> - 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 []GetDomain Origin Rewrite Origin Rewrite Rule Condition Condition Rule - 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 List<GetDomain Origin Rewrite Origin Rewrite Rule Condition Condition Rule> - 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 GetDomain Origin Rewrite Origin Rewrite Rule Condition Condition Rule[] - 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[GetDomain Origin Rewrite Origin Rewrite Rule Condition Condition Rule] - 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.
- condition
Rules 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
- Rewrite
Type 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.
- Source
Path 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.
- Target
Path 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 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.
- Source
Path 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.
- Target
Path 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 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.
- source
Path 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.
- target
Path 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 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.
- source
Path 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.
- target
Path 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.
- rewrite
Type 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.
- source
Path 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.
- target
Path 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
- Sni
Domain 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.
- Sni
Domain 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.
- sni
Domain 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 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.
- sni
Domain 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
- Optimization
Types 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.
- Optimization
Types []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.
- optimization
Types 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.
- optimization
Types 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.
- optimization
Types 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
- Redirection
Rules List<Byteplus.Get Domain Redirection Rewrite Redirection Rule> - 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.
- Redirection
Rules []GetDomain Redirection Rewrite Redirection Rule - 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.
- redirection
Rules List<GetDomain Redirection Rewrite Redirection Rule> - 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 GetDomain Redirection Rewrite Redirection Rule[] - 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[GetDomain Redirection Rewrite Redirection Rule] - 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.
- redirection
Rules 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
- Redirection
Action Byteplus.Get Domain Redirection Rewrite Redirection Rule Redirection Action - Indicates a URL redirect rewrite rule
- Redirection
Action GetDomain Redirection Rewrite Redirection Rule Redirection Action - Indicates a URL redirect rewrite rule
- redirection
Action GetDomain Redirection Rewrite Redirection Rule Redirection Action - Indicates a URL redirect rewrite rule
- redirection
Action GetDomain Redirection Rewrite Redirection Rule Redirection Action - Indicates a URL redirect rewrite rule
- redirection_
action GetDomain Redirection Rewrite Redirection Rule Redirection Action - Indicates a URL redirect rewrite rule
- redirection
Action Property Map - Indicates a URL redirect rewrite rule
GetDomainRedirectionRewriteRedirectionRuleRedirectionAction
- Redirect
Code 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.
- Source
Path 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.
- Target
Host 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.
- Target
Path 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.
- Target
Protocol 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.
- Target
Query Byteplus.Components Get Domain Redirection Rewrite Redirection Rule Redirection Action Target Query Components - Indicates how the query parameters in the original request URL are handled.
- Redirect
Code 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.
- Source
Path 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.
- Target
Host 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.
- Target
Path 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.
- Target
Protocol 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.
- Target
Query GetComponents Domain Redirection Rewrite Redirection Rule Redirection Action Target Query Components - Indicates how the query parameters in the original request URL are handled.
- redirect
Code 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.
- source
Path 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.
- target
Host 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.
- target
Path 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.
- target
Protocol 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.
- target
Query GetComponents Domain Redirection Rewrite Redirection Rule Redirection Action Target Query Components - Indicates how the query parameters in the original request URL are handled.
- redirect
Code 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.
- source
Path 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.
- target
Host 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.
- target
Path 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.
- target
Protocol 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.
- target
Query GetComponents Domain Redirection Rewrite Redirection Rule Redirection Action Target Query Components - 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_ Getcomponents Domain Redirection Rewrite Redirection Rule Redirection Action Target Query Components - Indicates how the query parameters in the original request URL are handled.
- redirect
Code 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.
- source
Path 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.
- target
Host 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.
- target
Path 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.
- target
Protocol 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.
- target
Query Property MapComponents - 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
- 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 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.
- Referers
Type Byteplus.Get Domain Referer Access Rule Referers Type - 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 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.
-
Byteplus.
Get Domain Referer Access Rule Shared Config - 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.
- 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 []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.
- Referers
Type GetDomain Referer Access Rule Referers Type - 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 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.
-
Get
Domain Referer Access Rule Shared Config - 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.
- allow
Empty 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.
- referers
Type GetDomain Referer Access Rule Referers Type - 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 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.
-
Get
Domain Referer Access Rule Shared Config - 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 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.
- referers
Type GetDomain Referer Access Rule Referers Type - 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 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.
-
Get
Domain Referer Access Rule Shared Config - 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 GetDomain Referer Access Rule Referers Type - 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.
-
Get
Domain Referer Access Rule Shared Config - 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.
- allow
Empty 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.
- referers
Type 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.
- rule
Type 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.
- 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
- Common
Type Byteplus.Get Domain Referer Access Rule Referers Type Common Type - Indicates a CommonType object that contains a list of standard Referers.
- Regular
Type Byteplus.Get Domain Referer Access Rule Referers Type Regular Type - 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 GetDomain Referer Access Rule Referers Type Common Type - Indicates a CommonType object that contains a list of standard Referers.
- Regular
Type GetDomain Referer Access Rule Referers Type Regular Type - 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 GetDomain Referer Access Rule Referers Type Common Type - Indicates a CommonType object that contains a list of standard Referers.
- regular
Type GetDomain Referer Access Rule Referers Type Regular Type - 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 GetDomain Referer Access Rule Referers Type Common Type - Indicates a CommonType object that contains a list of standard Referers.
- regular
Type GetDomain Referer Access Rule Referers Type Regular Type - 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 GetDomain Referer Access Rule Referers Type Common Type - Indicates a CommonType object that contains a list of standard Referers.
- regular_
type GetDomain Referer Access Rule Referers Type Regular Type - 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 Property Map - Indicates a CommonType object that contains a list of standard Referers.
- regular
Type 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
- 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 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.
- 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 []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 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.
- ignore
Scheme 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.
- ignore
Case 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.
- ignore
Scheme 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.
- ignore
Case 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.
- ignore
Scheme 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
- Config
Name string - Indicates the name of a global configuration.
- Config
Name string - Indicates the name of a global configuration.
- config
Name String - Indicates the name of a global configuration.
- config
Name string - Indicates the name of a global configuration.
- config_
name str - Indicates the name of a global configuration.
- config
Name String - Indicates the name of a global configuration.
GetDomainRemoteAuth
- Remote
Auth List<Byteplus.Rules Get Domain Remote Auth Remote Auth Rule> - 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.
- Remote
Auth []GetRules Domain Remote Auth Remote Auth Rule - 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.
- remote
Auth List<GetRules Domain Remote Auth Remote Auth Rule> - 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 GetRules Domain Remote Auth Remote Auth Rule[] - 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_ Sequence[Getrules Domain Remote Auth Remote Auth Rule] - 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.
- remote
Auth List<Property Map>Rules - 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.
Get Domain Remote Auth Remote Auth Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Remote
Auth Byteplus.Rule Action Get Domain Remote Auth Remote Auth Rule Remote Auth Rule Action - Indicates the specific authentication configuration.
- Condition
Get
Domain Remote Auth Remote Auth Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Remote
Auth GetRule Action Domain Remote Auth Remote Auth Rule Remote Auth Rule Action - Indicates the specific authentication configuration.
- condition
Get
Domain Remote Auth Remote Auth Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- remote
Auth GetRule Action Domain Remote Auth Remote Auth Rule Remote Auth Rule Action - Indicates the specific authentication configuration.
- condition
Get
Domain Remote Auth Remote Auth Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- remote
Auth GetRule Action Domain Remote Auth Remote Auth Rule Remote Auth Rule Action - Indicates the specific authentication configuration.
- condition
Get
Domain Remote Auth Remote Auth Rule Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- remote_
auth_ Getrule_ action Domain Remote Auth Remote Auth Rule Remote Auth Rule Action - Indicates the specific authentication configuration.
- condition Property Map
- Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- remote
Auth Property MapRule Action - Indicates the specific authentication configuration.
GetDomainRemoteAuthRemoteAuthRuleCondition
- Condition
Rules List<Byteplus.Get Domain Remote Auth Remote Auth Rule Condition Condition Rule> - 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 []GetDomain Remote Auth Remote Auth Rule Condition Condition Rule - 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 List<GetDomain Remote Auth Remote Auth Rule Condition Condition Rule> - 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 GetDomain Remote Auth Remote Auth Rule Condition Condition Rule[] - 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[GetDomain Remote Auth Remote Auth Rule Condition Condition Rule] - 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.
- condition
Rules 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
- Auth
Mode Byteplus.Config Get Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Mode Config - Indicates the configuration of the authentication server.
- Auth
Response Byteplus.Config Get Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config - The content delivery network needs to handle the authentication status codes returned by the authentication server. This parameter specifies the relevant configuration.
- Query
String Byteplus.Rules Get Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Query String Rules - Represents the parameter settings for authentication requests.
- Request
Body stringRules - 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 Byteplus.Rules Get Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Request Header Rules - Indicates the settings for authentication request headers. You can set up to 50 request headers.
- Auth
Mode GetConfig Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Mode Config - Indicates the configuration of the authentication server.
- Auth
Response GetConfig Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config - The content delivery network needs to handle the authentication status codes returned by the authentication server. This parameter specifies the relevant configuration.
- Query
String GetRules Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Query String Rules - Represents the parameter settings for authentication requests.
- Request
Body stringRules - 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 GetRules Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Request Header Rules - Indicates the settings for authentication request headers. You can set up to 50 request headers.
- auth
Mode GetConfig Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Mode Config - Indicates the configuration of the authentication server.
- auth
Response GetConfig Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config - The content delivery network needs to handle the authentication status codes returned by the authentication server. This parameter specifies the relevant configuration.
- query
String GetRules Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Query String Rules - Represents the parameter settings for authentication requests.
- request
Body StringRules - 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 GetRules Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Request Header Rules - Indicates the settings for authentication request headers. You can set up to 50 request headers.
- auth
Mode GetConfig Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Mode Config - Indicates the configuration of the authentication server.
- auth
Response GetConfig Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config - The content delivery network needs to handle the authentication status codes returned by the authentication server. This parameter specifies the relevant configuration.
- query
String GetRules Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Query String Rules - Represents the parameter settings for authentication requests.
- request
Body stringRules - 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 GetRules Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Request Header Rules - Indicates the settings for authentication request headers. You can set up to 50 request headers.
- auth_
mode_ Getconfig Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Mode Config - Indicates the configuration of the authentication server.
- auth_
response_ Getconfig Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config - The content delivery network needs to handle the authentication status codes returned by the authentication server. This parameter specifies the relevant configuration.
- query_
string_ Getrules Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Query String Rules - Represents the parameter settings for authentication requests.
- request_
body_ strrules - 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_ Getrules Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Request Header Rules - Indicates the settings for authentication request headers. You can set up to 50 request headers.
- auth
Mode Property MapConfig - Indicates the configuration of the authentication server.
- auth
Response Property MapConfig - The content delivery network needs to handle the authentication status codes returned by the authentication server. This parameter specifies the relevant configuration.
- query
String Property MapRules - Represents the parameter settings for authentication requests.
- request
Body StringRules - 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 Property MapRules - Indicates the settings for authentication request headers. You can set up to 50 request headers.
GetDomainRemoteAuthRemoteAuthRuleRemoteAuthRuleActionAuthModeConfig
- Backup
Remote stringAddr - Indicates the backup address of the authentication server. The address format and requirements are the same as the primary address.
- Master
Remote stringAddr - 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 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.
- Path
Value 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).
- Request
Method 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 stringAddr - Indicates the backup address of the authentication server. The address format and requirements are the same as the primary address.
- Master
Remote stringAddr - 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 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.
- Path
Value 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).
- Request
Method 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 StringAddr - Indicates the backup address of the authentication server. The address format and requirements are the same as the primary address.
- master
Remote StringAddr - 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 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.
- path
Value 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).
- request
Method 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 stringAddr - Indicates the backup address of the authentication server. The address format and requirements are the same as the primary address.
- master
Remote stringAddr - 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 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.
- path
Value 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).
- request
Method 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_ straddr - Indicates the backup address of the authentication server. The address format and requirements are the same as the primary address.
- master_
remote_ straddr - 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.
- backup
Remote StringAddr - Indicates the backup address of the authentication server. The address format and requirements are the same as the primary address.
- master
Remote StringAddr - 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 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.
- path
Value 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).
- request
Method 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
- Cache
Action Byteplus.Get Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Cache Action - The content delivery network can cache authentication status codes. This parameter indicates the related configuration.
- Response
Action Byteplus.Get Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Response Action - Indicates how the content delivery network responds to users when authentication fails.
- Status
Code Byteplus.Action Get Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Status Code Action - Specifies how the content delivery network handles authentication status codes.
- Time
Out Byteplus.Action Get Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Time Out Action - Specifies how the content delivery network handles authentication requests after authentication timeout.
- Cache
Action GetDomain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Cache Action - The content delivery network can cache authentication status codes. This parameter indicates the related configuration.
- Response
Action GetDomain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Response Action - Indicates how the content delivery network responds to users when authentication fails.
- Status
Code GetAction Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Status Code Action - Specifies how the content delivery network handles authentication status codes.
- Time
Out GetAction Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Time Out Action - Specifies how the content delivery network handles authentication requests after authentication timeout.
- cache
Action GetDomain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Cache Action - The content delivery network can cache authentication status codes. This parameter indicates the related configuration.
- response
Action GetDomain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Response Action - Indicates how the content delivery network responds to users when authentication fails.
- status
Code GetAction Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Status Code Action - Specifies how the content delivery network handles authentication status codes.
- time
Out GetAction Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Time Out Action - Specifies how the content delivery network handles authentication requests after authentication timeout.
- cache
Action GetDomain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Cache Action - The content delivery network can cache authentication status codes. This parameter indicates the related configuration.
- response
Action GetDomain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Response Action - Indicates how the content delivery network responds to users when authentication fails.
- status
Code GetAction Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Status Code Action - Specifies how the content delivery network handles authentication status codes.
- time
Out GetAction Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Time Out Action - Specifies how the content delivery network handles authentication requests after authentication timeout.
- cache_
action GetDomain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Cache Action - The content delivery network can cache authentication status codes. This parameter indicates the related configuration.
- response_
action GetDomain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Response Action - Indicates how the content delivery network responds to users when authentication fails.
- status_
code_ Getaction Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Status Code Action - Specifies how the content delivery network handles authentication status codes.
- time_
out_ Getaction Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Auth Response Config Time Out Action - Specifies how the content delivery network handles authentication requests after authentication timeout.
- cache
Action Property Map - The content delivery network can cache authentication status codes. This parameter indicates the related configuration.
- response
Action Property Map - Indicates how the content delivery network responds to users when authentication fails.
- status
Code Property MapAction - Specifies how the content delivery network handles authentication status codes.
- time
Out Property MapAction - 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.
- Cache
Keys 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.
- Cache
Keys []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.
- cache
Keys 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.
- cache
Keys 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.
- cache
Keys 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
- Status
Code 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 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 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 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.
- status
Code 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
- Default
Action 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.
- Fail
Code 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.
- Success
Code 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 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.
- Fail
Code 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.
- Success
Code 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 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.
- fail
Code 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.
- success
Code 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 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.
- fail
Code 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.
- success
Code 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.
- default
Action 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.
- fail
Code 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.
- success
Code 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
- Query
String Byteplus.Components Get Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Query String Rules Query String Components - Indicates the strategy for setting authentication request parameters.
- Query
String List<Byteplus.Instances Get Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Query String Rules Query String Instance> - Indicates additional parameter settings in the authentication request. You can set up to 50 parameters.
- Query
String GetComponents Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Query String Rules Query String Components - Indicates the strategy for setting authentication request parameters.
- Query
String []GetInstances Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Query String Rules Query String Instance - Indicates additional parameter settings in the authentication request. You can set up to 50 parameters.
- query
String GetComponents Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Query String Rules Query String Components - Indicates the strategy for setting authentication request parameters.
- query
String List<GetInstances Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Query String Rules Query String Instance> - Indicates additional parameter settings in the authentication request. You can set up to 50 parameters.
- query
String GetComponents Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Query String Rules Query String Components - Indicates the strategy for setting authentication request parameters.
- query
String GetInstances Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Query String Rules Query String Instance[] - Indicates additional parameter settings in the authentication request. You can set up to 50 parameters.
- query_
string_ Getcomponents Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Query String Rules Query String Components - Indicates the strategy for setting authentication request parameters.
- query_
string_ Sequence[Getinstances Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Query String Rules Query String Instance] - Indicates additional parameter settings in the authentication request. You can set up to 50 parameters.
- query
String Property MapComponents - Indicates the strategy for setting authentication request parameters.
- query
String List<Property Map>Instances - 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
- Value
Type 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
- Value
Type 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
- value
Type 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
- value
Type 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
- value
Type 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
- Request
Header Byteplus.Components Get Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Request Header Rules Request Header Components - Indicates the configuration policy for authentication request headers.
- Request
Header List<Byteplus.Instances Get Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Request Header Rules Request Header Instance> - 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 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 GetComponents Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Request Header Rules Request Header Components - Indicates the configuration policy for authentication request headers.
- Request
Header []GetInstances Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Request Header Rules Request Header Instance - 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 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 GetComponents Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Request Header Rules Request Header Components - Indicates the configuration policy for authentication request headers.
- request
Header List<GetInstances Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Request Header Rules Request Header Instance> - 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 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 GetComponents Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Request Header Rules Request Header Components - Indicates the configuration policy for authentication request headers.
- request
Header GetInstances Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Request Header Rules Request Header Instance[] - 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 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_ Getcomponents Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Request Header Rules Request Header Components - Indicates the configuration policy for authentication request headers.
- request_
header_ Sequence[Getinstances Domain Remote Auth Remote Auth Rule Remote Auth Rule Action Request Header Rules Request Header Instance] - 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.
- request
Header Property MapComponents - Indicates the configuration policy for authentication request headers.
- request
Header List<Property Map>Instances - 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 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)
- Value
Type 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)
- Value
Type 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)
- value
Type 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)
- value
Type 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)
- value
Type 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
- Block
Rules List<Byteplus.Get Domain Request Block Rule Block Rule> - 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.
- Block
Rules []GetDomain Request Block Rule Block Rule - 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.
- block
Rules List<GetDomain Request Block Rule Block Rule> - 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 GetDomain Request Block Rule Block Rule[] - 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[GetDomain Request Block Rule Block Rule] - 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.
- block
Rules 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
- Block
Action Byteplus.Get Domain Request Block Rule Block Rule Block Action - Indicates the interception configuration for a rule in the list.
- Condition
Byteplus.
Get Domain Request Block Rule Block Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- Rule
Name 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 GetDomain Request Block Rule Block Rule Block Action - Indicates the interception configuration for a rule in the list.
- Condition
Get
Domain Request Block Rule Block Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- Rule
Name 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 GetDomain Request Block Rule Block Rule Block Action - Indicates the interception configuration for a rule in the list.
- condition
Get
Domain Request Block Rule Block Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- rule
Name 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 GetDomain Request Block Rule Block Rule Block Action - Indicates the interception configuration for a rule in the list.
- condition
Get
Domain Request Block Rule Block Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- rule
Name 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 GetDomain Request Block Rule Block Rule Block Action - Indicates the interception configuration for a rule in the list.
- condition
Get
Domain Request Block Rule Block Rule Condition - 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.
- block
Action 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.
- rule
Name 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.
- Error
Page 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.
- Redirect
Url 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.
- Status
Code 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.
- Error
Page 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.
- Redirect
Url 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.
- Status
Code 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.
- error
Page 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.
- redirect
Url 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.
- status
Code 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.
- error
Page 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.
- redirect
Url 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.
- status
Code 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.
- error
Page 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.
- redirect
Url 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.
- status
Code 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
- Condition
Rules List<Byteplus.Get Domain Request Block Rule Block Rule Condition Condition Rule> - 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 []GetDomain Request Block Rule Block Rule Condition Condition Rule - 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 List<GetDomain Request Block Rule Block Rule Condition Condition Rule> - 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 GetDomain Request Block Rule Block Rule Condition Condition Rule[] - 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[GetDomain Request Block Rule Block Rule Condition Condition Rule] - 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.
- condition
Rules 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.
Get Domain Request Header Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- Request
Header Byteplus.Action Get Domain Request Header Request Header Action - Represents a list of configuration rules for request headers. Each rule includes settings for header operations. You can add up to 50 rules.
- Condition
Get
Domain Request Header Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- Request
Header GetAction Domain Request Header Request Header Action - Represents a list of configuration rules for request headers. Each rule includes settings for header operations. You can add up to 50 rules.
- condition
Get
Domain Request Header Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- request
Header GetAction Domain Request Header Request Header Action - Represents a list of configuration rules for request headers. Each rule includes settings for header operations. You can add up to 50 rules.
- condition
Get
Domain Request Header Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- request
Header GetAction Domain Request Header Request Header Action - Represents a list of configuration rules for request headers. Each rule includes settings for header operations. You can add up to 50 rules.
- condition
Get
Domain Request Header Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- request_
header_ Getaction Domain Request Header Request Header Action - 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.
- request
Header Property MapAction - Represents a list of configuration rules for request headers. Each rule includes settings for header operations. You can add up to 50 rules.
GetDomainRequestHeaderCondition
- Condition
Rules List<Byteplus.Get Domain Request Header Condition Condition Rule> - 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 []GetDomain Request Header Condition Condition Rule - 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 List<GetDomain Request Header Condition Condition Rule> - 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 GetDomain Request Header Condition Condition Rule[] - 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[GetDomain Request Header Condition Condition Rule] - 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.
- condition
Rules 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
- Request
Header List<Byteplus.Instances Get Domain Request Header Request Header Action Request Header Instance> - 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 []GetInstances Domain Request Header Request Header Action Request Header Instance - 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 List<GetInstances Domain Request Header Request Header Action Request Header Instance> - 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 GetInstances Domain Request Header Request Header Action Request Header Instance[] - 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_ Sequence[Getinstances Domain Request Header Request Header Action Request Header Instance] - 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 List<Property Map>Instances - 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)
- Value
Type 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)
- Value
Type 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)
- value
Type 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)
- value
Type 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)
- value
Type 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.
Get Domain Response Header Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Response
Header Byteplus.Action Get Domain Response Header Response Header Action - Indicates operations on the response header performed by the Content Delivery Network when responding to user requests.
- Condition
Get
Domain Response Header Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- Response
Header GetAction Domain Response Header Response Header Action - Indicates operations on the response header performed by the Content Delivery Network when responding to user requests.
- condition
Get
Domain Response Header Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- response
Header GetAction Domain Response Header Response Header Action - Indicates operations on the response header performed by the Content Delivery Network when responding to user requests.
- condition
Get
Domain Response Header Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- response
Header GetAction Domain Response Header Response Header Action - Indicates operations on the response header performed by the Content Delivery Network when responding to user requests.
- condition
Get
Domain Response Header Condition - Indicates the conditions under which this configuration module takes effect, consisting of a set of rules.
- response_
header_ Getaction Domain Response Header Response Header Action - 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.
- response
Header Property MapAction - Indicates operations on the response header performed by the Content Delivery Network when responding to user requests.
GetDomainResponseHeaderCondition
- Condition
Rules List<Byteplus.Get Domain Response Header Condition Condition Rule> - 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 []GetDomain Response Header Condition Condition Rule - 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 List<GetDomain Response Header Condition Condition Rule> - 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 GetDomain Response Header Condition Condition Rule[] - 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[GetDomain Response Header Condition Condition Rule] - 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.
- condition
Rules 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
- Response
Header List<Byteplus.Instances Get Domain Response Header Response Header Action Response Header Instance> - 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 []GetInstances Domain Response Header Response Header Action Response Header Instance - 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 List<GetInstances Domain Response Header Response Header Action Response Header Instance> - 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 GetInstances Domain Response Header Response Header Action Response Header Instance[] - 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_ Sequence[Getinstances Domain Response Header Response Header Action Response Header Instance] - 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 List<Property Map>Instances - 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
- Access
Origin boolControl - 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).
- Value
Type 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 boolControl - 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).
- Value
Type 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 BooleanControl - 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).
- value
Type 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 booleanControl - 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).
- value
Type 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_ boolcontrol - 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.
- access
Origin BooleanControl - 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).
- value
Type 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
- Sign
Name 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.
- Sign
Name 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.
- sign
Name 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 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.
- sign
Name 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
- Signed
Url List<Byteplus.Auth Rules Get Domain Signed Url Auth Signed Url Auth Rule> - 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.
- Signed
Url []GetAuth Rules Domain Signed Url Auth Signed Url Auth Rule - 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.
- signed
Url List<GetAuth Rules Domain Signed Url Auth Signed Url Auth Rule> - 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 GetAuth Rules Domain Signed Url Auth Signed Url Auth Rule[] - 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_ Sequence[Getauth_ rules Domain Signed Url Auth Signed Url Auth Rule] - 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.
- signed
Url List<Property Map>Auth Rules - 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.
Get Domain Signed Url Auth Signed Url Auth Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- Signed
Url Byteplus.Auth Action Get Domain Signed Url Auth Signed Url Auth Rule Signed Url Auth Action - Indicates the configuration for signature calculation.
- Condition
Get
Domain Signed Url Auth Signed Url Auth Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- Signed
Url GetAuth Action Domain Signed Url Auth Signed Url Auth Rule Signed Url Auth Action - Indicates the configuration for signature calculation.
- condition
Get
Domain Signed Url Auth Signed Url Auth Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- signed
Url GetAuth Action Domain Signed Url Auth Signed Url Auth Rule Signed Url Auth Action - Indicates the configuration for signature calculation.
- condition
Get
Domain Signed Url Auth Signed Url Auth Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- signed
Url GetAuth Action Domain Signed Url Auth Signed Url Auth Rule Signed Url Auth Action - Indicates the configuration for signature calculation.
- condition
Get
Domain Signed Url Auth Signed Url Auth Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- signed_
url_ Getauth_ action Domain Signed Url Auth Signed Url Auth Rule Signed Url Auth Action - 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.
- signed
Url Property MapAuth Action - Indicates the configuration for signature calculation.
GetDomainSignedUrlAuthSignedUrlAuthRuleCondition
- Condition
Rules List<Byteplus.Get Domain Signed Url Auth Signed Url Auth Rule Condition Condition Rule> - 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 []GetDomain Signed Url Auth Signed Url Auth Rule Condition Condition Rule - 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 List<GetDomain Signed Url Auth Signed Url Auth Rule Condition Condition Rule> - 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 GetDomain Signed Url Auth Signed Url Auth Rule Condition Condition Rule[] - 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[GetDomain Signed Url Auth Signed Url Auth Rule Condition Condition Rule] - 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.
- condition
Rules 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
- Auth
Algorithm 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.
- Backup
Secret stringKey - 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 Byteplus.Rules Get Domain Signed Url Auth Signed Url Auth Rule Signed Url Auth Action Custom Variable Rules - 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 boolArg - This parameter is not currently available to external users. Do not use this parameter.
- Master
Secret stringKey - Indicates the primary key, with a length of 6–40 characters. It can include printable ASCII characters except Delete (ASCII code 127)
- Rewrite
M3U8 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
M3U8Rule Byteplus.Get Domain Signed Url Auth Signed Url Auth Rule Signed Url Auth Action Rewrite M3U8Rule - 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 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 (!).
- Signature
Rules 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.
- Time
Format 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.
- Time
Name 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.
- Url
Auth stringType - Signature type
- Auth
Algorithm 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.
- Backup
Secret stringKey - 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 GetRules Domain Signed Url Auth Signed Url Auth Rule Signed Url Auth Action Custom Variable Rules - 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 boolArg - This parameter is not currently available to external users. Do not use this parameter.
- Master
Secret stringKey - Indicates the primary key, with a length of 6–40 characters. It can include printable ASCII characters except Delete (ASCII code 127)
- Rewrite
M3U8 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
M3U8Rule GetDomain Signed Url Auth Signed Url Auth Rule Signed Url Auth Action Rewrite M3U8Rule - 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 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 (!).
- Signature
Rules []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.
- Time
Format 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.
- Time
Name 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.
- Url
Auth stringType - Signature type
- auth
Algorithm 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.
- backup
Secret StringKey - 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 GetRules Domain Signed Url Auth Signed Url Auth Rule Signed Url Auth Action Custom Variable Rules - 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.
- keep
Origin BooleanArg - This parameter is not currently available to external users. Do not use this parameter.
- master
Secret StringKey - Indicates the primary key, with a length of 6–40 characters. It can include printable ASCII characters except Delete (ASCII code 127)
- rewrite
M3U8 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.
- rewrite
M3U8Rule GetDomain Signed Url Auth Signed Url Auth Rule Signed Url Auth Action Rewrite M3U8Rule - 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 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 (!).
- signature
Rules 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.
- time
Format 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.
- time
Name 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.
- url
Auth StringType - Signature type
- auth
Algorithm 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.
- backup
Secret stringKey - 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 GetRules Domain Signed Url Auth Signed Url Auth Rule Signed Url Auth Action Custom Variable Rules - 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.
- keep
Origin booleanArg - This parameter is not currently available to external users. Do not use this parameter.
- master
Secret stringKey - Indicates the primary key, with a length of 6–40 characters. It can include printable ASCII characters except Delete (ASCII code 127)
- rewrite
M3U8 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.
- rewrite
M3U8Rule GetDomain Signed Url Auth Signed Url Auth Rule Signed Url Auth Action Rewrite M3U8Rule - 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 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 (!).
- signature
Rules 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.
- time
Format 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.
- time
Name 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.
- url
Auth stringType - 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_ strkey - 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_ Getrules Domain Signed Url Auth Signed Url Auth Rule Signed Url Auth Action Custom Variable Rules - 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_ boolarg - This parameter is not currently available to external users. Do not use this parameter.
- master_
secret_ strkey - Indicates the primary key, with a length of 6–40 characters. It can include printable ASCII characters except Delete (ASCII code 127)
- rewrite_
m3_ boolu8 - 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_ Getu8_ rule Domain Signed Url Auth Signed Url Auth Rule Signed Url Auth Action Rewrite M3U8Rule - 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_ strtype - Signature type
- auth
Algorithm 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.
- backup
Secret StringKey - 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 Property MapRules - 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.
- keep
Origin BooleanArg - This parameter is not currently available to external users. Do not use this parameter.
- master
Secret StringKey - Indicates the primary key, with a length of 6–40 characters. It can include printable ASCII characters except Delete (ASCII code 127)
- rewrite
M3U8 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.
- rewrite
M3U8Rule 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.
- sign
Name 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 (!).
- signature
Rules 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.
- time
Format 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.
- time
Name 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.
- url
Auth StringType - Signature type
GetDomainSignedUrlAuthSignedUrlAuthRuleSignedUrlAuthActionCustomVariableRules
- custom
Variable List<Property Map>Instances - Indicates a variable list
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
- 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
M3U8Param 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.
- 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
M3U8Param 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.
- delete
Param 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.
- keep
M3U8Param 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 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.
- keep
M3U8Param 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_ boolu8_ param - 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 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.
- keep
M3U8Param 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
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.
- Timeout
Rules List<Byteplus.Get Domain Timeout Timeout Rule> - 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 []GetDomain Timeout Timeout Rule - 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.
- timeout
Rules List<GetDomain Timeout Timeout Rule> - 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.
- timeout
Rules GetDomain Timeout Timeout Rule[] - 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[GetDomain Timeout Timeout Rule] - 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.
- timeout
Rules 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.
Get Domain Timeout Timeout Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- Timeout
Action Byteplus.Get Domain Timeout Timeout Rule Timeout Action - Indicates the timeout configuration.
- Condition
Get
Domain Timeout Timeout Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- Timeout
Action GetDomain Timeout Timeout Rule Timeout Action - Indicates the timeout configuration.
- condition
Get
Domain Timeout Timeout Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- timeout
Action GetDomain Timeout Timeout Rule Timeout Action - Indicates the timeout configuration.
- condition
Get
Domain Timeout Timeout Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- timeout
Action GetDomain Timeout Timeout Rule Timeout Action - Indicates the timeout configuration.
- condition
Get
Domain Timeout Timeout Rule Condition - Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- timeout_
action GetDomain Timeout Timeout Rule Timeout Action - Indicates the timeout configuration.
- condition Property Map
- Represents the conditions under which this configuration module takes effect, consisting of a set of rules.
- timeout
Action Property Map - Indicates the timeout configuration.
GetDomainTimeoutTimeoutRuleCondition
- Condition
Rules List<Byteplus.Get Domain Timeout Timeout Rule Condition Condition Rule> - 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 []GetDomain Timeout Timeout Rule Condition Condition Rule - 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 List<GetDomain Timeout Timeout Rule Condition Condition Rule> - 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 GetDomain Timeout Timeout Rule Condition Condition Rule[] - 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[GetDomain Timeout Timeout Rule Condition Condition Rule] - 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.
- condition
Rules 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
- 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.
- 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.
- http
Timeout Integer - Indicates the timeout period for HTTP requests. The value range for this parameter is 5–60.
- tcp
Timeout Integer - Indicates the timeout for TCP requests. The valid range for this parameter is 2–60.
- http
Timeout number - Indicates the timeout period for HTTP requests. The value range for this parameter is 5–60.
- tcp
Timeout 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.
- http
Timeout Number - Indicates the timeout period for HTTP requests. The value range for this parameter is 5–60.
- tcp
Timeout Number - Indicates the timeout for TCP requests. The valid range for this parameter is 2–60.
GetDomainUaAccessRule
- 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 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.
- User
Agents 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.
- 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 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.
- User
Agents []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 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.
- ignore
Case 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.
- rule
Type 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.
- user
Agents 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.
- allow
Empty 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.
- ignore
Case 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.
- rule
Type 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.
- user
Agents 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.
- allow
Empty 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.
- ignore
Case 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.
- rule
Type 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.
- user
Agents 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
- Normalize
Objects 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 (/).
- Normalize
Objects []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 (/).
- normalize
Objects 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 (/).
- normalize
Objects 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 (/).
- normalize
Objects 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
byteplusccTerraform Provider.
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
published on Thursday, Apr 2, 2026 by Byteplus
