History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
API security resource information
Used by actions: DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| ResourceIds | String | No | Resource ID Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | No | Status Note: This field may return null, indicating that no valid values can be obtained. |
| Region | Integer | No | Region Note: This field may return null, indicating that no valid values can be obtained. |
| BeginTime | String | No | Start time Note: This field may return null, indicating that no valid values can be obtained. |
| EndTime | String | No | End time Note: This field may return null, indicating that no valid values can be obtained. |
| InquireNum | Integer | No | Application Quantity Note: This field may return null, indicating that no valid values can be obtained. |
| UsedNum | Integer | No | Usage Quantity Note: This field may return null, indicating that no valid values can be obtained. |
| RenewFlag | Integer | No | Renewal flag. Note: This field may return null, indicating that no valid values can be obtained. |
| BillingItem | String | No | Billing item. Note: This field may return null, indicating that no valid values can be obtained. |
| IsAPISecurityTrial | Integer | No | API security 7-day trial flag. 1 for trial. 0 for no trial. Note: This field may return null, indicating that no valid values can be obtained. |
Attack Log Details
Used by actions: SearchAttackLog.
| Name | Type | Description |
|---|---|---|
| Content | String | Details of Attack Logs |
| FileName | String | CLS Returned Content |
| Source | String | CLS Returned Content |
| TimeStamp | Timestamp | CLS Returned Content |
Returned description of the multi-domain blocklist/allowlist
Used by actions: DescribeBatchIpAccessControl.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number |
| Res | Array of BatchIpAccessControlItem | Entries of blocklist/allowlist |
Batch multi-domain blocklist/allowlist IP list
Used by actions: DescribeBatchIpAccessControl.
| Name | Type | Description |
|---|---|---|
| Id | String | MongoDB Table Auto-increment ID Note: This field may return null, indicating that no valid values can be obtained. |
| ActionType | Integer | Blocklist 42 or allowlist 40 |
| Ip | String | IP of the blocklist/allowlist |
| Note | String | Remarks |
| Source | String | Path addition |
| TsVersion | Integer | Modification time |
| ValidTs | Integer | Timeout period |
| Hosts | Array of String | Domain name list |
| RuleId | Integer | 55101145 Note: This field may return null, indicating that no valid values can be obtained. |
| IpList | Array of String | IP list Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | Integer | Creation time Note: This field may return null, indicating that no valid values can be obtained. |
| JobType | String | Scheduled task type Note: This field may return null, indicating that no valid values can be obtained. |
| CronType | String | Periodic task type Note: This field may return null, indicating that no valid values can be obtained. |
| JobDateTime | JobDateTime | Scheduled task configuration details Note: This field may return null, indicating that no valid values can be obtained. |
| ValidStatus | Integer | Effective status Note: This field may return null, indicating that no valid values can be obtained. |
Bot Resource Information
Used by actions: DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| ResourceIds | String | No | Resource ID Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | No | Status Note: This field may return null, indicating that no valid values can be obtained. |
| Region | Integer | No | Region Note: This field may return null, indicating that no valid values can be obtained. |
| BeginTime | String | No | Start time Note: This field may return null, indicating that no valid values can be obtained. |
| EndTime | String | No | End time Note: This field may return null, indicating that no valid values can be obtained. |
| InquireNum | Integer | No | Application Quantity Note: This field may return null, indicating that no valid values can be obtained. |
| UsedNum | Integer | No | Usage Quantity Note: This field may return null, indicating that no valid values can be obtained. |
| Type | String | No | Sub-product code. Note: This field may return null, indicating that no valid values can be obtained. |
| RenewFlag | Integer | No | Renewal flag. Note: This field may return null, indicating that no valid values can be obtained. |
| BotCPWaf | Integer | No | Purchase Page Bot 40% Off Note: This field may return null, indicating that no valid values can be obtained. |
| BotNPWaf | Integer | No | Console Buy Bot with 50% Off Note: This field may return null, indicating that no valid values can be obtained. |
| IsBotTrial | Integer | No | 7-day Bot Trial Identification, 1 for Trial, 0 for No Trial Note: This field may return null, indicating that no valid values can be obtained. |
Bot's QPS details
Used by actions: DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| ResourceIds | String | Yes | Resource ID |
| ValidTime | String | Yes | Expiration time |
| Count | Integer | Yes | Resource quantity. |
| Region | String | Yes | Resource Location |
| MaxBotQPS | Integer | Yes | Maximum QPS Usage |
| RenewFlag | Integer | Yes | Renewal flag. Note: This field may return null, indicating that no valid values can be obtained. |
Data Encapsulation
Used by actions: DescribeCCRule.
| Name | Type | Description |
|---|---|---|
| Res | Array of CCRuleItem | CC rules |
| TotalCount | Integer | Number of Rules |
CC rules
Used by actions: DescribeCCRule.
| Name | Type | Description |
|---|---|---|
| ActionType | Integer | Action |
| Advance | Integer | Advanced mode |
| Interval | Integer | Time period |
| Limit | Integer | Limit Attempts |
| MatchFunc | Integer | Matching Method |
| Name | String | Name |
| Priority | Integer | Priority |
| Status | Integer | Status |
| TsVersion | Integer | Update Timestamp |
| Url | String | Matching URL |
| ValidTime | Integer | Policy Action Validity Period |
| OptionsArr | String | Advanced Parameters Note: This field may return null, indicating that no valid values can be obtained. |
| Length | Integer | URL length 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. |
| EventId | String | Event ID Note: This field may return null, indicating that no valid values can be obtained. |
| SessionApplied | Array of Integer | Associated session rules Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | Integer | Creation time Note: This field may return null, indicating that no valid values can be obtained. |
CC rule details
Used by actions: DescribeCCRuleList.
| Name | Type | Description |
|---|---|---|
| Name | String | Name |
| Status | Integer | Status |
| Advance | Integer | Mode |
| Limit | Integer | Limit |
| Interval | Integer | Detection interval |
| Url | String | URL |
| MatchFunc | Integer | Type to match |
| ActionType | Integer | Action |
| Priority | Integer | Priority |
| ValidTime | Integer | Expiration time |
| TsVersion | Integer | Version |
| Options | String | Rule details |
| RuleId | Integer | Rule ID |
| EventId | String | Event ID Note: This field may return null, indicating that no valid values can be obtained. |
| SessionApplied | Array of Integer | Associated session rules Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | Integer | Creation time Note: This field may return null, indicating that no valid values can be obtained. |
CC rule overview
Used by actions: DescribeCCRuleList.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number |
| Res | Array of CCRuleItems | Rule Note: This field may return null, indicating that no valid values can be obtained. |
Tamper-proof URL Elements
Used by actions: DescribeAntiFakeRules.
| Name | Type | Description |
|---|---|---|
| Id | Integer | Identifier |
| Name | String | Name |
| Domain | String | Domain name |
| Uri | String | URL |
| Protocol | String | Protocol |
| Status | Integer | Status |
| ModifyTime | String | Modification time Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | Creation time Note: This field may return null, indicating that no valid values can be obtained. |
Details about the domain name protected by CLB WAF
Used by actions: DescribeDomainDetailsClb.
| Name | Type | Description |
|---|---|---|
| Domain | String | Domain name |
| DomainId | String | Unique domain name ID |
| InstanceId | String | Instance ID of the domain name |
| InstanceName | String | Name of the instance of the domain name |
| Edition | String | Instance type of the domain name |
| IsCdn | Integer | Whether a layer-7 proxy service is deployed before the WAF. 0: No proxy service is deployed; 1: The proxy service is deployed. The WAF will use XFF to obtain the client IP address; 2: The proxy service is deployed. The WAF will use remote_addr to obtain the client IP address; 3: The proxy service is deployed. The WAF will use a custom header in ip_headers to obtain the client IP address. |
| LoadBalancerSet | Array of LoadBalancerPackageNew | CLB information when the CLB type is clb |
| FlowMode | Integer | CLB WAF traffic mode. 1: cleaning mode; 0: image mode |
| State | Integer | Domain name-bound CLB status Note: This field may return null, indicating that no valid values can be obtained. |
| AlbType | String | CLB Type, either CLB or Apisix Note: This field may return null, indicating that no valid values can be obtained. |
| IpHeaders | Array of String | IsCdn=3 indicates custom header Note: This field may return null, indicating that no valid values can be obtained. |
| CdcClusters | String | CDC cluster information for the WAF of the cdc-clb-waf type Note: This field may return null, indicating that no valid values can be obtained. |
| CloudType | String | Cloud Type: public: Public Cloud; private: Private Cloud; hybrid: Hybrid Cloud Note: This field may return null, indicating that no valid values can be obtained. |
| Note | String | Domain name remarks Note: This field may return null, indicating that no valid values can be obtained. |
| Labels | Array of String | Domain name tag. Note: This field may return null, indicating that no valid values can be obtained. |
CLB type protection object
Used by actions: DescribeObjects.
| Name | Type | Description |
|---|---|---|
| ObjectId | String | Object ID |
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| PreciseDomains | Array of String | Precise Domain List |
| Status | Integer | WAF Feature Switch Status, 0 Off 1 On |
| ClsStatus | Integer | WAF Log Switch Status, 0 Off 1 On |
| VirtualDomain | String | Virtual Domain Name Corresponding to CLB Object |
| ObjectName | String | Object name |
| PublicIp | Array of String | Public network address |
| PrivateIp | Array of String | Private network address |
| VpcName | String | VPC name |
| Vpc | String | VPC ID |
| InstanceLevel | Integer | WAF instance level, if no instance is bound, it is 0 |
| PostCLSStatus | Integer | CLB Shipping Switch |
| PostCKafkaStatus | Integer | Kafka Shipping Switch |
| Type | String | Object type: CLB: Load Balancer, TSE: Cloud-native Gateway Note: This field may return null, indicating that no valid values can be obtained. |
| Region | String | Object Region Note: This field may return null, indicating that no valid values can be obtained. |
| Proxy | Integer | Proxy status. 0: disabled; 1: Use the first IP address in XFF as the client IP address; 2: Use remote_addr as the client IP address; 3: Obtain the client IP address from the specified header field. The field is given by the IpHeaders field. Note: This field may return null, indicating that no valid values can be obtained. |
| IpHeaders | Array of String | List of header fields for obtaining the client IP. This parameter is effective when IsCdn is 3. Note: This field may return null, indicating that no valid values can be obtained. |
| BotStatus | Integer | Bot protection switch Note: This field may return null, indicating that no valid values can be obtained. |
| ApiStatus | Integer | API protection switch Note: This field may return null, indicating that no valid values can be obtained. |
| ObjectFlowMode | Integer | Object access mode. 0: image mode; 1: cleaning mode; 2: examination mode. By default, the cleaning mode is used.Note: This field may return null, indicating that no valid values can be obtained. |
| NumericalVpcId | Integer | VPC ID in numerical format Note: This field may return null, indicating that no valid values can be obtained. |
CLB-WAF Regional Information
Used by actions: DescribeUserClbWafRegions.
| Name | Type | Description |
|---|---|---|
| Id | String | Region ID Note: This field may return null, indicating that no valid values can be obtained. |
| Text | String | Regional Chinese Description Note: This field may return null, indicating that no valid values can be obtained. |
| Value | String | Full English Name of the Region Note: This field may return null, indicating that no valid values can be obtained. |
| Code | String | Region encoding Note: This field may return null, indicating that no valid values can be obtained. |
Input/Output parameter goods of billing & ordering API
Used by actions: CreateDeals.
| Name | Type | Required | Description |
|---|---|---|---|
| GoodsNum | Integer | Yes | Number of products |
| GoodsDetail | CreateDealsGoodsDetail | Yes | Product Detail |
| GoodsCategoryId | Integer | No | Order type ID, which is used to uniquely identify a business scene. (There are three scenes in total: new purchase, configuration change, and renewal.) Advanced Edition: 102375 (new purchase), 102376 (renewal), and 102377 (configuration change) Enterprise Edition: 102378 (new purchase), 102379 (renewal), and 102380 (configuration change) Ultimate Edition: 102369 (new purchase), 102370 (renewal), and 102371 (configuration change) Domain name package: 102372 (new purchase), 102373 (renewal), and 102374 (configuration change) Business expansion package: 101040 (new purchase), 101041 (renewal), and 101042 (configuration change) Advanced Edition - CLB: 101198 (new purchase), 101199 (renewal), and 101200 (configuration change) Enterprise Edition - CLB: 101204 (new purchase), 101205 (renewal), and 101206 (configuration change) Ultimate Edition - CLB: 101201 (new purchase), 101202 (renewal), and 101203 (configuration change) Domain name package - CLB: 101207 (new purchase), 101208 (renewal), and 101209 (configuration change) Business expansion package - CLB: 101210 (new purchase), 101211 (renewal), and 101212 (configuration adjustment) Note: This field may return null, indicating that no valid values can be obtained. |
| RegionId | Integer | No | Region ID for purchasing WAF instance 1 indicates purchasing resources in Chinese mainland. 9 indicates purchasing resources outside Chinese mainland. Note: This field may return null, indicating that no valid values can be obtained. |
Product details
Used by actions: CreateDeals.
| Name | Type | Required | Description |
|---|---|---|---|
| TimeSpan | Integer | No | Time interval Note: This field may return null, indicating that no valid values can be obtained. |
| TimeUnit | String | No | Unit, support for purchasing d, m, y, i.e., (day, month, year) Note: This field may return null, indicating that no valid values can be obtained. |
| SubProductCode | String | No | Sub-product tag. It is mandatory for new purchase and renewal. For configuration change, it will be placed in oldConfig and newConfig. SaaS Advanced Edition: sp_wsm_waf_premium SaaS Enterprise Edition: sp_wsm_waf_enterprise SaaS Ultimate Edition: sp_wsm_waf_ultimate SaaS business expansion package: sp_wsm_waf_qpsep SaaS domain name expansion package: sp_wsm_waf_domain Advanced Edition - CLB: sp_wsm_waf_premium_clb Enterprise Edition - CLB: sp_wsm_waf_enterprise_clb Ultimate Edition - CLB: sp_wsm_waf_ultimate_clb business expansion package - CLB: sp_wsm_waf_qpsep_clb Domain name expansion package - CLB: sp_wsm_waf_domain_clb Note: This field may return null, indicating that no valid values can be obtained. |
| Pid | Integer | No | PID applied for a business product (corresponding to a pricing formula). The pricing model can be found through PID billing. Advanced Edition: 1000827 Enterprise Edition: 1000830 Ultimate Edition: 1000832 Domain name package: 1000834 Business expansion package: 1000481 Advanced Edition - CLB: 1001150 Enterprise Edition - CLB: 1001152 Ultimate Edition - CLB: 1001154 Domain name package - CLB: 1001156 Business expansion package - CLB: 1001160 Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceName | String | No | WAF Instance Name Note: This field may return null, indicating that no valid values can be obtained. |
| AutoRenewFlag | Integer | No | 1: Auto-renewal, 0: No Auto-renewal Note: This field may return null, indicating that no valid values can be obtained. |
| RealRegion | Integer | No | Actual Geographic Information of WAF Purchase Note: This field may return null, indicating that no valid values can be obtained. |
| LabelTypes | Array of String | No | Billing Detail Tag Array SaaS Advanced Edition: sv_wsm_waf_package_premium SaaS Enterprise Edition: sv_wsm_waf_package_enterprise SaaS Ultimate Edition: sv_wsm_waf_package_ultimate SaaS non-Chinese Mainland Advanced Edition: sv_wsm_waf_package_premium_intl SaaS non-Chinese Mainland Enterprise Edition: sv_wsm_waf_package_enterprise_intl SaaS non-Chinese Mainland Ultimate Edition: sv_wsm_waf_package_ultimate_intl SaaS business expansion package: sv_wsm_waf_qps_ep SaaS domain name expansion package: sv_wsm_waf_domain Advanced Edition CLB: sv_wsm_waf_package_premium_clb Enterprise Edition CLB: sv_wsm_waf_package_enterprise_clb Ultimate Edition CLB: sv_wsm_waf_package_ultimate_clb Non-Chinese Mainland Advanced Edition CLB: sv_wsm_waf_package_premium_clb_intl Non-Chinese Mainland Enterprise Edition CLB: sv_wsm_waf_package_premium_clb_intl Non-Chinese Mainland Ultimate Edition CLB: sv_wsm_waf_package_ultimate_clb_intl Business expansion package CLB: sv_wsm_waf_qps_ep_clb Domain name expansion package CLB: sv_wsm_waf_domain_clb Note: This field may return null, indicating that no valid values can be obtained. |
| LabelCounts | Array of Integer | No | Number of Billing Detail Tags, Generally Corresponds One-to-One with SvLabelType Note: This field may return null, indicating that no valid values can be obtained. |
| CurDeadline | String | No | Dynamic Configuration Usage, Instance Expiration Time Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceId | String | No | Purchasing Bot or API Security for Existing Instances Note: This field may return null, indicating that no valid values can be obtained. |
| ResourceId | String | No | Resource ID Note: This field may return null, indicating that no valid values can be obtained. |
Data structure of periodic rule execution
Used by actions: AddCustomRule, AddCustomWhiteRule, CreateIpAccessControl, CreateOwaspWhiteRule, ModifyCustomRule, ModifyCustomWhiteRule, ModifyIpAccessControl, ModifyOwaspWhiteRule.
| Name | Type | Required | Description |
|---|---|---|---|
| Days | Array of Integer | No | Execution day of each month. |
| WDays | Array of Integer | No | Execution day of each week. |
| StartTime | String | No | Start time. |
| EndTime | String | No | End time |
Billing order response entity
Used by actions: CreateDeals, GenerateDealsAndPayNew.
| Name | Type | Description |
|---|---|---|
| DealNames | Array of String | Order Number List: the number of elements matches the number of elements in the Goods array of the request package. Product details correspond to orders in sequence |
| BigDealId | String | Large Order Number, a large order number can have multiple sub-orders, indicating the same order placement [{},{}] |
Specific rule elements within the rule elements returned by DescribeAntiInfoLeakRules
Used by actions: DescribeAntiInfoLeakageRules.
| Name | Type | Description |
|---|---|---|
| Field | String | Field |
| CompareFunc | String | Condition |
| Content | String | Content |
Output parameters
Used by actions: DescribeAntiInfoLeakageRules.
| Name | Type | Description |
|---|---|---|
| RuleId | Integer | Rule ID |
| Name | String | Name |
| Status | Integer | Status value |
| Action | String | Action |
| CreateTime | String | Creation time |
| Strategies | Array of DescribeAntiInfoLeakRulesStrategyItem | Match condition Note: This field may return null, indicating that no valid values can be obtained. |
| Uri | String | Matched URL Note: This field may return null, indicating that no valid values can be obtained. |
| ModifyTime | String | Modification time Note: This field may return null, indicating that no valid values can be obtained. |
Complex type in the DescribeCustomRules interface response packet
Used by actions: DescribeCustomRuleList, DescribeCustomWhiteRule.
| Name | Type | Description |
|---|---|---|
| ActionType | String | Action type |
| Bypass | String | Skipped Policy |
| CreateTime | String | Creation time |
| ExpireTime | String | Expiration time |
| Name | String | Policy name |
| Redirect | String | URL for redirection |
| RuleId | String | Policy ID |
| SortId | String | Priority |
| Status | String | Status |
| Strategies | Array of Strategy | Policy details |
| EventId | String | Event ID Note: This field may return null, indicating that no valid values can be obtained. |
| ModifyTime | String | Modification time Note: This field may return null, indicating that no valid values can be obtained. |
| ValidStatus | Integer | Effective status Note: This field may return null, indicating that no valid values can be obtained. |
| Source | String | Source Note: This field may return null, indicating that no valid values can be obtained. |
| JobType | String | Scheduled task type Note: This field may return null, indicating that no valid values can be obtained. |
| JobDateTime | JobDateTime | Scheduled task configuration Note: This field may return null, indicating that no valid values can be obtained. |
| CronType | String | Periodic task granularity Note: This field may return null, indicating that no valid values can be obtained. |
| Label | String | Custom tag in risk control rules, indicating whether a rule is built-in or user-defined Note: This field may return null, indicating that no valid values can be obtained. |
| PageId | String | ID of the blocked page 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. |
Domain list
Used by actions: DescribeDomains.
| Name | Type | Required | Description |
|---|---|---|---|
| Domain | String | Yes | Domain name |
| DomainId | String | Yes | Domain ID |
| InstanceId | String | Yes | Instance ID |
| Cname | String | Yes | CNAME Address |
| Edition | String | Yes | Instance type of the domain name. sparta-waf: SaaS WAF instance clb-waf: CLB WAF instance cdc-clb-waf: CLB WAF instances in the CDC environment |
| Region | String | Yes | Region "Toronto": "ca" "Guangzhou": "gz" "Chengdu": "cd" "Fuzhou": "fzec" "Shenzhen": "szx" "India": "in" "Jinan": "jnec" "Chongqing": "cq" "Tianjin": "tsn" "Northeast Europe": "ru" "Nanjing": "nj" "Silicon Valley, USA": "usw" "Thailand": "th" "Guangzhou Open": "gzopen" "Shenzhen Finance": "szjr" "Frankfurt": "de" "Japan": "jp" "Virginia": "use" "Beijing": "bj" "Hong Kong (China)": "hk" "Hangzhou": "hzec" "Beijing Finance": "bjjr" "Shanghai Finance": "shjr" "Taipei (China)": "tpe" "Seoul": "kr" "Shanghai": "sh" "Singapore": "sg" "Qingyuan": "qy" |
| InstanceName | String | Yes | Instance name |
| ClsStatus | Integer | Yes | Access log switch status 0: disabled 1: enabled |
| FlowMode | Integer | Yes | CLB WAF usage mode 0: image mode 1: cleaning mode |
| Status | Integer | Yes | WAF switch status 0: disabled 1: enabled |
| Mode | Integer | Yes | Rule engine protection mode 0: observation mode 1: interception mode |
| Engine | Integer | Yes | Joint status of rule engine and AI engine protection modes. 1: initial status: interception for the rule engine and disabled for the AI engine 10: observation for the rule engine and disabled for the AI engine 11: observation for both the rule engine and AI engine 12: observation for the rule engine and interception for the AI engine 20: interception for the rule engine and disabled for the AI engine 21: interception for the rule engine and observation for the AI engine 22: interception for both the rule engine and AI engine |
| CCList | Array of String | Yes | Sandbox cluster origin-pull outbound IP list |
| RsList | Array of String | Yes | Production cluster origin-pull outbound IP list |
| Ports | Array of PortInfo | Yes | Service port configuration |
| LoadBalancerSet | Array of LoadBalancerPackageNew | Yes | CLB-related configuration |
| AppId | Integer | Yes | User ID |
| State | Integer | Yes | LB listener status of the domain name protected by CLB WAF0: Operation successful. 4: The LB is being bound. 6: The LB is being unbound. 7: Failed to unbind the LB. 8: Failed to bind the LB. 10: Internal error. |
| CreateTime | String | No | Creation time |
| Ipv6Status | Integer | No | IPv6 switch status. 0: disabled 1: enabled |
| BotStatus | Integer | No | Bot switch status. 0: disabled 1: disabled 2: enabled 3: enabled |
| Level | Integer | No | Instance version information. 101: Small and Micro Agile Edition 102: Small and Micro Ultra-light Edition 2: Advanced Edition 3: Enterprise Edition 4: Ultimate Edition 6: Exclusive Edition |
| PostCLSStatus | Integer | No | Shipping status of CLS. 0: disabled 1: enabled |
| PostCKafkaStatus | Integer | No | Shipping status of CKafka. 0: disabled 1: enabled |
| CdcClusters | String | No | Cluster information accessed by the CDC instance domain name, which can be ignored for non-CDC instances. Note: This field may return null, indicating that no valid values can be obtained. |
| ApiStatus | Integer | No | API security switch status. 0: disabled 1: enabled Note: This field may return null, indicating that no valid values can be obtained. |
| AlbType | String | No | Application-based CLB type. The default value is clb. clb: layer-7 CLB apisix: APISIX gateway Note: This field may return null, indicating that no valid values can be obtained. |
| SgState | Integer | No | Security group status. 0: not display 1: non-Tencent Cloud origin server 2: Security group binding failed. 3: security groups changed. Note: This field may return null, indicating that no valid values can be obtained. |
| SgDetail | String | No | Detailed Explanation of Security Group Status Note: This field may return null, indicating that no valid values can be obtained. |
| CloudType | String | No | Domain name cloud environment. hybrid: hybrid cloud domain name public: public cloud domain name Note: This field may return null, indicating that no valid values can be obtained. |
| Note | String | No | Domain name remarks Note: This field may return null, indicating that no valid values can be obtained. |
| SrcList | Array of String | No | SaaS WAF origin server IP list Note: This field may return null, indicating that no valid values can be obtained. |
| UpstreamDomainList | Array of String | No | SaaS WAF origin server domain name list Note: This field may return null, indicating that no valid values can be obtained. |
| SgID | String | No | Security group ID Note: This field may return null, indicating that no valid values can be obtained. |
| AccessStatus | Integer | No | CLB WAF access status Note: This field may return null, indicating that no valid values can be obtained. |
| Labels | Array of String | No | Domain name tag. Note: This field may return null, indicating that no valid values can be obtained. |
CLB-WAF domain extension package
Used by actions: DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| ResourceIds | String | Yes | Resource ID Note: This field may return null, indicating that no valid values can be obtained. |
| ValidTime | String | Yes | Expiration time Note: This field may return null, indicating that no valid values can be obtained. |
| RenewFlag | Integer | Yes | Auto-renewal, 1: Enabled, 0: Disabled Note: This field may return null, indicating that no valid values can be obtained. |
| Count | Integer | Yes | Number of Package Purchases Note: This field may return null, indicating that no valid values can be obtained. |
| Region | String | Yes | Package Purchase Region, currently not used in CLB-WAF Note: This field may return null, indicating that no valid values can be obtained. |
Domain name, which corresponds to the rule ID structure.
Used by actions: DeleteCustomRule, ModifyCustomRuleStatus.
| Name | Type | Required | Description |
|---|---|---|---|
| Domain | String | No | Domain name Note: This field may return null, indicating that no valid values can be obtained. |
| RuleId | String | No | Rule ID Note: This field may return null, indicating that no valid values can be obtained. |
Unique positioning domain
Used by actions: ModifyDomainsCLSStatus.
| Name | Type | Required | Description |
|---|---|---|---|
| Domain | String | Yes | Domain name |
| Edition | String | Yes | Version |
| InstanceID | String | No | Instance ID Note: This field may return null, indicating that no valid values can be obtained. |
Details of domain names protected by SaaS WAF
Used by actions: DescribeDomainDetailsSaas.
| Name | Type | Description |
|---|---|---|
| Domain | String | Domain name |
| DomainId | String | Unique domain name ID |
| InstanceId | String | Unique instance ID of the domain name |
| Edition | String | Instance type of the domain name |
| InstanceName | String | Instance name of the domain name |
| Cert | String | Certificate |
| CreateTime | String | Creation time |
| Engine | Integer | Status of the rule engine and AI engine 1: initial status. Interception for the rule engine and disabled for the AI engine. 10: observation for the rule engine and disabled for the AI engine 11: observation for both the rule engine and AI engine 12: observation for the rule engine and interception for the AI engine 20: interception for the rule engine and disabled for the AI engine 21: interception for the rule engine and observation for the AI engine 22: interception for both the rule engine and AI engine |
| HttpsRewrite | Integer | Whether to enable forced redirection from HTTP to HTTPS 0: do not force redirection 1: enable forced redirection |
| HttpsUpstreamPort | String | HTTPS origin-pull port |
| IsCdn | Integer | Whether a layer-7 proxy service is deployed before WAF 0: No proxy service deployed 1: Proxy service deployed, and WAF will use XFF to obtain the client IP address 2: Proxy service deployed and WAF will use remote_addr to obtain the client IP address 3: Proxy service deployed and WAF will use the custom header in ip_headers to obtain the client IP address |
| IsGray | Integer | This parameter has been deprecated. |
| IsHttp2 | Integer | Whether to enable HTTP2. You should enable HTTPS as well. 0: disable 1: enable |
| IsWebsocket | Integer | Whether to enable support for WebSocket 0: disable 1: enable |
| LoadBalance | Integer | Load balancing policy for origin-pull 0: round-robin 1: IP hash 2: weighted round-robin |
| Mode | Integer | Protection mode 0: observation mode 1: interception mode |
| PrivateKey | String | Private key of the self-owned certificate |
| SSLId | String | When CertType is 2, this parameter must be filled, indicating the certificate ID hosted on Tencent Cloud's SSL platform |
| UpstreamDomain | String | Origin domain when domain is back to source. When UpstreamType=1, this field needs to be filled |
| UpstreamType | Integer | Origin-pull type 0: origin-pull via IP address 1: origin-pull via domain name |
| SrcList | Array of String | Origin IP list when IP is back to source. When UpstreamType=0, this field is required |
| Ports | Array of PortInfo | Domain name port configuration |
| CertType | Integer | Certificate type 0: no certificate, with only the HTTP listening port configured 1: self-owned certificate 2: managed certificate |
| UpstreamScheme | String | Origin-pull protocol for HTTPS when the service is configured with an HTTPS port http: Use the HTTP protocol for origin-pull. It is used together with HttpsUpstreamPort. https: Use the HTTPS protocol for origin-pull. |
| Cls | Integer | Whether to enable access logging 0: disable 1: enable |
| Cname | String | CNAME record for accessing a domain name protected by SaaS WAF |
| IsKeepAlive | Integer | Whether to enable persistent connection 0: non-persistent connection 1: persistent connection |
| ActiveCheck | Integer | Whether to enable proactive health check 0: disable 1: enable Note: This field may return null, indicating that no valid values can be obtained. |
| TLSVersion | Integer | TLS version information Note: This field may return null, indicating that no valid values can be obtained. |
| Ciphers | Array of Integer | Custom encryption suite list. When CipherTemplate is 3, this field is required, indicating the custom encryption suite, value obtained through DescribeCiphersDetail API. Note: This field may return null, indicating that no valid values can be obtained. |
| CipherTemplate | Integer | Cipher suite template 0: default template 1: general template 2: security template 3: custom template Note: This field may return null, indicating that no valid values can be obtained. |
| ProxyReadTimeout | Integer | Read timeout between WAF and origin server, 300s by default. Note: This field may return null, indicating that no valid values can be obtained. |
| ProxySendTimeout | Integer | WAF and origin server write timeout, 300s by default. Note: This field may return null, indicating that no valid values can be obtained. |
| SniType | Integer | SNI type during WAF origin-pull 0: Disable SNI and do not configure server_name in client_hello. 1: Enable SNI. server_name in client_hello is a protected domain name. 2: Enable SNI. SNI is the origin server domain name during the domain name origin-pull. 3: Enable SNI. SNI is a custom domain name. Note: This field may return null, indicating that no valid values can be obtained. |
| SniHost | String | When SniType=3, this parameter is required, indicating a custom SNI; Note: This field may return null, indicating that no valid values can be obtained. |
| Weights | Array of String | Weight of the IP address for origin-pull Note: This field may return null, indicating that no valid values can be obtained. |
| IpHeaders | Array of String | IsCdn=3 indicates custom header Note: This field may return null, indicating that no valid values can be obtained. |
| XFFReset | Integer | Whether to enable XFF reset 0: disable 1: enable Note: This field may return null, indicating that no valid values can be obtained. |
| Note | String | Domain name remarks Note: This field may return null, indicating that no valid values can be obtained. |
| UpstreamHost | String | Custom origin-pull host. The default value is a null string, indicating that a protected domain name is used as the origin-pull host. Note: This field may return null, indicating that no valid values can be obtained. |
| Level | String | Protection rule Note: This field may return null, indicating that no valid values can be obtained. |
| ProxyBuffer | Integer | Whether to enable caching. 0: disable; 1: enable. Note: This field may return null, indicating that no valid values can be obtained. |
| GmType | Integer | Whether to enable SM. 0: do not enable SM; 1: add support for SM based on the existing TLS option; 2: enable SM and support only SM client access. Note: This field may return null, indicating that no valid values can be obtained. |
| GmCertType | Integer | SM certificate type. 0: no SM certificate is available; 1: the certificate is a self-owned SM certificate; 2: the certificate is a managed SM certificate. Note: This field may return null, indicating that no valid values can be obtained. |
| GmCert | String | When GmCertType is 1, this parameter needs to be set, indicating the certificate chain of the self-owned SM certificate. Note: This field may return null, indicating that no valid values can be obtained. |
| GmPrivateKey | String | When GmCertType is 1, this parameter needs to be set, indicating the private key of the self-owned SM certificate. Note: This field may return null, indicating that no valid values can be obtained. |
| GmEncCert | String | When GmCertType is 1, this parameter needs to be set, indicating the encryption certificate of the self-owned SM certificate. Note: This field may return null, indicating that no valid values can be obtained. |
| GmEncPrivateKey | String | When GmCertType is 1, this parameter needs to be set, indicating the private key of the encryption certificate for the self-owned SM certificate. Note: This field may return null, indicating that no valid values can be obtained. |
| GmSSLId | String | When GmCertType is 2, this parameter needs to be set, indicating the ID of the certificate managed by the Tencent Cloud SSL platform. Note: This field may return null, indicating that no valid values can be obtained. |
| Labels | Array of String | Domain name tag. Note: This field may return null, indicating that no valid values can be obtained. |
Filter array
Used by actions: DescribeAntiFakeRules, DescribeAntiInfoLeakageRules, DescribeBatchIpAccessControl, DescribeCCRuleList, DescribeCustomRuleList, DescribeCustomWhiteRule, DescribeDomains, DescribeInstances, DescribeObjects, DescribeOwaspRuleTypes, DescribeOwaspRules, DescribeOwaspWhiteRules.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Field name, used for filtering Filter the sub-order number (value) by DealName. |
| Values | Array of String | Yes | Values after filtering |
| ExactMatch | Boolean | Yes | Exact search or not |
Domain name list
Used by actions: DescribeFindDomainList.
| Name | Type | Description |
|---|---|---|
| Appid | Integer | User ID |
| Domain | String | Domain name |
| Ips | Array of String | Domain IP |
| FindTime | String | Detection time |
| InstanceId | String | Instance ID |
| DomainId | String | Domain ID |
| Edition | String | WAF type |
| IsWafDomain | Integer | Whether to access WAF |
Business security resource information
Used by actions: DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| ResourceIds | String | No | Resource ID Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | No | Status Note: This field may return null, indicating that no valid values can be obtained. |
| Region | Integer | No | Region Note: This field may return null, indicating that no valid values can be obtained. |
| BeginTime | String | No | Start time Note: This field may return null, indicating that no valid values can be obtained. |
| EndTime | String | No | End time Note: This field may return null, indicating that no valid values can be obtained. |
| InquireNum | Integer | No | Application Quantity Note: This field may return null, indicating that no valid values can be obtained. |
| UsedNum | Integer | No | Usage Quantity Note: This field may return null, indicating that no valid values can be obtained. |
| RenewFlag | Integer | No | Renewal flag. Note: This field may return null, indicating that no valid values can be obtained. |
Input/Output parameter goods of billing & ordering API
Used by actions: GenerateDealsAndPayNew.
| Name | Type | Required | Description |
|---|---|---|---|
| GoodsNum | Integer | Yes | Number of products |
| GoodsDetail | GoodsDetailNew | Yes | Product Detail |
| GoodsCategoryId | Integer | No | Order type ID, which is used to uniquely identify a business scene. (There are three scenes in total: new purchase, configuration change, and renewal.) Advanced Edition: 102375 (new purchase), 102376 (renewal), and 102377 (configuration change) Enterprise Edition: 102378 (new purchase), 102379 (renewal), and 102380 (configuration change) Ultimate Edition: 102369 (new purchase), 102370 (renewal), and 102371 (configuration change) Domain name package: 102372 (new purchase), 102373 (renewal), and 102374 (configuration change) Business expansion package: 101040 (new purchase), 101041 (renewal), and 101042 (configuration change) Advanced Edition - CLB: 101198 (new purchase), 101199 (renewal), and 101200 (configuration change) Enterprise Edition - CLB: 101204 (new purchase), 101205 (renewal), and 101206 (configuration change) Ultimate Edition - CLB: 101201 (new purchase), 101202 (renewal), and 101203 (configuration change) Domain name package - CLB: 101207 (new purchase), 101208 (renewal), and 101209 (configuration change) Business expansion package - CLB: 101210 (new purchase), 101211 (renewal), and 101212 (configuration adjustment) Note: This field may return null, indicating that no valid values can be obtained. |
| RegionId | Integer | No | Region ID for purchasing WAF instance 1 indicates purchasing resources in Chinese mainland. 9 indicates purchasing resources outside Chinese mainland. Note: This field may return null, indicating that no valid values can be obtained. |
Product details
Used by actions: GenerateDealsAndPayNew.
| Name | Type | Required | Description |
|---|---|---|---|
| TimeSpan | Integer | No | Time interval Note: This field may return null, indicating that no valid values can be obtained. |
| TimeUnit | String | No | Unit, support for purchasing d, m, y, i.e., (day, month, year) Note: This field may return null, indicating that no valid values can be obtained. |
| SubProductCode | String | No | Sub-product tag. It is mandatory for new purchase and renewal. For configuration change, it will be placed in oldConfig and newConfig. SaaS Advanced Edition: sp_wsm_waf_premium SaaS Enterprise Edition: sp_wsm_waf_enterprise SaaS Ultimate Edition: sp_wsm_waf_ultimate SaaS business expansion package: sp_wsm_waf_qpsep SaaS domain name expansion package: sp_wsm_waf_domain Advanced Edition - CLB: sp_wsm_waf_premium_clb Enterprise Edition - CLB: sp_wsm_waf_enterprise_clb Ultimate Edition - CLB: sp_wsm_waf_ultimate_clb Business expansion package - CLB: sp_wsm_waf_qpsep_clb Domain name expansion package - CLB: sp_wsm_waf_domain_clb Note: This field may return null, indicating that no valid values can be obtained. |
| Pid | Integer | No | PID applied for a business product (corresponding to a pricing formula). The pricing model can be found through PID billing. Advanced Edition: 1000827 Enterprise Edition: 1000830 Ultimate Edition: 1000832 Domain name package: 1000834 Business expansion package: 1000481 Advanced Edition - CLB: 1001150 Enterprise Edition - CLB: 1001152 Ultimate Edition - CLB: 1001154 Domain name package - CLB: 1001156 Business expansion package - CLB: 1001160 Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceName | String | No | WAF Instance Name Note: This field may return null, indicating that no valid values can be obtained. |
| AutoRenewFlag | Integer | No | 1: Auto-renewal, 0: No Auto-renewal Note: This field may return null, indicating that no valid values can be obtained. |
| RealRegion | Integer | No | Actual Geographic Information of WAF Purchase Note: This field may return null, indicating that no valid values can be obtained. |
| LabelTypes | Array of String | No | Billing Detail Tag Array SaaS Advanced Edition: sv_wsm_waf_package_premium SaaS Enterprise Edition: sv_wsm_waf_package_enterprise SaaS Ultimate Edition: sv_wsm_waf_package_ultimate SaaS non-Chinese Mainland Advanced Edition: sv_wsm_waf_package_premium_intl SaaS non-Chinese Mainland Enterprise Edition: sv_wsm_waf_package_enterprise_intl SaaS non-Chinese Mainland Ultimate Edition: sv_wsm_waf_package_ultimate_intl SaaS business expansion package: sv_wsm_waf_qps_ep SaaS domain name expansion package: sv_wsm_waf_domain Advanced Edition CLB: sv_wsm_waf_package_premium_clb Enterprise Edition CLB: sv_wsm_waf_package_enterprise_clb Ultimate Edition CLB: sv_wsm_waf_package_ultimate_clb Non-Chinese Mainland Advanced Edition CLB: sv_wsm_waf_package_premium_clb_intl Non-Chinese Mainland Enterprise Edition CLB: sv_wsm_waf_package_premium_clb_intl Non-Chinese Mainland Ultimate Edition CLB: sv_wsm_waf_package_ultimate_clb_intl Business expansion package CLB: sv_wsm_waf_qps_ep_clb Domain name expansion package CLB: sv_wsm_waf_domain_clb Note: This field may return null, indicating that no valid values can be obtained. |
| LabelCounts | Array of Integer | No | Number of Billing Detail Tags, Generally Corresponds One-to-One with SvLabelType Note: This field may return null, indicating that no valid values can be obtained. |
| CurDeadline | String | No | Dynamic Configuration Usage, Instance Expiration Time Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceId | String | No | Purchasing Bot or API Security for Existing Instances Note: This field may return null, indicating that no valid values can be obtained. |
| ResourceId | String | No | Resource ID Note: This field may return null, indicating that no valid values can be obtained. |
| MicroVersion | String | No | CLB WAF or SaaS WAF mode. Note: This field may return null, indicating that no valid values can be obtained. |
CLB-WAF deleted domain parameters
Used by actions: DeleteHost.
| Name | Type | Required | Description |
|---|---|---|---|
| Domain | String | Yes | Domain name |
| DomainId | String | Yes | Domain ID |
| InstanceID | String | No | Instance type |
Information on domain names protected by CLB WAF
Used by actions: CreateHost, DescribeHost, DescribeHosts, ModifyHost.
| Name | Type | Required | Description |
|---|---|---|---|
| Domain | String | Yes | Domain name |
| DomainId | String | Yes | Unique domain name ID |
| MainDomain | String | Yes | Primary Domain, empty upon input |
| Mode | Integer | Yes | Rule engine protection mode 0: observation mode 1: interception mode |
| Status | Integer | Yes | Binding relationship between WAF and CLB 0: unbound 1: bound |
| State | Integer | Yes | Domain name listener status of CLB WAF 0: operation successful 4: CLB instance binding in progress 6: CLB instance unbinding in progress 7: CLB instance unbinding failed 8: CLB instance binding failed 10: internal error |
| Engine | Integer | Yes | Status of the rule engine and AI engine 1: initial status. Interception for the rule engine and disabled for the AI engine. 10: observation for the rule engine and disabled for the AI engine 11: observation for both the rule engine and AI engine 12: observation for the rule engine and interception for the AI engine 20: interception for the rule engine and disabled for the AI engine 21: interception for the rule engine and observation for the AI engine 22: interception for both the rule engine and AI engine |
| IsCdn | Integer | Yes | Whether a layer-7 proxy service is deployed before WAF. 0: No proxy service deployed; 1: Proxy service deployed, and WAF will use XFF to obtain the client IP address; 2: Proxy service deployed, and WAF will use remote_addr to obtain the client IP address; 3: Proxy service deployed, and WAF will use the custom header in ip_headers to obtain the client IP address. |
| LoadBalancerSet | Array of LoadBalancer | Yes | List of the information on the bound CLB instance |
| Region | String | Yes | Region of the CLB instance bound to the domain name. Separate multiple regions by commas. |
| Edition | String | Yes | Instance type of the domain name. For CLB WAF, the value is "clb-waf". |
| FlowMode | Integer | Yes | Traffic mode of domain names protected by CLB WAF 1: cleaning mode 0: mirror mode |
| ClsStatus | Integer | Yes | Whether to enable access logging 1: enable 0: disable |
| Level | Integer | No | Protection Level, Optional Values: 100, 200, 300 Note: This field may return null, indicating that no valid values can be obtained. |
| CdcClusters | Array of String | No | List of CDC clusters to which the domain name needs to be delivered. Specify this parameter for CDC scenes only. Note: This field may return null, indicating that no valid values can be obtained. |
| AlbType | String | No | Application CLB type. Default value: clb. clb: layer-7 CLB tsegw: Tencent Cloud API Gateway scf: Tencent Cloud Serverless apisix: Other Tencent Cloud Gateway. eg: APISIX gateway Note: This field may return null, indicating that no valid values can be obtained. |
| IpHeaders | Array of String | No | IsCdn=3 required for this parameter, indicates custom header Note: This field may return null, indicating that no valid values can be obtained. |
| EngineType | Integer | No | Rule engine type 1: menshen 2: tiga Note: This field may return null, indicating that no valid values can be obtained. |
| CloudType | String | No | Cloud type public: public cloud private: private cloud hybrid: hybrid cloud Note: This field may return null, indicating that no valid values can be obtained. |
| Note | String | No | Domain name remarks Note: This field may return null, indicating that no valid values can be obtained. |
Structure for setting WAF status
Used by actions: ModifyHostStatus.
| Name | Type | Required | Description |
|---|---|---|---|
| Domain | String | Yes | Domain name |
| DomainId | String | Yes | Domain ID |
| Status | Integer | Yes | WAF switch. 1: On, 0: Off |
| InstanceID | String | No | Instance ID |
Hybrid cloud node resource information
Used by actions: DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| ResourceIds | String | No | Resource ID Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | No | Status Note: This field may return null, indicating that no valid values can be obtained. |
| Region | Integer | No | Region Note: This field may return null, indicating that no valid values can be obtained. |
| BeginTime | String | No | Start time Note: This field may return null, indicating that no valid values can be obtained. |
| EndTime | String | No | End time Note: This field may return null, indicating that no valid values can be obtained. |
| InquireNum | Integer | No | Application Quantity Note: This field may return null, indicating that no valid values can be obtained. |
| UsedNum | Integer | No | Usage Quantity Note: This field may return null, indicating that no valid values can be obtained. |
| RenewFlag | Integer | No | Renewal flag. Note: This field may return null, indicating that no valid values can be obtained. |
Detailed information of an instance
Used by actions: DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| InstanceId | String | Yes | Unique Instance ID |
| InstanceName | String | Yes | Instance name |
| ResourceIds | String | Yes | Resource ID corresponding to the Instance, for billing usage |
| Region | String | Yes | Instance region |
| PayMode | Integer | Yes | Payment mode |
| RenewFlag | Integer | Yes | Auto-renewal flag. 0: disable 1: enable |
| Mode | Integer | Yes | Elastic billing switch. 0: disable 1: enable |
| Level | Integer | Yes | Instance package version. 101: Small and Micro Edition. 102: Ultra-light Edition. 2: Advanced Edition. 3: Enterprise Edition. 4: Ultimate Edition. 6: Exclusive Edition |
| ValidTime | String | Yes | Instance expiration time |
| BeginTime | String | Yes | Instance Start Time |
| DomainCount | Integer | Yes | Configured Domain Count |
| SubDomainLimit | Integer | Yes | Maximum Domain Count |
| MainDomainCount | Integer | Yes | Configured Primary Domain Count |
| MainDomainLimit | Integer | Yes | Maximum Number of Primary Domain Names |
| MaxQPS | Integer | Yes | Instance QPS Peak within 30 Days |
| QPS | QPSPackageNew | Yes | QPS Expansion Package Information |
| DomainPkg | DomainPackageNew | Yes | Domain Extension Package Information |
| AppId | Integer | Yes | User appid. |
| Edition | String | Yes | CLB or SaaS |
| FraudPkg | FraudPkg | No | Business Security Package Note: This field may return null, indicating that no valid values can be obtained. |
| BotPkg | BotPkg | No | Bot Resource Package Note: This field may return null, indicating that no valid values can be obtained. |
| BotQPS | BotQPS | No | Bot's QPS details Note: This field may return null, indicating that no valid values can be obtained. |
| ElasticBilling | Integer | No | QPS Elastic Billing Cap Note: This field may return null, indicating that no valid values can be obtained. |
| AttackLogPost | Integer | No | Attack Log Shipping Switch Note: This field may return null, indicating that no valid values can be obtained. |
| MaxBandwidth | Integer | No | Peak Bandwidth, in B/s (Bytes per Second) Note: This field may return null, indicating that no valid values can be obtained. |
| APISecurity | Integer | No | Whether API security is purchased |
| QpsStandard | Integer | No | Purchased QPS Specification Note: This field may return null, indicating that no valid values can be obtained. |
| BandwidthStandard | Integer | No | Purchased Bandwidth Specification Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | No | Instance status Note: This field may return null, indicating that no valid values can be obtained. |
| SandboxQps | Integer | No | Instance Sandbox QPS Value Note: This field may return null, indicating that no valid values can be obtained. |
| IsAPISecurityTrial | Integer | No | Whether API Security is on Trial Note: This field may return null, indicating that no valid values can be obtained. |
| MajorEventsPkg | MajorEventsPkg | No | Premium Package Note: This field may return null, indicating that no valid values can be obtained. |
| HybridPkg | HybridPkg | No | Hybrid Cloud Sub-node Package Note: This field may return null, indicating that no valid values can be obtained. |
| ApiPkg | ApiPkg | No | API security resource package Note: This field may return null, indicating that no valid values can be obtained. |
| MiniPkg | MiniPkg | No | MMPS Acceleration Package Note: This field may return null, indicating that no valid values can be obtained. |
| MiniQpsStandard | Integer | No | Mini Program QPS Specification Note: This field may return null, indicating that no valid values can be obtained. |
| MiniMaxQPS | Integer | No | Mini Program QPS Peak Note: This field may return null, indicating that no valid values can be obtained. |
| LastQpsExceedTime | String | No | Last overage time. Note: This field may return null, indicating that no valid values can be obtained. |
| MiniExtendPkg | MiniExtendPkg | No | ID quantity expansion package for secure mini program access. Note: This field may return null, indicating that no valid values can be obtained. |
| BillingItem | String | No | Billing item. Note: This field may return null, indicating that no valid values can be obtained. |
| FreeDelayFlag | Integer | No | Flag for delay of instance deletion. Note: This field may return null, indicating that no valid values can be obtained. |
Data Encapsulation
Used by actions: DescribeIpAccessControl.
| Name | Type | Description |
|---|---|---|
| Res | Array of IpAccessControlItem | IP Blocklist/Allowlist Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | Counting. |
IP Blocklist/Allowlist
Used by actions: DescribeIpAccessControl.
| Name | Type | Description |
|---|---|---|
| Id | String | MongoDB Table Auto-increment ID Note: This field may return null, indicating that no valid values can be obtained. |
| ActionType | Integer | Action |
| Ip | String | ip |
| Note | String | Remarks |
| Source | String | Source. |
| TsVersion | Integer | Update Timestamp Note: This field may return null, indicating that no valid values can be obtained. |
| ValidTs | Integer | Expiration Timestamp |
| ValidStatus | Integer | Effective status. Note: This field may return null, indicating that no valid values can be obtained. |
| RuleId | Integer | 55000001 Note: This field may return null, indicating that no valid values can be obtained. |
| IpList | Array of String | IP list. Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | Integer | Rule creation time Note: This field may return null, indicating that no valid values can be obtained. |
| JobType | String | Scheduled task type Note: This field may return null, indicating that no valid values can be obtained. |
| CronType | String | Periodic task type. Note: This field may return null, indicating that no valid values can be obtained. |
| JobDateTime | JobDateTime | Details of scheduled task configuration. Note: This field may return null, indicating that no valid values can be obtained. |
IP blocklist/allowlist parameters structure, which is mainly used for IP blocklist/allowlist import.
Used by actions: ImportIpAccessControl.
| Name | Type | Required | Description |
|---|---|---|---|
| IpList | Array of String | Yes | IP list. |
| ValidTs | Integer | Yes | valid_ts indicates a valid date. Its value is a second-level timestamp, such as 1680570420, which indicates 2023-04-04 09:07:00. |
| ActionType | Integer | Yes | 42: blocklist; 40: allowlist. |
| Note | String | No | Remarks |
Rule execution time structure
Used by actions: AddCustomRule, AddCustomWhiteRule, CreateIpAccessControl, CreateOwaspWhiteRule, DescribeBatchIpAccessControl, DescribeCustomRuleList, DescribeCustomWhiteRule, DescribeIpAccessControl, DescribeOwaspWhiteRules, ModifyCustomRule, ModifyCustomWhiteRule, ModifyIpAccessControl, ModifyOwaspWhiteRule.
| Name | Type | Required | Description |
|---|---|---|---|
| Timed | Array of TimedJob | No | Time parameter for scheduled execution. |
| Cron | Array of CronJob | No | Time parameter for periodic execution. |
| TimeTZone | String | No | Specifies the time zone. |
In the form of Key-Value, where Value is an Int
Used by actions: DescribeTopAttackDomain.
| Name | Type | Description |
|---|---|---|
| Key | String | Key |
| Value | Integer | Value |
CLB listener
Used by actions: CreateHost, DescribeHost, DescribeHosts, ModifyHost.
| Name | Type | Required | Description |
|---|---|---|---|
| LoadBalancerId | String | Yes | CLB LD's ID |
| LoadBalancerName | String | Yes | CLB LD's Name |
| ListenerId | String | Yes | CLB Listener ID |
| ListenerName | String | Yes | Name of CLB Listener |
| Vip | String | Yes | IP of CLB Instance |
| Vport | Integer | Yes | Port of the CLB Instance |
| Region | String | Yes | CLB LD's Region |
| Protocol | String | Yes | Listener Protocol, HTTP, HTTPS |
| Zone | String | Yes | Zone of the CLB Listener |
| NumericalVpcId | Integer | No | CLB's VPC ID, -1 for public network, fill in the actual number for private network Note: This field may return null, indicating that no valid values can be obtained. |
| LoadBalancerType | String | No | CLB Network Type Note: This field may return null, indicating that no valid values can be obtained. |
| LoadBalancerDomain | String | No | CLB Domain Name Note: This field may return null, indicating that no valid values can be obtained. |
CLB
Used by actions: DescribeDomainDetailsClb, DescribeDomains.
| Name | Type | Required | Description |
|---|---|---|---|
| ListenerId | String | Yes | Listener ID Note: This field may return null, indicating that no valid values can be obtained. |
| ListenerName | String | Yes | Listening Name Note: This field may return null, indicating that no valid values can be obtained. |
| LoadBalancerId | String | Yes | CLB instance ID Note: This field may return null, indicating that no valid values can be obtained. |
| LoadBalancerName | String | Yes | CLB name Note: This field may return null, indicating that no valid values can be obtained. |
| Protocol | String | Yes | Protocol Note: This field may return null, indicating that no valid values can be obtained. |
| Region | String | Yes | Region "Toronto": "ca", "Guangzhou": "gz", "Chengdu": "cd", "Fuzhou": "fzec", "Shenzhen": "szx", "India": "in", "Jinan": "jnec", "Chongqing": "cq", "Tianjin": "tsn", "Northeast Europe": "ru", "Nanjing": "nj", "Silicon Valley (U.S.)": "usw", "Thailand": "th", "Guangzhou Open": "gzopen", "Shenzhen Finance": "szjr", "Frankfurt": "de", "Japan": "jp", "Virginia": "use", "Beijing": "bj", "Hong Kong (China)": "hk", "Hangzhou": "hzec", "Beijing Finance": "bjjr", "Shanghai Finance": "shjr", "Taipei (China)": "tpe", "Seoul": "kr", "Shanghai": "sh", "Singapore": "sg", "Qingyuan": "qy" Note: This field may return null, indicating that no valid values can be obtained. |
| Vip | String | Yes | Access IP Note: This field may return null, indicating that no valid values can be obtained. |
| Vport | Integer | Yes | Access Port Note: This field may return null, indicating that no valid values can be obtained. |
| Zone | String | Yes | Region Note: This field may return null, indicating that no valid values can be obtained. |
| NumericalVpcId | Integer | Yes | VPCID Note: This field may return null, indicating that no valid values can be obtained. |
| LoadBalancerType | String | Yes | CLB Type Note: This field may return null, indicating that no valid values can be obtained. |
| LoadBalancerDomain | String | No | Domain Name of CLB Note: This field may return null, indicating that no valid values can be obtained. |
Attack Log Statistical Details
Used by actions: GetAttackHistogram.
| Name | Type | Description |
|---|---|---|
| Count | Integer | Number of logs. |
| TimeStamp | Integer | Timestamp. |
Key protection resource information
Used by actions: DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| ResourceIds | String | No | Resource ID Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | No | Status Note: This field may return null, indicating that no valid values can be obtained. |
| Region | Integer | No | Region Note: This field may return null, indicating that no valid values can be obtained. |
| BeginTime | String | No | Start time Note: This field may return null, indicating that no valid values can be obtained. |
| EndTime | String | No | End time Note: This field may return null, indicating that no valid values can be obtained. |
| InquireNum | Integer | No | Application Quantity Note: This field may return null, indicating that no valid values can be obtained. |
| UsedNum | Integer | No | Usage Quantity Note: This field may return null, indicating that no valid values can be obtained. |
| RenewFlag | Integer | No | Renewal flag. Note: This field may return null, indicating that no valid values can be obtained. |
| BillingItem | String | No | Billing item. Note: This field may return null, indicating that no valid values can be obtained. |
| HWState | Integer | No | Protection Package Status Note: This field may return null, indicating that no valid values can be obtained. |
Mobile Mini Programs Security access ID extension resource information.
Used by actions: DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| ResourceIds | String | No | Resource ID Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | No | Status Note: This field may return null, indicating that no valid values can be obtained. |
| Region | Integer | No | Region Note: This field may return null, indicating that no valid values can be obtained. |
| BeginTime | String | No | Start time Note: This field may return null, indicating that no valid values can be obtained. |
| EndTime | String | No | End time Note: This field may return null, indicating that no valid values can be obtained. |
| Count | Integer | No | Purchase quantity. Note: This field may return null, indicating that no valid values can be obtained. |
| RenewFlag | Integer | No | Renewal flag. Note: This field may return null, indicating that no valid values can be obtained. |
| BillingItem | String | No | Billing item. Note: This field may return null, indicating that no valid values can be obtained. |
API security resource information
Used by actions: DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| ResourceIds | String | No | Resource ID Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | No | Status Note: This field may return null, indicating that no valid values can be obtained. |
| Region | Integer | No | Region Note: This field may return null, indicating that no valid values can be obtained. |
| BeginTime | String | No | Start time Note: This field may return null, indicating that no valid values can be obtained. |
| EndTime | String | No | End time Note: This field may return null, indicating that no valid values can be obtained. |
| Count | Integer | No | Purchase quantity. Note: This field may return null, indicating that no valid values can be obtained. |
| RenewFlag | Integer | No | Renewal flag. Note: This field may return null, indicating that no valid values can be obtained. |
| BillingItem | String | No | Billing item. Note: This field may return null, indicating that no valid values can be obtained. |
Owasp rule.
Used by actions: DescribeOwaspRules.
| Name | Type | Description |
|---|---|---|
| RuleId | Integer | Rule ID |
| Description | String | Rule description |
| Status | Integer | Rule switch. valid values: 0 (disabled), 1 (enabled), 2 (observation only). |
| Level | Integer | Protection level of the rule. valid values: 100 (loose), 200 (normal), 300 (strict), 400 (ultra-strict). |
| VulLevel | Integer | Threat level. valid values: 0 (unknown), 100 (low risk), 200 (medium risk), 300 (high risk), 400 (critical). |
| CveID | String | CVE ID |
| TypeId | Integer | Specifies the rule type ID. |
| CreateTime | Timestamp ISO8601 | Creation time |
| ModifyTime | Timestamp ISO8601 | Update time. |
| Locked | Integer | Whether the user is locked. |
| Reason | Integer | Reason for modification 0: none (compatibility records are empty). 1: avoid false positives due to business characteristics. 2: reporting of rule-based false positives. 3: gray release of core business rules. 4: others |
Owasp rule type.
Used by actions: DescribeOwaspRuleTypes.
| Name | Type | Required | Description |
|---|---|---|---|
| TypeId | Integer | Yes | Type ID |
| TypeName | String | Yes | Type name |
| Description | String | No | Type description. |
| Classification | String | No | Data type category. |
| Action | Integer | No | Protection mode of the rule type. valid values: 0 (observation), 1 (intercept). |
| Level | Integer | No | Protection level of the rule type. valid values: 100 (loose), 200 (normal), 300 (strict), 400 (ultra-strict). |
| Status | Integer | No | The switch status of the rule type. valid values: 0 (disabled), 1 (enabled). |
| TotalRule | Integer | No | Specifies all rules under the rule type. always. |
| ActiveRule | Integer | No | Indicates the total number of rules enabled under the rule type. |
Rule engine allowlist.
Used by actions: DescribeOwaspWhiteRules.
| Name | Type | Description |
|---|---|---|
| RuleId | Integer | Rule ID of the allowlist. |
| Name | String | Rule Name |
| Ids | Array of Integer | ID list of allowlisted rules. |
| Status | Integer | Allowlist rule state. valid values: 0 (disabled), 1 (enabled). |
| Type | Integer | Allowlist type. valid values: 0 (allowlisting by specific rule ID), 1 (allowlisting by rule type). |
| Strategies | Array of Strategy | Rule-Based matching policy list. |
| CreateTime | Timestamp ISO8601 | Creation time |
| UpdateTime | Timestamp ISO8601 | Modification time |
| JobType | String | Scheduled task type |
| JobDateTime | JobDateTime | Scheduled task configuration |
| CronType | String | Periodic task granularity. |
| ValidStatus | Boolean | Whether there is currently valid. |
PeakPoints array item
Used by actions: DescribePeakPoints.
| Name | Type | Description |
|---|---|---|
| Time | Integer | Second-level Timestamp |
| Access | Integer | QPS |
| Up | Integer | Upstream bandwidth peak, unit: B |
| Down | Integer | Downstream bandwidth peak, unit: B |
| Attack | Integer | Web attack count |
| Cc | Integer | CC attack count |
| BotAccess | Integer | Bot qps |
| StatusServerError | Integer | Number of 5xx status codes returned by WAF to client Note: This field may return null, indicating that no valid values can be obtained. |
| StatusClientError | Integer | Number of times WAF returned 4xx status codes to client Note: This field may return null, indicating that no valid values can be obtained. |
| StatusRedirect | Integer | WAF Returned to Client Status Code 302 Count Note: This field may return null, indicating that no valid values can be obtained. |
| StatusOk | Integer | Number of Times WAF Returns Status Code 202 to Client Note: This field may return null, indicating that no valid values can be obtained. |
| UpstreamServerError | Integer | Number of Times the Origin Server Returned 5xx Status Codes to WAF Note: This field may return null, indicating that no valid values can be obtained. |
| UpstreamClientError | Integer | Number of times the origin server returned 4xx status codes to WAF Note: This field may return null, indicating that no valid values can be obtained. |
| UpstreamRedirect | Integer | Number of times the original server returns status code 302 to WAF Note: This field may return null, indicating that no valid values can be obtained. |
| BlackIP | Integer | Blocklist Count Note: This field may return null, indicating that no valid values can be obtained. |
| Tamper | Integer | Tamper-Proof Attempts Note: This field may return null, indicating that no valid values can be obtained. |
| Leak | Integer | Information Leakage Prevention Count Note: This field may return null, indicating that no valid values can be obtained. |
| ACL | Integer | Access control Note: This field may return null, indicating that no valid values can be obtained. |
| WxAccess | Integer | Mini Program QPS Note: This field may return null, indicating that no valid values can be obtained. |
| WxCount | Integer | Number of mini program requests Note: This field may return null, indicating that no valid values can be obtained. |
| WxUp | Integer | Peak upstream bandwidth of the mini program. Unit: B Note: This field may return null, indicating that no valid values can be obtained. |
| WxDown | Integer | Peak downstream bandwidth of the mini program. Unit: B Note: This field may return null, indicating that no valid values can be obtained. |
Pie chart data type
Used by actions: DescribeAttackType.
| Name | Type | Description |
|---|---|---|
| Type | String | Type |
| Count | Integer | Quantity |
Service port configuration
Used by actions: DescribeDomainDetailsSaas, DescribeDomains.
| Name | Type | Required | Description |
|---|---|---|---|
| NginxServerId | Integer | Yes | Nginx Server ID |
| Port | String | Yes | Listening Port Configuration |
| Protocol | String | Yes | Protocol Corresponding to the Port |
| UpstreamPort | String | Yes | Origin-pull port |
| UpstreamProtocol | String | Yes | Origin-pull protocol |
Protection domain port configuration information
Used by actions: AddSpartaProtection, DescribeSpartaProtectionInfo.
| Name | Type | Required | Description |
|---|---|---|---|
| Port | String | Yes | Listening Port Configuration |
| Protocol | String | Yes | Corresponds one-to-one with ports, indicating the protocol associated with the port. |
| UpstreamPort | String | Yes | Corresponds one-to-one with port, indicates the origin port |
| UpstreamProtocol | String | Yes | Corresponds one-to-one with Port, indicating the origin protocol |
| NginxServerId | String | Yes | Nginx Server ID |
CLB-WAF QPS package new
Used by actions: DescribeInstances.
| Name | Type | Required | Description |
|---|---|---|---|
| ResourceIds | String | Yes | Resource ID Note: This field may return null, indicating that no valid values can be obtained. |
| ValidTime | String | Yes | Expiration time Note: This field may return null, indicating that no valid values can be obtained. |
| RenewFlag | Integer | Yes | Auto-renewal, 1: Enabled, 0: Disabled Note: This field may return null, indicating that no valid values can be obtained. |
| Count | Integer | Yes | Number of Package Purchases Note: This field may return null, indicating that no valid values can be obtained. |
| Region | String | Yes | Package Purchase Region, currently not used in CLB-WAF Note: This field may return null, indicating that no valid values can be obtained. |
| BillingItem | String | No | Billing item. Note: This field may return null, indicating that no valid values can be obtained. |
Obtain the default value for elastic QPS
Used by actions: GetInstanceQpsLimit.
| Name | Type | Description |
|---|---|---|
| ElasticBillingDefault | Integer | Elastic QPS Default Value Note: This field may return null, indicating that no valid values can be obtained. |
| ElasticBillingMin | Integer | Elastic QPS Minimum Value Note: This field may return null, indicating that no valid values can be obtained. |
| ElasticBillingMax | Integer | Maximum Elastic QPS Note: This field may return null, indicating that no valid values can be obtained. |
| QPSExtendMax | Integer | Maximum QPS for Business Expansion Package Note: This field may return null, indicating that no valid values can be obtained. |
| QPSExtendIntlMax | Integer | Maximum QPS for Overseas Business Expansion Package Note: This field may return null, indicating that no valid values can be obtained. |
User Rule Update Output Rule Subitem
Used by actions: ModifyUserSignatureRule.
| Name | Type | Required | Description |
|---|---|---|---|
| Id | String | Yes | Feature serial number |
| Status | Integer | Yes | Rule switch 0: disabled 1: enabled 2: alarm only |
| Reason | Integer | No | Reason for modification 0: none (Compatibility records are empty.) 1: avoidance of false positives due to business characteristics 2: reporting of rule-based false positives 3: grayscale release of core business rules 4: others |
Return code of the response body
Used by actions: AddCustomRule, AddCustomWhiteRule, DeleteCustomRule, DeleteCustomWhiteRule, DeleteHost, DescribeHostLimit, ModifyCustomRule, ModifyCustomRuleStatus, ModifyCustomWhiteRule, ModifyCustomWhiteRuleStatus, ModifyHostFlowMode, ModifyHostMode, ModifyHostStatus, ModifyWebshellStatus.
| Name | Type | Description |
|---|---|---|
| Code | String | If successful, return a success; if failed, return Cloud API Defined Error Codes |
| Message | String | If successful, return a success; if failed, return the secondary error code of WAF Definition |
Complex Conditions on Access List Query
Used by actions: DescribeHosts.
| Name | Type | Required | Description |
|---|---|---|---|
| ClsStatus | String | No | Log switch |
| Status | String | No | WAF Switch |
| FlowMode | String | No | Traffic mode |
Parameter Wrapping
Used by actions: DescribeSession.
| Name | Type | Description |
|---|---|---|
| Res | Array of SessionItem | Session definition |
Session definition
Used by actions: DescribeSession.
| Name | Type | Description |
|---|---|---|
| Category | String | Type to match |
| KeyOrStartMat | String | Start Mode |
| EndMat | String | End Mode |
| StartOffset | String | Starting Offset |
| EndOffset | String | End Offset |
| Source | String | Data source |
| TsVersion | String | Update Timestamp |
| SessionId | Integer | SessionID Note: This field may return null, indicating that no valid values can be obtained. |
| SessionName | String | Session Name Note: This field may return null, indicating that no valid values can be obtained. |
| SessionInUsed | Boolean | Whether the session is being enabled Note: This field may return null, indicating that no valid values can be obtained. |
| RelatedRuleID | Array of Integer | Session-related CC Rule ID Note: This field may return null, indicating that no valid values can be obtained. |
WAF Sparta - Edit port structure in the protection domain
Used by actions: ModifySpartaProtection.
| Name | Type | Required | Description |
|---|---|---|---|
| NginxServerId | Integer | Yes | nginx Id |
| Port | String | Yes | Port |
| Protocol | String | Yes | Protocol |
| UpstreamPort | String | Yes | Backend port |
| UpstreamProtocol | String | Yes | Backend protocol |
Rule matching criteria structure.
Used by actions: AddCustomRule, AddCustomWhiteRule, CreateOwaspWhiteRule, DescribeCustomRuleList, DescribeCustomWhiteRule, DescribeOwaspWhiteRules, ModifyCustomRule, ModifyCustomWhiteRule, ModifyOwaspWhiteRule.
| Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Field | String | Yes | Specifies the matching field. Different matching fields result in different matching parameters, logical operators, and matching contents. the details are as follows:.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CompareFunc | String | Yes | Specifies the logic symbol. Logical symbols are divided into the following types:. Empty (content is empty). null (not found). Eq (equal to). neq (not equal to). contains (contain). ncontains (do not contain). strprefix (prefix matching). strsuffix (suffix matching). Len_eq (length equals to). Len_gt (length greater than). Len_lt (length less than). ipmatch (belong). ipnmatch (not_in). numgt (value greater than). NumValue smaller than]. Value equal to. numneq (value not equal to). numle (less than or equal to). numge (value is greater than or equal to). geo_in (IP geographic belong). geo_not_in (IP geographic not_in). Specifies different logical operators for matching fields. for details, see the matching field table above. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Content | String | Yes | Specifies the match content. Currently, when the match field is COOKIE (COOKIE), match content is not required. all others are needed. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Arg | String | Yes | Specifies the matching parameter. Configuration parameters are divided into two data types: parameter not supported and support parameters. When the match field is one of the following four, the matching parameter can be entered, otherwise not supported. GET (get parameter value). POST (post parameter value). ARGS_COOKIE (COOKIE parameter value). ARGS_HEADER (HEADER parameter value). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CaseNotSensitive | Integer | No | Case-Sensitive. Case-Insensitive. |
Matching criteria structure for preventing information leakage
Used by actions: AddAntiInfoLeakRules, ModifyAntiInfoLeakRules.
| Name | Type | Required | Description |
|---|---|---|---|
| Field | String | Yes | Matching Criteria, returncode (Response Code), keywords (Keywords), information (Sensitive Information) |
| CompareFunc | String | Yes | Logical operator, fixed value: contains |
| Content | String | Yes | Matching content The following options are available when Field is set to information: idcard (ID card), phone (phone number), and bankcard (bank card). The following options are available when Field is set to returncode: 400 (status code 400), 403 (status code 403), 404 (status code 404), 4xx (other 4xx status codes), 500 (status code 500), 501 (status code 501), 502 (status code 502), 504 (status code 504), and 5xx (other 5xx status codes). When Field is set to keywords, users need to input the matching content themselves. |
TLS encryption suite
Used by actions: DescribeCiphersDetail.
| Name | Type | Description |
|---|---|---|
| VersionId | Integer | TLS version ID Note: This field may return null, indicating that no valid values can be obtained. |
| CipherId | Integer | Encryption Suite ID Note: This field may return null, indicating that no valid values can be obtained. |
| CipherName | String | Cipher suite Note: This field may return null, indicating that no valid values can be obtained. |
TLS information
Used by actions: DescribeTlsVersion.
| Name | Type | Description |
|---|---|---|
| VersionId | Integer | ID of TLSVERSION Note: This field may return null, indicating that no valid values can be obtained. |
| VersionName | String | TLSVERSION's Name Note: This field may return null, indicating that no valid values can be obtained. |
Entity combining instance + domain that requires enabling/disabling API security
Used by actions: ModifyApiAnalyzeStatus.
| Name | Type | Required | Description |
|---|---|---|---|
| InstanceId | String | No | Instance ID |
| Domain | String | No | Domain name |
Rule-based scheduled task data structure
Used by actions: AddCustomRule, AddCustomWhiteRule, CreateIpAccessControl, CreateOwaspWhiteRule, ModifyCustomRule, ModifyCustomWhiteRule, ModifyIpAccessControl, ModifyOwaspWhiteRule.
| Name | Type | Required | Description |
|---|---|---|---|
| StartDateTime | Integer | No | Start timestamp, in seconds. |
| EndDateTime | Integer | No | End timestamp, in seconds. |
SaaS and CLB information
Used by actions: DescribeUserDomainInfo.
| Name | Type | Description |
|---|---|---|
| Appid | Integer | User ID |
| Domain | String | Domain name |
| DomainId | String | Domain ID |
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| Edition | String | WAF type |
| Level | String | Version Note: This field may return null, indicating that no valid values can be obtained. |
| WriteConfig | String | Switch for Specified Domain Access Log Fields Note: This field may return null, indicating that no valid values can be obtained. |
| Cls | Integer | Whether to Write the CLS Switch for the Specified Domain 1: Yes, 0: No Note: This field may return null, indicating that no valid values can be obtained. |
| CloudType | String | Marks if it is hybrid cloud access. Hybrid indicates a hybrid cloud access domain Note: This field may return null, indicating that no valid values can be obtained. |
| AlbType | String | CLB WAF type Note: This field may return null, indicating that no valid values can be obtained. |
| BotStatus | Integer | Bot detection enabling status Note: This field may return null, indicating that no valid values can be obtained. |
| ApiStatus | Integer | API enabling status Note: This field may return null, indicating that no valid values can be obtained. |
VIP information
Used by actions: DescribeVipInfo.
| Name | Type | Description |
|---|---|---|
| Vip | String | Virtual IP Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceId | String | WAF Instance ID Note: This field may return null, indicating that no valid values can be obtained. |
WAF module specifications
Used by actions: DescribeRuleLimit.
| Name | Type | Description |
|---|---|---|
| CC | Integer | Specifications of Custom CC |
| CustomRule | Integer | Specifications for Custom Policy |
| IPControl | Integer | Specifications for Blocklist/Allowlist |
| AntiLeak | Integer | Specifications for Information Leakage Prevention |
| AntiTamper | Integer | Tamper-proof Specifications |
| AutoCC | Integer | Specifications for Urgent CC |
| AreaBan | Integer | Specifications for Region Banning |
| CCSession | Integer | Configure Session in Custom CC |
| AI | Integer | AI Specifications |
| CustomWhite | Integer | Specifications of Precision Allowlist |
| ApiSecurity | Integer | API Security Specification |
| ClientMsg | Integer | Specifications for client traffic flag |
| TrafficMarking | Integer | Specifications for Traffic Tagging |
Domain's Webshell activation status
Used by actions: ModifyWebshellStatus.
| Name | Type | Required | Description |
|---|---|---|---|
| Domain | String | Yes | Domain name |
| Status | Integer | Yes | Webshell Switch, 1: On. 0: Off. 2: Observation |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan