Condition that makes up an access control rule
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
MatchFrom | String | Yes | Field to match |
MatchParam | String | Yes | String to match |
Operator | String | Yes | Relation between the field and content |
MatchContent | String | Yes | Content to match |
Custom ACL rule
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
RuleName | String | Yes | Name of the rule |
Action | String | Yes | Action |
RuleStatus | String | Yes | Status of the rule |
Conditions | Array of ACLCondition | Yes | ACL rule |
RulePriority | Integer | Yes | Priority of the rule |
RuleID | Integer | No | ID of the rule Note: This field may return null , indicating that no valid value can be obtained. |
UpdateTime | String | No | Update time Note: This field may return null , indicating that no valid value can be obtained. |
PunishTime | Integer | No | IP blocking time Note: This field may return null , indicating that no valid value can be obtained. |
PunishTimeUnit | String | No | IP blocking time unit Note: This field may return null , indicating that no valid value can be obtained. |
Name | String | No | Name of the custom block page Note: This field may return null , indicating that no valid value can be obtained. |
PageId | Integer | No | ID of the custom block page Note: This field may return null , indicating that no valid value can be obtained. |
RedirectUrl | String | No | Redirection URL, which must be a subdomain name of the site Note: This field may return null , indicating that no valid value can be obtained. |
ResponseCode | Integer | No | Return code configured on the custom block page Note: This field may return null , indicating that no valid value can be obtained. |
ACL configuration
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Switch |
UserRules | Array of ACLUserRule | Yes | ACL user rule |
AI rule engine
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
Mode | String | No | smart_status_close : Disable; smart_status_open : Block;smart_status_observe : Observe.Note: This field may return null , indicating that no valid value can be obtained. |
Application proxy instance
Used by actions: DescribeApplicationProxy.
Name | Type | Description |
---|---|---|
ProxyId | String | ID of the proxy Note: This field may return null , indicating that no valid value can be obtained. |
ProxyName | String | Name of the proxy: Domain name or subdomain name when ProxyType=hostname Instance name when ProxyType=instance |
PlatType | String | Scheduling mode:ip : Anycast IPdomain : CNAME |
SecurityType | Integer | 0 : Disable security protection; 1 : Enable security protection. |
AccelerateType | Integer | 0 : Disable acceleration; 1 : Enable acceleration. |
ForwardClientIp | String | This field is moved to Rule.ForwardClientIp . |
SessionPersist | Boolean | This field is moved to Rule.SessionPersist . |
Rule | Array of ApplicationProxyRule | Rule list |
Status | String | Status:online : Enableoffline : Disableprogress : Deployingstopping : Disablingfail : Deployment/Disabling failedNote: This field may return null , indicating that no valid value can be obtained. |
ScheduleValue | Array of String | Scheduling information Note: This field may return null , indicating that no valid value can be obtained. |
UpdateTime | Timestamp ISO8601 | Update time Note: This field may return null , indicating that no valid value can be obtained. |
ZoneId | String | Site ID Note: This field may return null , indicating that no valid value can be obtained. |
ZoneName | String | Site name Note: This field may return null , indicating that no valid value can be obtained. |
SessionPersistTime | Integer | Session persistence duration Note: This field may return null , indicating that no valid value can be obtained. |
ProxyType | String | Specifies how a layer-4 proxy is created.hostname : Create by subdomain nameinstance : Create by instanceNote: This field may return null, indicating that no valid values can be obtained. |
HostId | String | When ProxyType=hostname :ProxyName indicates a specified domain name;HostId indicates a unique ID of the domain name.Note: This field may return null, indicating that no valid values can be obtained. |
Application proxy rule
Used by actions: CreateApplicationProxy, CreateApplicationProxyRules, DescribeApplicationProxy, DescribeApplicationProxyDetail.
Name | Type | Required | Description |
---|---|---|---|
Proto | String | Yes | Protocol. Valid values: TCP and UDP . |
Port | Array of String | Yes | Port. Valid values:80 : Port 8081-90 : Port range 81-90 |
OriginType | String | Yes | Origin server type. Valid values:custom : Specified originsorigins : Origin group |
OriginValue | Array of String | Yes | Origin server information: When OriginType=custom , it indicates one or more origin servers. Example:OriginValue=["8.8.8.8:80","9.9.9.9:80"] OriginValue=["test.com:80"] When OriginType=origins , it indicates an origin group ID. Example:OriginValue=["origin-xxx"] |
RuleId | String | No | Rule ID Note: This field may return null , indicating that no valid value can be obtained. |
Status | String | No | Status:online : Enableoffline : Disableprogress : Deployingstopping : Disablingfail : Deployment/Disabling failed |
ForwardClientIp | String | No | Passes the client IP. When Proto=TCP , valid values:TOA : Pass the client IP via TOAPPV1 : Pass the client IP via Proxy Protocol V1PPV2 : Pass the client IP via Proxy Protocol V2OFF : Do not pass the client IP.When Proto=UDP , valid values:PPV2 : Pass the client IP via Proxy Protocol V2OFF : Do not pass the client IP. |
SessionPersist | Boolean | No | Specifies whether to enable session persistence |
Bot security configuration
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | No | Whether to enable bot security configuration |
ManagedRule | BotManagedRule | No | Preset rules |
UaBotRule | BotManagedRule | No | Not supported currently |
IspBotRule | BotManagedRule | No | Not supported currently |
PortraitRule | BotPortraitRule | No | User portrait rules |
IntelligenceRule | IntelligenceRule | No | Bot intelligence rules Note: This field may return null, indicating that no valid values can be obtained. |
Bot attack log
Used by actions: DescribeBotLog.
Name | Type | Description |
---|---|---|
AttackTime | Integer | Attack time Note: This field may return null, indicating that no valid values can be obtained. |
AttackIp | String | Attack IP Note: This field may return null, indicating that no valid values can be obtained. |
Domain | String | Domain name Note: This field may return null, indicating that no valid values can be obtained. |
RequestUri | String | Request URI Note: This field may return null, indicating that no valid values can be obtained. |
AttackType | String | Attack type Note: This field may return null, indicating that no valid values can be obtained. |
RequestMethod | String | Request method Note: This field may return null, indicating that no valid values can be obtained. |
AttackContent | String | Attack content Note: This field may return null, indicating that no valid values can be obtained. |
RiskLevel | String | Risk grade Note: This field may return null, indicating that no valid values can be obtained. |
RuleId | Integer | Rule number Note: This field may return null, indicating that no valid values can be obtained. |
SipCountryCode | String | IP country/region Note: This field may return null, indicating that no valid values can be obtained. |
EventId | String | Event ID Note: This field may return null, indicating that no valid values can be obtained. |
DisposalMethod | String | Processing method Note: This field may return null, indicating that no valid values can be obtained. |
HttpLog | String | http_log Note: This field may return null, indicating that no valid values can be obtained. |
Ua | String | user agent Note: This field may return null, indicating that no valid values can be obtained. |
DetectionMethod | String | Detection method Note: This field may return null, indicating that no valid values can be obtained. |
Confidence | String | Confidence Note: This field may return null, indicating that no valid values can be obtained. |
Maliciousness | String | Maliciousness Note: This field may return null, indicating that no valid values can be obtained. |
Block log in rate-limiting policy
Used by actions: DescribeBotLog.
Name | Type | Description |
---|---|---|
List | Array of BotLog | Data set of bot attack logs Note: This field may return null, indicating that no valid values can be obtained. |
PageNo | Integer | Current page Note: This field may return null, indicating that no valid values can be obtained. |
PageSize | Integer | Number of items per page Note: This field may return null, indicating that no valid values can be obtained. |
Pages | Integer | Total number of pages Note: This field may return null, indicating that no valid values can be obtained. |
TotalSize | Integer | Total number of items Note: This field may return null, indicating that no valid values can be obtained. |
Bot managed rules
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
ManagedIds | Array of Integer | Yes | ID of the rule to be enabled Note: This field may return null , indicating that no valid value can be obtained. |
RuleID | Integer | Yes | ID of the rule being applied |
Action | String | No | Action of the rule. Values: drop ; trans ; monitor ; alg . |
PunishTime | Integer | No | The amount of time the IP is blocked Note: This field may return null , indicating that no valid value can be obtained. |
PunishTimeUnit | String | No | Unit of IP blocking time Note: This field may return null , indicating that no valid value can be obtained. |
Name | String | No | Name of the custom block page Note: This field may return null , indicating that no valid value can be obtained. |
PageId | Integer | No | ID of the custom block page Note: This field may return null , indicating that no valid value can be obtained. |
RedirectUrl | String | No | Redirection URL, which must be a subdomain name of your site encoded by URLEncode Note: This field may return null , indicating that no valid value can be obtained. |
ResponseCode | Integer | No | Response code returned after redirection Note: This field may return null , indicating that no valid value can be obtained. |
TransManagedIds | Array of Integer | No | ID of the rule that is set to allow requests Note: This field may return null , indicating that no valid value can be obtained. |
AlgManagedIds | Array of Integer | No | ID of the rule that is set to verify requests by JavaScript challenge Note: This field may return null , indicating that no valid value can be obtained. |
CapManagedIds | Array of Integer | No | ID of the rule that is set to verify requests by CAPTCHA Note: This field may return null , indicating that no valid value can be obtained. |
MonManagedIds | Array of Integer | No | ID of the rule that is set to observe requests Note: This field may return null , indicating that no valid value can be obtained. |
DropManagedIds | Array of Integer | No | ID of the rule that is set to block requests Note: This field may return null , indicating that no valid value can be obtained. |
Bot managed rule details
Used by actions: DescribeBotManagedRules.
Name | Type | Description |
---|---|---|
RuleId | Integer | ID of the rule |
Description | String | Rule description |
RuleTypeName | String | Rule type |
Status | String | Whether the rule is enabled |
Bot user portrait rules
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
RuleID | Integer | No | ID of the rule being applied Note: This field may return null , indicating that no valid value can be obtained. |
AlgManagedIds | Array of Integer | No | ID of the rule that is set to verify requests by JavaScript challenge Note: This field may return null , indicating that no valid value can be obtained. |
CapManagedIds | Array of Integer | No | ID of the rule that is set to verify requests by CAPTCHA Note: This field may return null , indicating that no valid value can be obtained. |
MonManagedIds | Array of Integer | No | ID of the rule that is set to observe requests Note: This field may return null , indicating that no valid value can be obtained. |
DropManagedIds | Array of Integer | No | ID of the rule that is set to block requests Note: This field may return null , indicating that no valid value can be obtained. |
Switch | String | No | Feature switch Note: This field may return null, indicating that no valid values can be obtained. |
CC block event
Used by actions: DescribeWebProtectionAttackEvents.
Name | Type | Description |
---|---|---|
ClientIp | String | Client IP Note: This field may return null, indicating that no valid values can be obtained. |
InterceptNum | Integer | Number of blocks per minute Note: This field may return null, indicating that no valid values can be obtained. |
InterceptTime | Integer | Block time in rate-limiting policy per minute in seconds |
CC block event data
Used by actions: DescribeWebProtectionAttackEvents.
Name | Type | Description |
---|---|---|
List | Array of CCInterceptEvent | Data set of attack events Note: This field may return null, indicating that no valid values can be obtained. |
PageNo | Integer | Current page Note: This field may return null, indicating that no valid values can be obtained. |
PageSize | Integer | Number of items per page Note: This field may return null, indicating that no valid values can be obtained. |
Pages | Integer | Total number of pages Note: This field may return null, indicating that no valid values can be obtained. |
TotalSize | Integer | Total number of items Note: This field may return null, indicating that no valid values can be obtained. |
Block log in rate-limiting policy
Used by actions: DescribeWebProtectionLog.
Name | Type | Description |
---|---|---|
AttackTime | Integer | Attack time Note: This field may return null, indicating that no valid values can be obtained. |
AttackSip | String | Attack source IP Note: This field may return null, indicating that no valid values can be obtained. |
AttackDomain | String | Attack domain name Note: This field may return null, indicating that no valid values can be obtained. |
RequestUri | String | Request URI Note: This field may return null, indicating that no valid values can be obtained. |
HitCount | Integer | Number of hits Note: This field may return null, indicating that no valid values can be obtained. |
SipCountryCode | String | IP country/region Note: This field may return null, indicating that no valid values can be obtained. |
EventId | String | Event ID Note: This field may return null, indicating that no valid values can be obtained. |
DisposalMethod | String | Processing method Note: This field may return null, indicating that no valid values can be obtained. |
HttpLog | String | http_log Note: This field may return null, indicating that no valid values can be obtained. |
RuleId | Integer | Rule number Note: This field may return null, indicating that no valid values can be obtained. |
RiskLevel | String | Risk grade Note: This field may return null, indicating that no valid values can be obtained. |
Block log in rate-limiting policy
Used by actions: DescribeWebProtectionLog.
Name | Type | Description |
---|---|---|
List | Array of CCLog | Data set of CC block logs Note: This field may return null, indicating that no valid values can be obtained. |
PageNo | Integer | Current page Note: This field may return null, indicating that no valid values can be obtained. |
PageSize | Integer | Number of items per page Note: This field may return null, indicating that no valid values can be obtained. |
Pages | Integer | Total number of pages Note: This field may return null, indicating that no valid values can be obtained. |
TotalSize | Integer | Total number of items Note: This field may return null, indicating that no valid values can be obtained. |
Cache rule configuration
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Cache | CacheConfigCache | No | Cache configuration Note: This field may return null , indicating that no valid value can be obtained. |
NoCache | CacheConfigNoCache | No | No-cache configuration Note: This field may return null , indicating that no valid value can be obtained. |
FollowOrigin | CacheConfigFollowOrigin | No | Follows the origin server configuration Note: This field may return null , indicating that no valid value can be obtained. |
Cache time settings
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Cache configuration switchon : Enableoff : DisableNote: This field may return null , indicating that no valid value can be obtained. |
CacheTime | Integer | No | Cache expiration time settings Unit: second. The maximum value is 365 days. Note: This field may return null , indicating that no valid value can be obtained. |
IgnoreCacheControl | String | No | Specifies whether to enable force cacheon : Enableoff : DisableNote: This field may return null , indicating that no valid value can be obtained. |
Follows the origin server configuration
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Specifies whether to follow the origin server configurationon : Enableoff : DisableNote: This field may return null , indicating that no valid value can be obtained. |
Do not cache the configuration
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Whether to cache the configurationon : Do not cacheoff : CacheNote: This field may return null , indicating that no valid values can be obtained. |
Cache key configuration
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
FullUrlCache | String | No | Specifies whether to enable full-path cacheon : Enable full-path cache (i.e., disable Ignore Query String)off : Disable full-path cache (i.e., enable Ignore Query String)Note: This field may return null , indicating that no valid value can be obtained. |
IgnoreCase | String | No | Specifies whether the cache key is case sensitive Note: This field may return null , indicating that no valid value can be obtained. |
QueryString | QueryString | No | Request parameter contained in CacheKey Note: This field may return null , indicating that no valid value can be obtained. |
Cache prefresh
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Configuration switch |
Percent | Integer | No | Cache prefresh percentage. Values: 1-99 Note: This field may return null, indicating that no valid values can be obtained. |
Query filter to search for certificates
Used by actions: DescribeHostsCertificate.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Filters by the field name. Values: - host : Domain name- certId : Certificate ID- certAlias : Certificate alias- certType: default : Default certificate; upload : External certificate; managed : Tencent Cloud certificate. |
Values | Array of String | Yes | Filters by the field value |
Fuzzy | Boolean | No | Specifies whether to enable fuzzy query, which only supports the host field.If it is enabled, the length of Value must be 1. |
Sorting conditions for query results.
Used by actions: DescribeHostsCertificate.
Name | Type | Required | Description |
---|---|---|---|
Key | String | Yes | Fields that can be sorted. Values:createTime : Domain name creation timecertExpireTime : Certificate expiration timecertDeployTime : Certificate deployment time |
Sequence | String | No | Sorting order. Valid values: asc and desc (default). |
Client IP header
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Specifies whether to enable client IP header Note: This field may return null , indicating that no valid value can be obtained. |
HeaderName | String | No | Name of the origin-pull client IP request header Note: This field may return null , indicating that no valid value can be obtained. |
CNAME status
Used by actions: DescribeCnameStatus.
Name | Type | Description |
---|---|---|
Name | String | Record name |
Cname | String | CNAME address Note: This field may return null , indicating that no valid value can be obtained. |
Status | String | Statusactive : Activatedmoved : Not activatedNote: This field may return null , indicating that no valid value can be obtained. |
Smart compression
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Whether to enable Smart compressionon : Enableoff : Disable |
DDoS port filtering configuration
Used by actions: ModifyDDoSPolicy.
Name | Type | Required | Description |
---|---|---|---|
DportEnd | Integer | No | Destination port used as the end port |
DportStart | Integer | No | Destination port used as the start port |
SportEnd | Integer | No | Source port used as the end port |
SportStart | Integer | No | Source port used as the start port |
Protocol | String | No | Protocol. Values: tcp , udp , and all . |
Action | String | No | Action. Values: drop (Drop the request); transmit (Allow the request); forward (Continue to offer protection). |
Default | Integer | No | Whether it is a system configuration. Values: 0 (manual configuration); 1 (system configuration). |
DDoS protection against protocol and connection attacks
Used by actions: ModifyDDoSPolicy.
Name | Type | Required | Description |
---|---|---|---|
DropTcp | String | Yes | Enables TCP protocol blocking. on (enable); off (disable). |
DropUdp | String | Yes | Enables UDP protocol blocking. on (enable); off (disable). |
DropIcmp | String | Yes | Enables ICMP protocol blocking. on (enable); off (disable). |
DropOther | String | Yes | Enables blocking for other protocols. on (enable); off (disable). |
SourceCreateLimit | Integer | Yes | Number of new connections the source port can establish. Value range: 0-4294967295. |
SourceConnectLimit | Integer | Yes | Number of concurrent connections the source port can establish. Value range: 0-4294967295. |
DestinationCreateLimit | Integer | Yes | Number of new connections the destination port can establish. Value range: 0-4294967295. |
DestinationConnectLimit | Integer | Yes | Number of concurrent connections the destination port can establish. Value range: 0-4294967295. |
AbnormalConnectNum | Integer | Yes | Number of abnormal connections allowed. Value range: 0-4294967295. |
AbnormalSynRatio | Integer | Yes | Specifies the ratio of SYN exceptions to trigger alerts. Value range: 0-100 |
AbnormalSynNum | Integer | Yes | Specifies a max number of SYN packets that triggers alarms. Value range: 0-65535 |
ConnectTimeout | Integer | Yes | Connection timeout period. Value range: 0-65535. |
EmptyConnectProtect | String | Yes | Whether to enable null session protection. 0 : Disable; 1 : Enable. |
UdpShard | String | No | Whether to enable UDP fragmentation. off : Disable; on : Enable.Note: This field may return null, indicating that no valid values can be obtained. |
DDoS protection for the application layer (layer 7)
Used by actions: DescribeZoneDDoSPolicy.
Name | Type | Required | Description |
---|---|---|---|
Host | String | No | Second-level domain name Note: This field may return null , indicating that no valid value can be obtained. |
Status | String | No | Status of the domain nameinit : NS to be switchedoffline : Site acceleration not enabled with DNSprocess : Deployment in progressonline : NormalNote: This field may return null , indicating that no valid value can be obtained. |
AccelerateType | String | No | Site acceleration switch. on : Enable site acceleration; off : Disable site acceleration. This field can be used together with SecurityType .Note: This field may return null , indicating that no valid value can be obtained. |
SecurityType | String | No | Security acceleration switch. on : Enable site acceleration; off : Disable site acceleration. This field can be used together with AccelerateType .Note: This field may return null , indicating that no valid value can be obtained. |
DDoS configuration
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Switch |
DDoS feature filtering
Used by actions: ModifyDDoSPolicy.
Name | Type | Required | Description |
---|---|---|---|
Action | String | No | Action. drop : Drop the request; transmit : Allow the request; drop_block : Drop the request and block it; forward : Continue to offer protection. |
Depth | Integer | No | Sets how far from the first search position |
Depth2 | Integer | No | Sets how far from the second search position |
DportEnd | Integer | No | End of the destination port |
DportStart | Integer | No | Start of the destination port |
IsNot | Integer | No | Whether to match string 1 that does not contain all the specified elements |
IsNot2 | Integer | No | Whether to match string 2 that does not contain all the specified elements |
MatchLogic | String | No | Logical operator that combines two conditions. Values: none , and and or . If there is only one condition, pass in none for this condition only. |
MatchType | String | No | Matching method of the first condition. pcre : Regex match; sunday : String match. |
MatchType2 | String | No | Matching method of the second condition. pcre : Regex match; sunday : String match. |
Offset | Integer | No | Offset from the first search position |
Offset2 | Integer | No | Offset from the second search position |
PacketMax | Integer | No | Maximum packet length |
PacketMin | Integer | No | Minimum packet length |
Protocol | String | No | Protocol. Values: tcp , udp , icmp and all . |
SportEnd | Integer | No | End of the source port |
SportStart | Integer | No | Start of the source port |
Str | String | No | String in the first condition |
Str2 | String | No | String in the second condition |
MatchBegin | String | No | Layer at which each match starts. Values: begin_l5 , no_match , begin_l3 and begin_l4 . |
MatchBegin2 | String | No | Layer at which each match starts. Values: begin_l5 , no_match , begin_l3 and begin_l4 . |
DDoS regional blocking
Used by actions: ModifyDDoSPolicy.
Name | Type | Required | Description |
---|---|---|---|
RegionId | Array of Integer | No | Region information Note: This field may return null , indicating that no valid value can be obtained. |
Switch | String | No | Whether to remove all settings when empty strings are passed in. Default value: off (remove)Note: This field may return null , indicating that no valid value can be obtained. |
DDoS protection level
Used by actions: ModifyDDoSPolicy.
Name | Type | Required | Description |
---|---|---|---|
AiStatus | String | Yes | This field is not supported. Value: off . |
Appid | String | Yes | User appid |
PlyLevel | String | Yes | Protection level. Values: low , middle , and high . |
IP Allowlist/Blocklist for DDoS protection
Used by actions: ModifyDDoSPolicy.
Name | Type | Required | Description |
---|---|---|---|
Ip | String | No | Start IP address in a specific range Note: This field may return null , indicating that no valid value can be obtained. |
Mask | Integer | No | Start mask in a specific range Note: This field may return null , indicating that no valid value can be obtained. |
Type | String | No | IP type. block : IP blocklist; allow : IP allowlist.Note: This field may return null , indicating that no valid value can be obtained. |
UpdateTime | Integer | No | Timestamp Note: This field may return null , indicating that no valid value can be obtained. |
Ip2 | String | No | End IP address in a specific range Note: This field may return null , indicating that no valid value can be obtained. |
Mask2 | Integer | No | End mask in a specific range Note: This field may return null , indicating that no valid value can be obtained. |
DDoS attack event object
Used by actions: DescribeDDosAttackEvent.
Name | Type | Description |
---|---|---|
PolicyId | Integer | DDoS policy group ID Note: This field may return null, indicating that no valid values can be obtained. |
AttackType | String | Attack type (corresponding to interaction event name) Note: This field may return null, indicating that no valid values can be obtained. |
AttackStatus | Integer | Attack status Note: This field may return null, indicating that no valid values can be obtained. |
AttackMaxBandWidth | Integer | Maximum attack bandwidth Note: This field may return null, indicating that no valid values can be obtained. |
AttackPacketMaxRate | Integer | Peak attack packet rate Note: This field may return null, indicating that no valid values can be obtained. |
AttackStartTime | Integer | Attack start time in seconds Note: This field may return null, indicating that no valid values can be obtained. |
AttackEndTime | Integer | Attack end time in seconds Note: This field may return null, indicating that no valid values can be obtained. |
EventId | String | Event ID Note: This field may return null, indicating that no valid values can be obtained. |
ZoneId | String | Site ID Note: This field may return null, indicating that no valid values can be obtained. |
DDoS attack event data
Used by actions: DescribeDDosAttackEvent.
Name | Type | Description |
---|---|---|
List | Array of DDosAttackEvent | Data set of attack events Note: This field may return null, indicating that no valid values can be obtained. |
PageNo | Integer | Current page Note: This field may return null, indicating that no valid values can be obtained. |
PageSize | Integer | Number of items per page Note: This field may return null, indicating that no valid values can be obtained. |
Pages | Integer | Total number of pages Note: This field may return null, indicating that no valid values can be obtained. |
TotalSize | Integer | Total number of items Note: This field may return null, indicating that no valid values can be obtained. |
DDoS attack event details
Used by actions: DescribeDDosAttackEventDetail.
Name | Type | Description |
---|---|---|
AttackStatus | Integer | Attack status |
AttackType | String | Attack type |
EndTime | Integer | End time |
StartTime | Integer | Start time |
MaxBandWidth | Integer | Maximum bandwidth |
PacketMaxRate | Integer | Maximum packet rate |
EventId | String | Event ID |
PolicyId | Integer | DDoS policy group ID |
DDoS attack event object
Used by actions: DescribeDDosAttackSourceEvent.
Name | Type | Description |
---|---|---|
AttackSourceIp | String | Attack source IP Note: This field may return null, indicating that no valid values can be obtained. |
AttackRegion | String | Country/Region Note: This field may return null, indicating that no valid values can be obtained. |
AttackFlow | Integer | Accumulative attack traffic Note: This field may return null, indicating that no valid values can be obtained. |
AttackPacketNum | Integer | Accumulative number of attack packets Note: This field may return null, indicating that no valid values can be obtained. |
DDoS attack source data
Used by actions: DescribeDDosAttackSourceEvent.
Name | Type | Description |
---|---|---|
List | Array of DDosAttackSourceEvent | DDoS attack source data set Note: This field may return null, indicating that no valid values can be obtained. |
PageNo | Integer | Current page Note: This field may return null, indicating that no valid values can be obtained. |
PageSize | Integer | Number of items per page Note: This field may return null, indicating that no valid values can be obtained. |
Pages | Integer | Total number of pages Note: This field may return null, indicating that no valid values can be obtained. |
TotalSize | Integer | Total number of items Note: This field may return null, indicating that no valid values can be obtained. |
Major DDoS attack event
Used by actions: DescribeDDosMajorAttackEvent.
Name | Type | Description |
---|---|---|
PolicyId | Integer | DDoS policy group ID |
AttackMaxBandWidth | Integer | Maximum attack bandwidth |
AttackTime | Integer | Attack time in seconds |
Major attack object data
Used by actions: DescribeDDosMajorAttackEvent.
Name | Type | Description |
---|---|---|
List | Array of DDosMajorAttackEvent | DDosMajorAttackEvent DDoS attack eventNote: This field may return null, indicating that no valid values can be obtained. |
PageNo | Integer | Current page Note: This field may return null, indicating that no valid values can be obtained. |
PageSize | Integer | Number of items per page Note: This field may return null, indicating that no valid values can be obtained. |
Pages | Integer | Total number of pages Note: This field may return null, indicating that no valid values can be obtained. |
TotalSize | Integer | Total number of items Note: This field may return null, indicating that no valid values can be obtained. |
Data items in a DNS request curve
Used by actions: DescribeDnsData.
Name | Type | Description |
---|---|---|
Time | Timestamp ISO8601 | Time |
Value | Integer | Value Note: This field may return null , indicating that no valid value can be obtained. |
DDoS port filtering
Used by actions: ModifyDDoSPolicy.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | No | Whether to remove all settings when empty strings are passed in. Default value: off (remove) |
Acl | Array of DDoSAcl | No | DDoS port filtering parameters |
DDoS blocklist/allowlist
Used by actions: ModifyDDoSPolicy.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | No | Whether to remove all settings when empty strings are passed in. Default value: off (remove) |
UserAllowBlockIp | Array of DDoSUserAllowBlockIP | No | Array of objects in blocklist/allowlist configuration |
DDoS feature filtering
Used by actions: ModifyDDoSPolicy.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | No | Whether to remove all settings when empty strings are passed in. Default value: off (remove) |
PacketFilter | Array of DDoSFeaturesFilter | No | Array of objects in feature filtering configuration |
DDoS mitigation configuration
Used by actions: ModifyDDoSPolicy.
Name | Type | Required | Description |
---|---|---|---|
DdosStatusInfo | DDoSStatusInfo | No | DDoS mitigation level Note: This field may return null , indicating that no valid value can be obtained. |
DdosGeoIp | DDoSGeoIp | No | DDoS regional blocking Note: This field may return null , indicating that no valid value can be obtained. |
DdosAllowBlock | DdosAllowBlock | No | DDoS blocklist/allowlist Note: This field may return null , indicating that no valid value can be obtained. |
DdosAntiPly | DDoSAntiPly | No | Protocol blocking and null session protection Note: This field may return null , indicating that no valid value can be obtained. |
DdosPacketFilter | DdosPacketFilter | No | DDoS feature filtering Note: This field may return null , indicating that no valid value can be obtained. |
DdosAcl | DdosAcls | No | DDoS port filtering Note: This field may return null , indicating that no valid value can be obtained. |
Switch | String | No | DDoS mitigation switch. on : Enable; off : Disable.Note: This field may return null , indicating that no valid value can be obtained. |
UdpShardOpen | String | No | Whether to enable UDP fragmentation. on : Enable; off : Disable.Note: This field may return null, indicating that no valid values can be obtained. |
HTTPS server certificate configuration
Used by actions: DescribeDefaultCertificates.
Name | Type | Required | Description |
---|---|---|---|
CertId | String | Yes | Server certificate ID, which is the ID of the default certificate. If you choose to upload an external certificate for SSL certificate management, a certificate ID will be generated. Note: This field may return null , indicating that no valid value can be obtained. |
Alias | String | No | Certificate alias Note: This field may return null , indicating that no valid value can be obtained. |
Type | String | No | Certificate type. Valid values:default : Default certificateupload : External certificatemanaged : Tencent Cloud managed certificateNote: This field may return null , indicating that no valid value can be obtained. |
ExpireTime | Timestamp ISO8601 | No | Time when the certificate expires Note: This field may return null , indicating that no valid value can be obtained. |
EffectiveTime | Timestamp ISO8601 | No | Time when the certificate takes effect Note: This field may return null , indicating that no valid value can be obtained. |
CommonName | String | No | Certificate common name Note: This field may return null , indicating that no valid value can be obtained. |
SubjectAltName | Array of String | No | Domain names added to the SAN certificate Note: This field may return null , indicating that no valid value can be obtained. |
Status | String | No | Certificate status. Valid values:applying : Application in progressfailed : Application failedprocessing : Deploying certificatedeployed : Certificate deployeddisabled : Certificate disabledNote: This field may return null , indicating that no valid value can be obtained. |
Message | String | No | Returns a message to display failure causes when Status=failed Note: This field may return null , indicating that no valid value can be obtained. |
Domain name configuration information
Used by actions: DescribeHostsSetting.
Name | Type | Description |
---|---|---|
AppId | Integer | Tencent Cloud account ID |
ZoneId | String | Site ID |
Status | String | Acceleration service statusprocess : Deployingonline : Enabledoffline : Disabled |
Host | String | Domain name |
Ignore query string parameters for DNS data
Used by actions: DescribeDnsData.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Parameter name. Valid values:zone : Site namehost : Domain nametype : DNS resolution typecode : DNS response codearea : Region of the resolution server |
Value | String | No | Parameter value When Name=area , valid values:Asia Europe Africa Oceania Americas When Name=code , valid values:NoError : Successful response.NXDomain : Non-existent domain in the request. It is only valid when the response is from the authoritative name server.NotImp : Request type not supported.Refused : The name server refuses to perform the requested operation for policy reasons. |
Values | Array of String | No | Parameter value When Name=area , valid values:Asia Europe Africa Oceania Americas When Name=code , valid values:NoError : Successful response.NXDomain : Non-existent domain in the request. It is only valid when the response is from the authoritative name server.NotImp : Request type not supported.Refused : The name server refuses to perform the requested operation for policy reasons. |
DNS record
Used by actions: DescribeDnsRecords.
Name | Type | Description |
---|---|---|
Id | String | Record ID |
Type | String | Record type |
Name | String | Host record |
Content | String | Record value |
Mode | String | Proxy mode |
Ttl | Integer | TTL value |
Priority | Integer | Priority Note: This field may return null , indicating that no valid value can be obtained. |
CreatedOn | Timestamp ISO8601 | Creation time |
ModifiedOn | Timestamp ISO8601 | Modification time |
Locked | Boolean | Domain name lock |
ZoneId | String | Site ID |
ZoneName | String | Site name |
Status | String | Resolution statusactive : Activatedpending : Not activated |
Cname | String | CNAME address Note: This field may return null , indicating that no valid value can be obtained. |
DomainStatus | Array of String | Which service is enabled for the domain name. - lb : Load balancing- security : Security acceleration- l4 : L4 proxyNote: This field may return null, indicating that no valid values can be obtained. |
Query filter to search for DNS records
Used by actions: DescribeDnsRecords.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Filters by the field name. Vaules: - name : Site name.- status : Site status. |
Values | Array of String | Yes | Filters by the field value |
Fuzzy | Boolean | No | Specifies whether to enable fuzzy query. It’s only available when the filter name is name . If it’s enabled, the length of Values must be 1. |
DNSSEC information
Used by actions: DescribeDnssec, ModifyDnssec.
Name | Type | Description |
---|---|---|
Flags | Integer | Flag |
Algorithm | String | Encryption algorithm |
KeyType | String | Encryption type |
DigestType | String | Digest type |
DigestAlgorithm | String | Digest algorithm |
Digest | String | Digest message |
DS | String | DS record value |
KeyTag | Integer | Key tag |
PublicKey | String | Public key |
Failure reason
Used by actions: CreatePrefetchTask, CreatePurgeTask.
Name | Type | Description |
---|---|---|
Reason | String | Failure reason |
Targets | Array of String | List of resources failed to be processed. |
Filter
Used by actions: DescribeTimingL4Data, DescribeTimingL7AnalysisData, DescribeTimingL7CacheData, DescribeTopL7AnalysisData, DescribeTopL7CacheData.
Name | Type | Required | Description |
---|---|---|---|
Key | String | Yes | Filter dimension |
Operator | String | Yes | Operator |
Value | Array of String | Yes | Filter dimension value |
Force HTTPS redirect configuration
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Force redirect configuration switchon : Enableoff : Disable |
RedirectStatusCode | Integer | No | Redirection status code 301 302 Note: This field may return null , indicating that no valid value can be obtained. |
Region information
Used by actions: DescribeSecurityPolicyRegions.
Name | Type | Required | Description |
---|---|---|---|
RegionId | Integer | Yes | Region ID |
Country | String | No | Country name |
Continent | String | No | Continent name |
CountryEn | String | No | Country name in English |
ContinentEn | String | No | Continent name in English |
HTTP header, used as input for the CreatePrefetchTask API
Used by actions: CreatePrefetchTask.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | HTTP header name |
Value | String | Yes | HTTP header value |
Certificate configurations for domain names
Used by actions: DescribeHostsCertificate.
Name | Type | Description |
---|---|---|
Host | String | Domain name Note: This field may return null , indicating that no valid value can be obtained. |
CertInfo | Array of ServerCertInfo | Server certificate configuration Note: This field may return null , indicating that no valid value can be obtained. |
HSTS configuration
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Specifies whether to enable. Valid values: on and off . |
MaxAge | Integer | No | MaxAge value.Note: This field may return null , indicating that no valid value can be obtained. |
IncludeSubDomains | String | No | Specifies whether to include subdomain names. Valid values: on and off .Note: This field may return null , indicating that no valid value can be obtained. |
Preload | String | No | Specifies whether to preload. Valid values: on and off .Note: This field may return null , indicating that no valid value can be obtained. |
Domain name HTTPS acceleration configuration. This is disabled by default.
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Http2 | String | No | HTTP2 configuration switchon : Enableoff : DisableNote: This field may return null , indicating that no valid value can be obtained. |
OcspStapling | String | No | OCSP configuration switchon : Enableoff : DisableIt is disabled by default. Note: This field may return null , indicating that no valid value can be obtained. |
TlsVersion | Array of String | No | TLS version settings. Valid values: TLSv1 , TLSV1.1 , TLSV1.2 , and TLSv1.3 . Only consecutive versions can be enabled at the same time.Note: This field may return null , indicating that no valid value can be obtained. |
Hsts | Hsts | No | HSTS Configuration Note: This field may return null , indicating that no valid value can be obtained. |
Bot intelligence rules
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | No | Switch Note: This field may return null, indicating that no valid values can be obtained. |
Items | Array of IntelligenceRuleItem | No | Items in a bot intelligence rule Note: This field may return null, indicating that no valid values can be obtained. |
Bot intelligence rule items
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
Label | String | No | Malicious bot, which is used to tag bad bots Note: This field may return null, indicating that no valid values can be obtained. |
Action | String | No | Action Note: This field may return null, indicating that no valid values can be obtained. |
IP/Region blocklist/allowlist configuration
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | No | Switch Note: This field may return null, indicating that no valid values can be obtained. |
Rules | Array of IpTableRule | No | [] Note: This field may return null, indicating that no valid values can be obtained. |
IP blocklist/allowlist rule details
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
Action | String | No | Action: drop (block), trans (allow), monitor (observe)Note: This field may return null, indicating that no valid values can be obtained. |
MatchFrom | String | No | Matches by IP or region. Values: ip and area .Note: This field may return null, indicating that no valid values can be obtained. |
MatchContent | String | No | Matching content Note: This field may return null, indicating that no valid values can be obtained. |
RuleID | Integer | No | Rule ID Note: This field may return null, indicating that no valid values can be obtained. |
UpdateTime | Timestamp ISO8601 | No | Update time Note: This field may return null, indicating that no valid values can be obtained. |
Layer-7 offline log details
Used by actions: DownloadL7Logs.
Name | Type | Description |
---|---|---|
LogTime | Integer | Start time of the log packaging Note: This field may return null , indicating that no valid value can be obtained. |
Domain | String | Subdomain name Note: This field may return null , indicating that no valid value can be obtained. |
Size | Integer | Log size, in bytes Note: This field may return null , indicating that no valid value can be obtained. |
Url | String | Download address Note: This field may return null , indicating that no valid value can be obtained. |
LogPacketName | String | Log package name Note: This field may return null , indicating that no valid value can be obtained. |
CLB information
Used by actions: DescribeLoadBalancing.
Name | Type | Description |
---|---|---|
LoadBalancingId | String | CLB instance ID |
ZoneId | String | Site ID |
Host | String | Subdomain name. You can use @ to represent the root domain. |
Type | String | Proxy mode. Valid values:dns_only : Only DNSproxied : Enable proxy |
TTL | Integer | Indicates DNS TTL time when Type=dns_only |
OriginId | Array of String | ID of the origin group used |
Origin | Array of OriginGroup | Information of the origin server used |
UpdateTime | Timestamp ISO8601 | Update time |
Status | String | Status |
Cname | String | Schedules domain names Note: This field may return null , indicating that no valid value can be obtained. |
Managed rule
Used by actions: DescribeSecurityPolicyManagedRules, DescribeSecurityPolicyManagedRulesId.
Name | Type | Required | Description |
---|---|---|---|
RuleId | Integer | Yes | ID of the rule |
Description | String | Yes | Rule description |
RuleTypeName | String | Yes | Rule type |
RuleLevelDesc | String | Yes | Rule level |
UpdateTime | String | Yes | Update time |
Status | String | Yes | Rule status: block , allow |
RuleTags | Array of String | No | Tag of the rule Note: This field may return null , indicating that no valid value can be obtained. |
RuleTypeDesc | String | No | Description of the rule type Note: This field may return null , indicating that no valid value can be obtained. |
RuleTypeId | Integer | No | ID of the rule type Note: This field may return null , indicating that no valid value can be obtained. |
Browser cache rule configuration.
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
MaxAgeTime | Integer | No | Specifies the max age of the cache (in seconds). The maximum value is 365 days. Note: the value 0 means not to cache.Note: This field may return null , indicating that no valid value can be obtained. |
FollowOrigin | String | No | Specifies whether to follow the max cache age of the origin server. Valid values: on and off . If it's on, MaxAgeTime is ignored.Note: This field may return null , indicating that no valid value can be obtained. |
Configuration of offline cache
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Whether to enable offline cache. Valid values: on and off .Note: This field may return null , indicating that no valid value can be obtained. |
Origin server configuration
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
OriginPullProtocol | String | No | Origin-pull protocol.http : Switch HTTPS requests to HTTPfollow : Follow the protocol of the request.https : Switch HTTP requests to HTTPS. This only supports port 443 on the origin server.Note: This field may return null , indicating that no valid value can be obtained. |
Origin health status
Used by actions: DescribeLoadBalancingDetail, DescribeOriginGroup.
Name | Type | Description |
---|---|---|
Status | String | healthy : Healthy; unhealthy : Unhealthy; process : Checking origin. |
Host | Array of String | List of unhealthy origin groups when Status = unhealthy Note: This field may return null, indicating that no valid values can be obtained. |
The filter parameter to query origin groups
Used by actions: DescribeOriginGroup.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Field to be filtered. Supported field: name |
Value | String | Yes | Value of the field |
Origin group information
Used by actions: DescribeLoadBalancing, DescribeLoadBalancingDetail, DescribeOriginGroup.
Name | Type | Description |
---|---|---|
OriginId | String | Origin group ID |
OriginName | String | Origin group name |
Type | String | Origin-pull configuration typearea : Origin-pull by the client IP’s region specified by Area in OriginRecord .weight : Origin-pull by the weight specified by Weight in OriginRecord . |
Record | Array of OriginRecord | Record |
UpdateTime | Timestamp ISO8601 | Update time |
ZoneId | String | Site ID |
ZoneName | String | Site name |
OriginType | String | Origin server type Note: This field may return null , indicating that no valid value can be obtained. |
ApplicationProxyUsed | Boolean | Whether the origin group uses layer-4 proxy. Note: This field may return null, indicating that no valid values can be obtained. |
LoadBalancingUsed | Boolean | Whether the origin group is used for load balancing. Note: This field may return null, indicating that no valid values can be obtained. |
Status | OriginCheckOriginStatus | Origin status Note: This field may return null, indicating that no valid values can be obtained. |
LoadBalancingUsedType | String | Proxy mode of the load balancing task associated with the origin group.none : This origin group is not used for load balancing.dns_only : Used for DNS-only load balancing proxied : Used for proxied load balancingboth : It’s used for both DNS-only and proxied load balancing.Note: This field may return null, indicating that no valid values can be obtained. |
Origin group record
Used by actions: CreateOriginGroup, DescribeLoadBalancingDetail, DescribeOriginGroup, DescribeOriginGroupDetail, ModifyOriginGroup.
Name | Type | Required | Description |
---|---|---|---|
Record | String | Yes | Record value |
Area | Array of String | Yes | A specific region when Type=area .The default region when Type is not specified. |
Weight | Integer | Yes | A specific weight when Type=weight .The value range is [1-100]. The total weight of multiple origins in an origin group should be 100. |
Port | Integer | Yes | Port |
RecordId | String | No | Record ID |
Private | Boolean | No | Specifies whether to run private origin authentication. It is valid only when OriginType=third_part .Note: This field may return null , indicating that no valid value can be obtained. |
PrivateParameter | Array of OriginRecordPrivateParameter | No | Private origin parameter. It is valid only when Private=true .Note: This field may return null , indicating that no valid value can be obtained. |
Proto | String | No |
Private origin authentication parameter
Used by actions: CreateOriginGroup, DescribeLoadBalancingDetail, DescribeOriginGroup, DescribeOriginGroupDetail, ModifyOriginGroup.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Name of the private origin authentication parameter.AccessKeyId : Access key IDSecretAccessKey : Secret access key |
Value | String | Yes | Value of the private origin authentication parameter |
User profiling rule details
Used by actions: DescribeSecurityPortraitRules.
Name | Type | Required | Description |
---|---|---|---|
RuleId | Integer | No | Unique rule ID Note: This field may return null, indicating that no valid values can be obtained. |
Description | String | No | Rule description Note: This field may return null, indicating that no valid values can be obtained. |
RuleTypeName | String | No | Rule type name: botdb (user profile) Note: This field may return null, indicating that no valid values can be obtained. |
ClassificationId | Integer | No | Rule feature category ID (scanner, bot behavior, etc.) Note: This field may return null, indicating that no valid values can be obtained. |
Status | String | No | Current rule action status (block, alg, etc.) Note: This field may return null, indicating that no valid values can be obtained. |
Maximum size of the file uploaded for streaming via a POST request
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Specifies whether to enable custom setting of the maximum file size. off : Disable. In this case, the max size defaults to 32 MB.on : Enable. You can set a custom max size. |
MaxSize | Integer | No | Maximum size. Value range: 1-500 MB. Note: This field may return null , indicating that no valid value can be obtained. |
Query condition
Used by actions: DescribeBotLog, DescribeWebManagedRulesLog, DescribeWebProtectionLog.
Name | Type | Required | Description |
---|---|---|---|
Key | String | Yes | Dimension |
Operator | String | Yes | Operator |
Value | Array of String | Yes | Dimension value |
Request parameter contained in CacheKey
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Whether to use QueryString as part of CacheKey . Valid values: on and off .Note: This field may return null , indicating that no valid value can be obtained. |
Action | String | No | includeCustom : Include the specified query strings.excludeCustom : Exclude the specified query strings.Note: This field may return null , indicating that no valid value can be obtained. |
Value | Array of String | No | Array of query strings used/excluded Note: This field may return null , indicating that no valid value can be obtained. |
QUIC configuration item
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Whether to enable QUIC |
Rate limit configuration
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Switch |
UserRules | Array of RateLimitUserRule | Yes | Rate limit rule |
Template | RateLimitTemplate | No | Default template Note: This field may return null , indicating that no valid value can be obtained. |
Intelligence | RateLimitIntelligence | No | Client filtering Note: This field may return null, indicating that no valid values can be obtained. |
Client filtering
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | No | Whether to enable this feature Note: This field may return null, indicating that no valid values can be obtained. |
Action | String | No | Action. Values: monitor (observe), alg (JS/Managed challenge)Note: This field may return null, indicating that no valid values can be obtained. |
Rate limit template
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
Mode | String | No | Template name Note: This field may return null , indicating that no valid value can be obtained. |
Detail | RateLimitTemplateDetail | No | Template details Note: This field may return null , indicating that no valid value can be obtained. |
Rate limit template configuration
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
Mode | String | No | Template name Note: This field may return null , indicating that no valid value can be obtained. |
ID | Integer | No | Unique ID Note: This field may return null , indicating that no valid value can be obtained. |
Action | String | No | Action Note: This field may return null , indicating that no valid value can be obtained. |
PunishTime | Integer | No | Time it takes to perform the action Note: This field may return null , indicating that no valid value can be obtained. |
Threshold | Integer | No | Request rate threshold Note: This field may return null , indicating that no valid value can be obtained. |
Period | Integer | No | Statistical period Note: This field may return null , indicating that no valid value can be obtained. |
Rate limit rule
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
Threshold | Integer | Yes | Rate threshold |
Period | Integer | Yes | Data collection time |
RuleName | String | Yes | Name of the rule |
Action | String | Yes | Action: monitor (Observe), drop (Block) |
PunishTime | Integer | Yes | Time it takes to perform the action |
PunishTimeUnit | String | Yes | Time unit: second |
RuleStatus | String | Yes | Status of the rule |
Conditions | Array of ACLCondition | Yes | Rule |
RulePriority | Integer | Yes | Priority of the rule |
RuleID | Integer | No | ID of the rule Note: This field may return null , indicating that no valid value can be obtained. |
FreqFields | Array of String | No | Word filter Note: This field may return null , indicating that no valid value can be obtained. |
UpdateTime | String | No | Update time Note: This field may return null , indicating that no valid value can be obtained. |
Billable resource
Used by actions: DescribeZoneDetails, DescribeZones.
Name | Type | Description |
---|---|---|
Id | String | Resource ID |
PayMode | Integer | Billing mode0 : Pay-as-you-go |
CreateTime | Timestamp ISO8601 | Creation time |
EnableTime | Timestamp ISO8601 | Effective time |
ExpireTime | Timestamp ISO8601 | Expiration time |
Status | String | Status of the plan |
Sv | Array of Sv | Pricing query parameter |
AutoRenewFlag | Integer | Specifies whether to enable auto-renewal0 : Default1 : Enable auto-renewal2 : Disable auto-renewal |
PlanId | String | ID of the plan |
Area | String |
Returned value of security data entry
Used by actions: DescribeDDosAttackData, DescribeWebManagedRulesData, DescribeWebProtectionData.
Name | Type | Description |
---|---|---|
Key | String | Entry key Note: This field may return null, indicating that no valid values can be obtained. |
Value | Array of SecEntryValue | Entry value Note: This field may return null, indicating that no valid values can be obtained. |
Corresponding value of security data entry
Used by actions: DescribeDDosAttackData, DescribeWebManagedRulesData, DescribeWebProtectionData.
Name | Type | Description |
---|---|---|
Metric | String | Metric name Note: This field may return null, indicating that no valid values can be obtained. |
Detail | Array of TimingDataItem | Metric data details Note: This field may return null, indicating that no valid values can be obtained. |
Max | Integer | Maximum Note: This field may return null, indicating that no valid values can be obtained. |
Avg | Float | Average Note: This field may return null, indicating that no valid values can be obtained. |
Sum | Float | Sum Note: This field may return null, indicating that no valid values can be obtained. |
Security configuration
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
WafConfig | WafConfig | No | WAF configuration Note: This field may return null , indicating that no valid value can be obtained. |
RateLimitConfig | RateLimitConfig | No | Rate limit configuration Note: This field may return null , indicating that no valid value can be obtained. |
DdosConfig | DDoSConfig | No | DDoS mitigation configuration Note: This field may return null , indicating that no valid value can be obtained. |
AclConfig | AclConfig | No | ACL configuration Note: This field may return null , indicating that no valid value can be obtained. |
BotConfig | BotConfig | No | Bot configuration Note: This field may return null , indicating that no valid value can be obtained. |
SwitchConfig | SwitchConfig | No | Switch that controls all web security configuration Note: This field may return null , indicating that no valid value can be obtained. |
IpTableConfig | IpTableConfig | No | IP blocklist/allowlist Note: This field may return null, indicating that no valid values can be obtained. |
Protected resource
Used by actions: DescribeSecurityPolicyList.
Name | Type | Required | Description |
---|---|---|---|
AppId | Integer | Yes | User APPID |
ZoneId | String | Yes | Top-level domain name |
Entity | String | Yes | Second-level domain name |
EntityType | String | Yes | Type of protected resource. Values: domain and application . |
HTTPS server certificate configuration
Used by actions: DescribeHostsCertificate, ModifyHostsCertificate.
Name | Type | Required | Description |
---|---|---|---|
CertId | String | Yes | Server certificate ID, which is the ID of the default certificate. If you choose to upload an external certificate for SSL certificate management, a certificate ID will be generated. Note: This field may return null , indicating that no valid value can be obtained. |
Alias | String | No | Alias of the certificate Note: This field may return null , indicating that no valid value can be obtained. |
Type | String | No | Certificate type.default : Default certificateupload : External certificatemanaged : Tencent Cloud managed certificateNote: This field may return null , indicating that no valid value can be obtained. |
ExpireTime | Timestamp ISO8601 | No | Time when the certificate expires Note: This field may return null , indicating that no valid value can be obtained. |
DeployTime | Timestamp ISO8601 | No | Certificate deployment time Note: This field may return null , indicating that no valid value can be obtained. |
Status | String | No | Certificate deployment status.processing : Deployingdeployed : DeployedNote: This field may return null , indicating that no valid value can be obtained. |
DDoS mitigation configuration
Used by actions: DescribeZoneDDoSPolicy.
Name | Type | Required | Description |
---|---|---|---|
ZoneId | String | Yes | ID of the site (top-level domain name) |
PolicyId | Integer | Yes | Policy ID |
Type | String | Yes | Type of protected resource. Values: domain and application . |
EntityName | String | No | Layer-4 proxy name Note: This field may return null , indicating that no valid value can be obtained. |
Application | Array of DDoSApplication | No | Layer-7 domain name parameters Note: This field may return null , indicating that no valid value can be obtained. |
TcpNum | Integer | No | Number of layer-4 TCP forwarding rules Note: This field may return null , indicating that no valid value can be obtained. |
UdpNum | Integer | No | Number of layer-4 UDP forwarding rules Note: This field may return null , indicating that no valid value can be obtained. |
Entity | String | No | Name of the protected resource Note: This field may return null , indicating that no valid value can be obtained. |
Share | Boolean | No | Whether the shared resource is used. Values: true (yes) and false (no). The proxy mode cannot be switched when the shared resource is used.Note: This field may return null , indicating that no valid value can be obtained. |
Smart acceleration configuration
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Whether to enable smart accelerationon : Enableoff : Disable |
Pricing query parameter
Used by actions: DescribeZoneDetails.
Name | Type | Description |
---|---|---|
Key | String | Parameter key |
Value | String | Parameter value |
Web security configuration switch
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
WebSwitch | String | Yes | Switch that controls all web security configuration: basic web protection, custom rules, and rate limiting |
Tag configuration
Used by actions: CreateZone, DescribeZoneDetails, DescribeZones.
Name | Type | Required | Description |
---|---|---|---|
TagKey | String | Yes | Tag key Note: This field may return null, indicating that no valid values can be obtained. |
TagValue | String | Yes | Tag value Note: This field may return null, indicating that no valid values can be obtained. |
Content management task result
Used by actions: DescribePrefetchTasks, DescribePurgeTasks.
Name | Type | Description |
---|---|---|
JobId | String | Task ID |
Status | String | Status of the task |
Target | String | Resource |
Type | String | Task type |
CreateTime | Timestamp ISO8601 | Task creation time |
UpdateTime | Timestamp ISO8601 | Task completion time |
Data items of the statistical curve
Used by actions: DescribeDDosAttackData, DescribeOverviewL7Data, DescribeTimingL4Data, DescribeTimingL7AnalysisData, DescribeTimingL7CacheData, DescribeWebManagedRulesData, DescribeWebProtectionData.
Name | Type | Description |
---|---|---|
Timestamp | Integer | Second-level timestamp Note: This field may return null, indicating that no valid values can be obtained. |
Value | Integer | Value Note: This field may return null, indicating that no valid values can be obtained. |
Time series data of L7 data analysis
Used by actions: DescribeOverviewL7Data, DescribeTimingL4Data, DescribeTimingL7AnalysisData, DescribeTimingL7CacheData.
Name | Type | Description |
---|---|---|
TypeKey | String | Query dimension value |
TypeValue | Array of TimingTypeValue | Detailed time series data Note: This field may return null, indicating that no valid values can be obtained. |
Detailed data of time series type
Used by actions: DescribeOverviewL7Data, DescribeTimingL4Data, DescribeTimingL7AnalysisData, DescribeTimingL7CacheData.
Name | Type | Description |
---|---|---|
Sum | Integer | Sum Note: This field may return null, indicating that no valid values can be obtained. |
Max | Integer | Maximum Note: This field may return null, indicating that no valid values can be obtained. |
Avg | Integer | Average Note: This field may return null, indicating that no valid values can be obtained. |
MetricName | String | Metric name |
DetailData | Array of Integer | This field will be disused soon. Use the Detail field instead.Note: This field may return null, indicating that no valid values can be obtained. |
Detail | Array of TimingDataItem | Detailed data Note: This field may return null, indicating that no valid values can be obtained. |
Top data of layer-7 data analysis
Used by actions: DescribeTopL7AnalysisData, DescribeTopL7CacheData.
Name | Type | Description |
---|---|---|
TypeKey | String | Query dimension value |
DetailData | Array of TopDetailData | Top data rankings Note: This field may return null, indicating that no valid values can be obtained. |
The structure used to sort the top data
Used by actions: DescribeTopL7AnalysisData, DescribeTopL7CacheData.
Name | Type | Description |
---|---|---|
Key | String | Field name |
Value | Integer | Field value |
TopN entry
Used by actions: DescribeDDosAttackTopData, DescribeWebManagedRulesTopData.
Name | Type | Description |
---|---|---|
Key | String | Entry key |
Value | Array of TopNEntryValue | Top N data |
Top N data entry
Used by actions: DescribeDDosAttackTopData, DescribeWebManagedRulesTopData.
Name | Type | Description |
---|---|---|
Name | String | Entry name |
Count | Integer | Quantity |
HTTP2 origin-pull configuration
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Whether to enable HTTP2 origin-pullon : Enableoff : Disable |
Custom name servers
Used by actions: DescribeZoneDetails, ModifyZone.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Whether to enable the custom name serveron : Enableoff : Disable |
Servers | Array of String | No | List of custom name servers |
IP of the custom name server
Used by actions: DescribeZoneDetails.
Name | Type | Description |
---|---|---|
Name | String | Name of the custom name server |
IPv4 | String | IPv4 address of the custom name server |
WAF configuration
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Switch |
Level | String | Yes | Protection level: loose , normal , strict , stricter , custom |
Mode | String | Yes | Mode: block , observe , close |
WafRules | WafRule | Yes | WAF rule allowlist/blocklist |
AiRule | AiRule | No | AI rule engine Note: This field may return null , indicating that no valid value can be obtained. |
WAF rule
Used by actions: DescribeSecurityPolicy, ModifySecurityPolicy.
Name | Type | Required | Description |
---|---|---|---|
BlockRuleIDs | Array of Integer | Yes | Blocklist |
Switch | String | Yes | Whether the WAF rule is enabled or disabled |
ObserveRuleIDs | Array of Integer | No | Observe mode Note: This field may return null , indicating that no valid value can be obtained. |
Web block event
Used by actions: DescribeWebManagedRulesAttackEvents.
Name | Type | Description |
---|---|---|
ClientIp | String | Client IP Note: This field may return null, indicating that no valid values can be obtained. |
AttackUrl | String | Attack URL Note: This field may return null, indicating that no valid values can be obtained. |
AttackTime | Integer | Attack time in seconds Note: This field may return null, indicating that no valid values can be obtained. |
Web event data
Used by actions: DescribeWebManagedRulesAttackEvents.
Name | Type | Description |
---|---|---|
List | Array of WebAttackEvent | Data set of attack events Note: This field may return null, indicating that no valid values can be obtained. |
PageNo | Integer | Current page Note: This field may return null, indicating that no valid values can be obtained. |
PageSize | Integer | Number of items per page Note: This field may return null, indicating that no valid values can be obtained. |
Pages | Integer | Total number of pages Note: This field may return null, indicating that no valid values can be obtained. |
TotalSize | Integer | Total number of items Note: This field may return null, indicating that no valid values can be obtained. |
Web attack log data
Used by actions: DescribeWebManagedRulesLog.
Name | Type | Description |
---|---|---|
List | Array of WebLogs | Data Note: This field may return null, indicating that no valid values can be obtained. |
PageNo | Integer | Current page Note: This field may return null, indicating that no valid values can be obtained. |
PageSize | Integer | Number of items per page Note: This field may return null, indicating that no valid values can be obtained. |
Pages | Integer | Total number of pages Note: This field may return null, indicating that no valid values can be obtained. |
TotalSize | Integer | Total number of items Note: This field may return null, indicating that no valid values can be obtained. |
Web attack log
Used by actions: DescribeWebManagedRulesLog.
Name | Type | Description |
---|---|---|
AttackContent | String | Attack content Note: This field may return null, indicating that no valid values can be obtained. |
AttackIp | String | Attack IP Note: This field may return null, indicating that no valid values can be obtained. |
AttackType | String | Attack type Note: This field may return null, indicating that no valid values can be obtained. |
Domain | String | Domain name Note: This field may return null, indicating that no valid values can be obtained. |
Msuuid | String | uuid Note: This field may return null, indicating that no valid values can be obtained. |
RequestMethod | String | Request method Note: This field may return null, indicating that no valid values can be obtained. |
RequestUri | String | Request URI Note: This field may return null, indicating that no valid values can be obtained. |
RiskLevel | String | Risk grade Note: This field may return null, indicating that no valid values can be obtained. |
RuleId | Integer | Rule ID Note: This field may return null, indicating that no valid values can be obtained. |
SipCountryCode | String | IP country/region Note: This field may return null, indicating that no valid values can be obtained. |
EventId | String | Event ID Note: This field may return null, indicating that no valid values can be obtained. |
DisposalMethod | String | Processing method Note: This field may return null, indicating that no valid values can be obtained. |
HttpLog | String | http_log Note: This field may return null, indicating that no valid values can be obtained. |
Ua | String | user agent Note: This field may return null, indicating that no valid values can be obtained. |
AttackTime | Integer | Attack time. For consistency considerations, the original parameter time was renamed AttackTime .Note: This field may return null, indicating that no valid values can be obtained. |
WebSocket configuration.
Used by actions: DescribeZoneSetting, ModifyZoneSetting.
Name | Type | Required | Description |
---|---|---|---|
Switch | String | Yes | Whether to enable custom WebSocket timeout setting. When it’s off : it means to keep the default WebSocket connection timeout period, which is 15 seconds. To change the timeout period, please set it to on . |
Timeout | Integer | No | Sets timeout period in seconds. Maximum value: 120 |
Site information
Used by actions: DescribeZones.
Name | Type | Description |
---|---|---|
Id | String | Site ID |
Name | String | Site name |
OriginalNameServers | Array of String | List of name servers used by the site |
NameServers | Array of String | List of name servers assigned by Tencent Cloud |
Status | String | Site status - active : The name server is switched.- pending : The name server is not switched.- moved : The name server is moved.- deactivated : The name server is blocked. |
Type | String | How the site is connected to EdgeOne. - full : The site is connected via name server.- partial : The site is connected via CNAME. |
Paused | Boolean | Indicates whether the site is disabled |
CnameSpeedUp | String | Specifies whether to enable CNAME acceleration - enabled : Enable- disabled : DisableNote: This field may return null, indicating that no valid values can be obtained. |
CnameStatus | String | Ownership verification status of the site when it is connected to EdgeOne via CNAME. - finished : The site is verified.- pending : Verifying the ownership of the site.Note: This field may return null , indicating that no valid value can be obtained. |
Tags | Array of Tag | Resource tag Note: This field may return null , indicating that no valid value can be obtained. |
Resources | Array of Resource | Billable resource Note: This field may return null , indicating that no valid value can be obtained. |
CreatedOn | Timestamp ISO8601 | Site creation date |
ModifiedOn | Timestamp ISO8601 | Site modification date |
Area | String |
Site query filter
Used by actions: DescribeZones.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Filters by the field name. Vaules: - name : Site name.- status : Site status.- tagKey : Tag key.- tagValue : Tag value. |
Values | Array of String | Yes | Filters by the field value |
Fuzzy | Boolean | No | Specifies whether to enable fuzzy query. It’s only available when filter name is name . If it’s enabled, the length of Values must be 1. |
Was this page helpful?