Data Types

Last updated: 2020-08-07 10:45:25

BaradData

Data returned by Barad

Used by actions: DescribeBaradData.

Name Type Description
MetricName String Metric name (connum: number of active TCP connections;
new_conn: number of new TCP connections;
inactive_conn: number of inactive connections;
intraffic: inbound traffic;
outtraffic: outbound traffic;
alltraffic: sum of inbound and outbound traffic;
inpkg: inbound packet rate;
outpkg: outbound packet rate;)
Data Array of Float Value array
Count Integer Value array size

BoundIpInfo

IP object bound to Anti-DDoS Pro

Used by actions: CreateBoundIP.

Name Type Required Description
Ip String Yes IP
BizType String No Bound product type. Valid values: [public (CVM), bm (BM), eni (ENI), vpngw (VPN Gateway), natgw (NAT Gateway), waf (WAF), fpc (finance product), gaap (GAAP), other (hosted IP)]
DeviceType String No Subtype under product type. Valid values: [cvm (CVM), lb (CLB), eni (ENI), vpngw (VPN), natgw (NAT), waf (WAF), fpc (finance), gaap (GAAP), other (hosted IP), eip (BM EIP)]
InstanceId String No Resource instance ID of IP. This field is required when binding a new IP. For example, if it is an ENI IP, enter ID(eni-*) of the ENI for InstanceId; if it is a hosted IP without corresponding resource instance ID, enter "none";

CCAlarmThreshold

CC alarm threshold

Used by actions: DescribeCCAlarmThreshold.

Name Type Description
AlarmThreshold Integer CC alarm threshold

CCEventRecord

CC attack event record

Used by actions: DescribeCCEvList.

Name Type Description
Business String Anti-DDoS service type. bgpip: Anti-DDoS Advanced; bgp: Anti-DDoS Pro (Single IP); bgp-multip: Anti-DDoS Pro (Multi-IP); net: Anti-DDoS Ultimate; basic: Anti-DDoS Basic
Id String Anti-DDoS instance ID
Vip String Resource IP
StartTime Timestamp Attack start time
EndTime Timestamp Attack end time
ReqQps Integer Total requests peak (QPS)
DropQps Integer Attack peak (QPS)
AttackStatus Integer Attack status. Valid values: [0 (ongoing), 1 (ended)]
ResourceName String Resource name
Note: this field may return null, indicating that no valid values can be obtained.
DomainList String Domain name list
Note: this field may return null, indicating that no valid values can be obtained.
UriList String URI list
Note: this field may return null, indicating that no valid values can be obtained.
AttackipList String Attack source list
Note: this field may return null, indicating that no valid values can be obtained.

CCFrequencyRule

Access frequency control rule for CC protection

Used by actions: DescribeCCFrequencyRules.

Name Type Description
CCFrequencyRuleId String ID of the access frequency control rule for CC protection
Uri String URI string, which must start with /, such as /abc/a.php. Length limit: 31. If URI is /, only prefix match can be selected as the matching mode;
UserAgent String User-Agent string. Length limit: 80
Cookie String Cookie string. Length limit: 40
Mode String Matching rule. Valid values: ["include" (prefix match), "equal" (exact match)]
Period Integer Reference period in seconds. Valid values: [10, 30, 60]
ReqNumber Integer Number of access requests. Value range: [1-10000]
Act String Action take. Valid values: ["alg" (CAPTCHA), "drop" (blocking)]
ExeDuration Integer Execution duration in seconds. Valid range: [1-900]

CCPolicy

Custom CC protection rule

Used by actions: CreateCCSelfDefinePolicy, DescribeCCSelfDefinePolicy, ModifyCCSelfDefinePolicy.

Name Type Required Description
Name String Yes Policy name
Smode String Yes Matching mode. Valid values: [matching (matching mode), speedlimit (speed limiting mode)]
SetId String No Policy ID
Frequency Integer No Number of requests allowed per minute
ExeMode String No Executed policy mode. Valid values: [alg (verification code), drop (blocking)]
Switch Integer No Specifies whether the policy is activated
CreateTime String No Creation time
RuleList Array of CCRule No Rule list
IpList Array of String No IP list. If this field is to be left empty, please pass in an empty instead of null;
Protocol String No CC protection type. Valid values: [http, https]
RuleId String No ID of the forwarding rule corresponding to the HTTPS CC protection domain name
Domain String No HTTPS CC protection domain name

CCRule

The custom CC protection policy in key-value format

Used by actions: CreateCCSelfDefinePolicy, DescribeCCSelfDefinePolicy, ModifyCCSelfDefinePolicy.

Name Type Required Description
Skey String Yes Key of the policy. Valid values: host, cgi, ua, referer
Operator String Yes Rule condition. Valid values: include, not_include, equal
Value String Yes Value of the policy. Length limit: 31 bytes

CCRuleConfig

Custom layer-7 CC policy

Used by actions: CreateL7CCRule.

Name Type Required Description
Period Integer Yes Reference period in seconds. Valid values: [10, 30, 60]
ReqNumber Integer Yes Number of access requests. Value range: [1-10000]
Action String Yes Action take. Valid values: ["alg" (CAPTCHA), "drop" (blocking)]
ExeDuration Integer Yes Execution duration in seconds. Valid range: [1-900]

DDoSAlarmThreshold

DDoS alarm threshold

Used by actions: DescribeDDoSAlarmThreshold.

Name Type Description
AlarmType Integer Alarm threshold type. 1: inbound traffic, 2: cleansed traffic
AlarmThreshold Integer Alarm threshold, which should be greater than 0 (currently scheduled value)

DDoSAttackSourceRecord

Attack source information

Used by actions: DescribeDDoSAttackSource.

Name Type Description
SrcIp String Attack source IP
Province String Province (valid for Mainland China)
Nation String Country/region
PacketSum Integer Total number of attack packets
PacketLen Integer Total attack traffic

DDoSEventRecord

DDoS attack event record

Used by actions: DescribeDDoSEvList, DescribeDDoSNetEvList.

Name Type Description
Business String Anti-DDoS service type. bgpip: Anti-DDoS Advanced; bgp: Anti-DDoS Pro (Single IP); bgp-multip: Anti-DDoS Pro (Multi-IP); net: Anti-DDoS Ultimate; basic: Anti-DDoS Basic
Id String Anti-DDoS instance ID
Vip String Resource IP
StartTime Timestamp Attack start time
EndTime Timestamp Attack end time
Mbps Integer Maximum attack bandwidth
Pps Integer Maximum attack packet rate
AttackType String Attack type
BlockFlag Integer Whether the IP is blocked. Valid values: [1 (yes), 0 (no), 2 (invalid value)]
OverLoad String Whether the elastic protection bandwidth is exceeded. Valid values: [yes (yes), no (no), empty string (unknown value)]
AttackStatus Integer Attack status. Valid values: [0 (ongoing), 1 (ended)]
ResourceName String Resource name
Note: this field may return null, indicating that no valid values can be obtained.
EventId String Attack event ID
Note: this field may return null, indicating that no valid values can be obtained.

DDoSPolicyDropOption

Disabled protocol in advanced DDoS policy

Used by actions: CreateDDoSPolicy, DescribeDDoSPolicy, ModifyDDoSPolicy.

Name Type Required Description
DropTcp Integer Yes Blocks all TCP traffic. Valid values: [0,1]
DropUdp Integer Yes Blocks all UDP traffic. Valid values: [0,1]
DropIcmp Integer Yes Blocks all ICMP traffic. Valid values: [0,1]
DropOther Integer Yes Blocks traffic of other protocols. Valid values: [0,1]
DropAbroad Integer Yes Rejects traffic from outside Mainland China. Valid values: [0,1]
CheckSyncConn Integer Yes Null session protection. Valid values: [0,1]
SdNewLimit Integer No New connection suppression based on source IP and destination IP. Value range: [0,4294967295]
DstNewLimit Integer No New connection suppression based on destination IP. Value range: [0,4294967295]
SdConnLimit Integer No Concurrent connection suppression based on source IP and destination IP. Value range: [0,4294967295]
DstConnLimit Integer No Concurrent connection suppression based on destination IP. Value range: [0,4294967295]
BadConnThreshold Integer No Threshold for triggering connection suppression. Value range: [0,4294967295]
NullConnEnable Integer No Exceptional connection detection condition: null session protection status. Valid values: [0,1]
ConnTimeout Integer No Exceptional connection detection condition: connection timeout. Valid values: [0,65535]
SynRate Integer No Exceptional connection detection condition: percentage of SYN out of ACK. Valid values: [0,100]
SynLimit Integer No Exceptional connection detection condition: SYN threshold. Valid values: [0,100]
DTcpMbpsLimit Integer No TCP speed limit. Value range: [0,4294967295]
DUdpMbpsLimit Integer No UDP speed limit. Value range: [0,4294967295]
DIcmpMbpsLimit Integer No ICMP speed limit. Value range: [0,4294967295]
DOtherMbpsLimit Integer No Other protocol speed limit. Value range: [0,4294967295]

DDoSPolicyPacketFilter

Packet filter in advanced DDoS policy

Used by actions: CreateDDoSPolicy, DescribeDDoSPolicy, ModifyDDoSPolicy.

Name Type Required Description
Protocol String Yes Protocol. Valid values: [tcp, udp, icmp, all]
SportStart Integer Yes Start source port. Value range: [0,65535]
SportEnd Integer Yes End source port. Value range: [0,65535]
DportStart Integer Yes Start destination port. Value range: [0,65535]
DportEnd Integer Yes End destination port. Value range: [0,65535]
PktlenMin Integer Yes Minimum packet length. Value range: [0,1500]
PktlenMax Integer Yes Maximum packet length. Value range: [0,1500]
MatchBegin String Yes Whether to detect the payload. Valid values: [
begin_l3 (IP header)
begin_l4 (TCP header)
begin_l5 (payload)
no_match (no check)
]
MatchType String Yes Whether it is a regular expression. Valid values: [sunday (keyword), pcre (regular expression)]
Str String Yes Keyword or regular expression
Depth Integer Yes Detection depth. Value range: [0,1500]
Offset Integer Yes Detection offset. Value range: [0,1500]
IsNot Integer Yes Whether to include. Valid values: [0 (no), 1 (yes)]
Action String Yes Policy action. Valid values: [drop, drop_black, drop_rst, drop_black_rst, transmit]

DDoSPolicyPortLimit

Disabled port in advanced DDoS policy

Used by actions: CreateDDoSPolicy, DescribeDDoSPolicy, ModifyDDoSPolicy.

Name Type Required Description
Protocol String Yes Protocol. Valid values: [tcp, udp, all]
DPortStart Integer Yes Start destination port. Value range: [0,65535]
DPortEnd Integer Yes End destination port, which must be greater than or equal to the start destination port. Value range: [0,65535]
SPortStart Integer No Start source port. Value range: [0,65535]
Note: this field may return null, indicating that no valid values can be obtained.
SPortEnd Integer No End source port, which must be greater than or equal to the start source port. Value range: [0,65535]
Note: this field may return null, indicating that no valid values can be obtained.
Action String No Action to be executed. Valid values: [drop (discard) , transmit (forward)]
Note: this field may return null, indicating that no valid values can be obtained.
Kind Integer No Type of port to be disabled. Valid values: [0 (destination port range), 1 (source port range), 2 (destination port range and source port range)]
Note: this field may return null, indicating that no valid values can be obtained.

DDosPolicy

Advanced DDoS policy

Used by actions: DescribeDDoSPolicy.

Name Type Description
Resources Array of ResourceIp Resource bound to policy
DropOptions DDoSPolicyDropOption Disabled protocol
PortLimits Array of DDoSPolicyPortLimit Disabled port
PacketFilters Array of DDoSPolicyPacketFilter Packet filter
IpBlackWhiteLists Array of IpBlackWhite IP blocklist/allowlist
PolicyId String Policy ID
PolicyName String Policy name
CreateTime String Policy creation time
WaterPrint Array of WaterPrintPolicy Watermarking policy parameter. There can be only one policy. If there are no policies, the array is empty
WaterKey Array of WaterPrintKey Watermark key. There can be up to two keys. If there are no policies, the array is empty
BoundResources Array of String Resource instance bound to policy
Note: this field may return null, indicating that no valid values can be obtained.
SceneId String Policy scenario
Note: this field may return null, indicating that no valid values can be obtained.

IpBlackWhite

IP blocklist/allowlist

Used by actions: CreateDDoSPolicy, DescribeDDoSPolicy, ModifyDDoSPolicy.

Name Type Required Description
Ip String Yes IP address
Type String Yes Blocklist/allowlist type. Valid values: [black, white]

IpBlockData

IP blocking record

Used by actions: DescribeIpBlockList.

Name Type Description
Ip String IP
Status String Status (Blocked: blocked, UnBlocking: unblocking, UnBlockFailed: unblocking failed)
BlockTime Timestamp Blocked time
UnBlockTime Timestamp Unblocked time (estimated)
ActionType String Type of the unblocking action (user: self-service unblocking, auto: automatic unblocking, update: unblocking by service upgrading, bind: unblocking by binding Anti-DDoS Pro instance)

IpUnBlockData

IP unblocking record

Used by actions: DescribeIpUnBlockList.

Name Type Description
Ip String IP
BlockTime Timestamp Blocked time
UnBlockTime Timestamp Unblocked time (actual)
ActionType String Type of the unblocking action (user: self-service unblocking, auto: automatic unblocking, update: unblocking by service upgrading, bind: unblocking by binding Anti-DDoS Pro instance)

KeyValue

Field value in K-V format

Used by actions: DescribeActionLog, DescribeCCIpAllowDeny, DescribeCCUrlAllow, DescribeDDoSAttackIPRegionMap, DescribeDDoSCount, DescribeDDoSIpLog, DescribeDDoSNetCount, DescribeDDoSNetIpLog, DescribeDDoSUsedStatis, DescribeIPProductInfo, DescribeInsurePacks, DescribeL4RulesErrHealth, DescribePackIndex, DescribePolicyCase, DescribeResourceList, DescribeRuleSets, DescribeSecIndex.

Name Type Description
Key String Field name
Value String Field value

KeyValueRecord

KeyValue record

Used by actions: DescribeActionLog, DescribeCCIpAllowDeny, DescribeCCUrlAllow, DescribeDDoSAttackIPRegionMap, DescribeDDoSIpLog, DescribeDDoSNetIpLog, DescribeIPProductInfo, DescribeInsurePacks, DescribeL4RulesErrHealth, DescribePolicyCase, DescribeResourceList, DescribeRuleSets.

Name Type Description
Record Array of KeyValue Key-Value array of a record

L4HealthConfig

Layer-4 health check configuration

Used by actions: CreateL4HealthConfig, DescribeL4HealthConfig.

Name Type Required Description
Protocol String Yes Forwarding protocol. Valid values: [TCP, UDP]
VirtualPort Integer Yes Forwarding port
Enable Integer Yes 1: enabled, 0: disabled
TimeOut Integer Yes Response timeout period in seconds
Interval Integer Yes Detection interval in seconds
KickNum Integer Yes Unhealthy threshold in times.
AliveNum Integer Yes Healthy threshold in times.
KeepTime Integer Yes Session persistence duration in seconds

L4RuleEntry

Layer-4 rule

Used by actions: CreateL4Rules, DescribleL4Rules, ModifyL4Rules, ModifyNewL4Rule.

Name Type Required Description
Protocol String Yes Forwarding protocol. Valid values: [TCP, UDP]
VirtualPort Integer Yes Forwarding port
SourcePort Integer Yes Real server port
SourceType Integer Yes Forwarding method. Valid values: [1 (forwarding via domain name), 2 (forwarding via IP)]
KeepTime Integer Yes Session persistence duration in seconds
SourceList Array of L4RuleSource Yes Forward list
LbType Integer Yes Load balancing method. Valid values: [1 (weighted round robin), 2 (source IP hash)]
KeepEnable Integer Yes Session persistence status. Valid values: [0 (disabled), 1 (enabled)];
RuleId String No Rule ID
RuleName String No Rule description
RemoveSwitch Integer No Watermark removal status. Valid values: [0 (disabled), 1 (enabled)]

L4RuleHealth

Rule health check parameter

Used by actions: DescribleL4Rules, ModifyL4Health.

Name Type Required Description
RuleId String Yes Rule ID
Enable Integer Yes 1: enabled, 0: disabled
TimeOut Integer Yes Response timeout period in seconds
Interval Integer Yes Detection interval in seconds, which must be greater than the response timeout period
KickNum Integer Yes Unhealthy threshold in times
AliveNum Integer Yes Healthy threshold in times.

L4RuleSource

Layer-4 forwarding rule list

Used by actions: CreateL4Rules, CreateL7Rules, CreateL7RulesUpload, CreateNewL7RulesUpload, DescribleL4Rules, DescribleL7Rules, ModifyL4Rules, ModifyL7Rules, ModifyNewDomainRules, ModifyNewL4Rule.

Name Type Required Description
Source String Yes Intermediate IP or domain name
Weight Integer Yes Weight value. Value range: [0,100]

L7HealthConfig

Layer-7 health check configuration

Used by actions: CreateL7HealthConfig, DescribeL7HealthConfig.

Name Type Required Description
Protocol String Yes Forwarding protocol. Valid values: [http, https, http/https]
Domain String Yes Forwarding domain name
Enable Integer Yes 1: enabled, 0: disabled
Interval Integer Yes Detection interval in seconds
KickNum Integer Yes Number of exceptions in times
AliveNum Integer Yes Number of health checks in times
Method String Yes Health check detection method. Valid values: HEAD, GET. Default VALUE: HEAD
StatusCode Integer Yes Healthy status code during health check. xx = 1, 2xx = 2, 3xx = 4, 4xx = 8, 5xx = 16. Multiple status code values are added up
Url String Yes URL of checked directory. Default value: /

L7RuleEntry

Layer-7 rule

Used by actions: CreateL7Rules, CreateL7RulesUpload, CreateNewL7RulesUpload, DescribleL7Rules, ModifyL7Rules.

Name Type Required Description
Protocol String Yes Forwarding protocol. Valid values: [http, https]
Domain String Yes Forwarding domain name
SourceType Integer Yes Forwarding method. Valid values: [1 (forwarding via domain name), 2 (forwarding via IP)]
KeepTime Integer Yes Session persistence duration in seconds
SourceList Array of L4RuleSource Yes Forward list
LbType Integer Yes Load balancing method. Valid value: [1 (weighted round robin)]
KeepEnable Integer Yes Session persistence status. Valid values: [0 (disabled), 1 (enabled)]
RuleId String No Rule ID, which is optional when adding a new rule but required when modifying or deleting a rule;
CertType Integer No Certificate source, which is required if the forwarding protocol is HTTPS. Valid value: [2 (Tencent Cloud-hosted certificate)]. If the forwarding protocol is HTTP, 0 can be entered for this field
SSLId String No If the certificate is a Tencent Cloud-hosted certificate, this field must be entered with the hosted certificate ID
Cert String No If the certificate is an external certificate, this field must be entered with the certificate content. (As external certificates are no longer supported, this field has been disused and does not need to be entered)
PrivateKey String No If the certificate is an external certificate, this field must be entered with the certificate key. (As external certificates are no longer supported, this field has been disused and does not need to be entered)
RuleName String No Rule description
Status Integer No Rule status. Valid values: [0 (successfully configured rule), 1 (rule configuration taking effect), 2 (rule configuration failed), 3 (rule deletion taking effect), 5 (rule deletion failed), 6 (rule waiting for configuration), 7 (rule waiting for deletion), 8 (rule waiting for certificate configuration)]
CCStatus Integer No CC protection status. Valid values: [0 (disabled), 1 (enabled)]
CCEnable Integer No HTTPS CC protection status. Valid values: [0 (disabled), 1 (enabled)]
CCThreshold Integer No HTTPS CC protection threshold
CCLevel String No HTTPS CC protection level
HttpsToHttpEnable Integer No
VirtualPort Integer No Access port number.
Note: this field may return null, indicating that no valid values can be obtained.

L7RuleHealth

Layer-7 rule health check parameter

Used by actions: DescribleL7Rules.

Name Type Required Description
RuleId String Yes Rule ID
Enable Integer Yes 1: enabled, 0: disabled
Interval Integer Yes Detection interval in seconds
KickNum Integer Yes Unhealthy threshold in times.
AliveNum Integer Yes Healthy threshold in times.
Method String Yes HTTP request method. Valid values: [HEAD, GET]
StatusCode Integer Yes Healthy status code during health check. xx = 1, 2xx = 2, 3xx = 4, 4xx = 8, 5xx = 16. Multiple status code values are added up
Url String Yes URL of checked directory. Default value: /
Status Integer Yes Configuration status. 0: normal, 1: configuring, 2: configuration failed

NewL7RuleEntry

Layer-7 rule.

Used by actions: ModifyNewDomainRules.

Name Type Required Description
Protocol String Yes Forwarding protocol. Valid values: http and https.
Domain String Yes Forwarding domain name.
SourceType Integer Yes Forwarding method. Valid values: 1 (by domain name); 2 (by IP).
KeepTime Integer Yes Session persistence duration, in seconds.
SourceList Array of L4RuleSource Yes List of sources
LbType Integer Yes Load balancing method. Valid value: 1 (weighed polling).
KeepEnable Integer Yes Whether session persistence is enabled. Valid values: 0 (disabled) and 1 (enabled).
RuleId String No Rule ID. This field is not required for adding a rule, but is required for modifying or deleting a rule.
CertType Integer No Certificate source. When the forwarding protocol is HTTPS, this field must be set to 2 (Tencent Cloud managed certificate), and for HTTP protocol, it can be set to 0.
SSLId String No When the certificate source is Tencent Cloud managed certificate, this field must be set to the ID of the managed certificate.
Cert String No [Disused] When the certificate is an external certificate, the certificate content should be provided here.
PrivateKey String No [Disused] When the certificate is an external certificate, the certificate key should be provided here.
RuleName String No Rule description.
Status Integer No Rule status. Valid values: 0 (the rule was successfully configured), 1 (configuring the rule), 2 (rule configuration failed), 3 (deleting the rule), 5 (failed to delete rule), 6 (rule awaiting configuration), 7 (rule awaiting deletion), and 8 (rule awaiting certificate configuration).
CCStatus Integer No CC protection status. Valid values: 0 (disabled) and 1 (enabled).
CCEnable Integer No CC protection status based on HTTPS. Valid values: 0 (disabled) and 1 (enabled).
CCThreshold Integer No CC protection threshold based on HTTPS.
CCLevel String No CC protection level based on HTTPS.
Region Integer No Region code.
Id String No Anti-DDoS instance ID.
Ip String No Anti-DDoS instance IP address.
ModifyTime Timestamp No Modification time.
HttpsToHttpEnable Integer No Whether to enable Forward HTTPS requests via HTTP. Valid values: 0 (disabled) and 1 (enabled). The default value is disabled.
VirtualPort Integer No Access port number.
Note: this field may return null, indicating that no valid values can be obtained.

OrderBy

Sort by field

Used by actions: DescribeResourceList.

Name Type Required Description
Field String Yes Sort by field name. Valid values: [
bandwidth (bandwidth),
overloadCount (number of times of exceeding peak value)
]
Order String Yes Sorting order. Valid values: [asc (ascending), desc (descending)]

Paging

Pagination index

Used by actions: DescribeIpUnBlockList.

Name Type Required Description
Offset Integer Yes Starting position
Limit Integer Yes Quantity

ProtocolPort

Protocol and port parameters

Used by actions: DescribeBaradData.

Name Type Required Description
Protocol String Yes Protocol (TCP, UDP)
Port Integer Yes Port

RegionInstanceCount

Number of resource instances in region

Used by actions: DescribleRegionCount.

Name Type Description
Region String Region code
RegionV3 String Region code (new specification)
Count Integer Number of resource instances

ResourceIp

Resource IP array

Used by actions: DescribeDDoSPolicy, DescribeResIpList.

Name Type Required Description
Id String Yes Anti-DDoS instance ID
IpList Array of String No Resource IP array

SchedulingDomain

Scheduling domain name information

Used by actions: DescribeSchedulingDomainList.

Name Type Description
Domain String Scheduling domain name
BGPIpList Array of String List of BGP IPs
CTCCIpList Array of String List of CTCC IPs
CUCCIpList Array of String List of CUCC IPs
CMCCIpList Array of String List of CMCC IPs
OverseaIpList Array of String List of IPs outside Mainland China
Method String Scheduling method. It only supports priority now.
CreateTime Timestamp The creation time.
TTL Integer
Status Integer Status
ModifyTime Timestamp Modification time

SuccessCode

Operation return code, which is only used to return success

Used by actions: CreateBoundIP, CreateCCSelfDefinePolicy, CreateInstanceName, CreateL4HealthConfig, CreateL4Rules, CreateL7HealthConfig, CreateL7RuleCert, CreateL7Rules, CreateL7RulesUpload, CreateNewL7RulesUpload, DeleteCCFrequencyRules, DeleteCCSelfDefinePolicy, DeleteDDoSPolicy, DeleteDDoSPolicyCase, DeleteL4Rules, DeleteL7Rules, ModifyCCAlarmThreshold, ModifyCCFrequencyRules, ModifyCCFrequencyRulesStatus, ModifyCCHostProtection, ModifyCCIpAllowDeny, ModifyCCLevel, ModifyCCPolicySwitch, ModifyCCSelfDefinePolicy, ModifyCCThreshold, ModifyCCUrlAllow, ModifyDDoSAlarmThreshold, ModifyDDoSDefendStatus, ModifyDDoSPolicy, ModifyDDoSPolicyCase, ModifyDDoSPolicyName, ModifyDDoSThreshold, ModifyElasticLimit, ModifyL4Health, ModifyL4KeepTime, ModifyL4Rules, ModifyL7Rules, ModifyNewDomainRules, ModifyNewL4Rule, ModifyResBindDDoSPolicy, ModifyResourceRenewFlag.

Name Type Description
Code String Success/error code
Message String Description

WaterPrintKey

Watermark key

Used by actions: DescribeDDoSPolicy, ModifyDDoSWaterKey.

Name Type Description
KeyId String Watermark key ID
KeyContent String Watermark key value
KeyVersion String Watermark key version number
OpenStatus Integer Whether it is enabled. Valid values: [0 (no), 1 (yes)]
CreateTime Timestamp Key generation time

WaterPrintPolicy

Watermarking policy parameter

Used by actions: CreateDDoSPolicy, DescribeDDoSPolicy, ModifyDDoSPolicy.

Name Type Required Description
TcpPortList Array of String Yes TCP port range, such as ["2000-3000","3500-4000"]
UdpPortList Array of String Yes UDP port range, such as ["2000-3000","3500-4000"]
Offset Integer Yes Watermark offset. Value range: [0, 100)
RemoveSwitch Integer Yes Whether to automatically remove. Valid values: [0 (no), 1 (yes)]
OpenStatus Integer Yes Whether it is enabled. Valid values: [0 (no), 1 (yes)]

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help