{ "name": "antiddos", "display_name": "T-Sec-DDoS防护(Anti-DDoS)", "description": "DDoS 高防包 API 升级到 3.0 版本。全新的 API 接口文档更加规范和全面，统一的参数风格和公共错误码，统一的 SDK/CLI 版本与 API 文档严格一致，给您带来简单快捷的使用体验。支持全地域就近接入让您更快连接腾讯云产品。 BGP 高防包是针对业务部署在腾讯云内的用户提升 DDoS 防护能力的付费产品。高防包直接对腾讯云上 IP 生效，无需更换 IP，购买后只需绑定需要防护的 IP 即可...", "domain": "security", "api_version": "2020-03-09", "endpoint": "antiddos.tencentcloudapi.com", "actions": [ { "name": "AssociateDDoSEipAddress", "description": "本接口 (AssociateDDoSEipAddress) 用于将高防弹性公网IP绑定到实例或弹性网卡的指定内网 IP 上。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID，实例ID形如：bgpip-0000011x。只能填写高防IP实例。", "example": "bgpip-0000011x" }, { "name": "Eip", "type": "string", "required": true, "description": "资源实例ID对应的高防弹性公网IP。", "example": "1.1.1.1" }, { "name": "CvmInstanceID", "type": "string", "required": true, "description": "要绑定的实例 ID。实例 ID 形如：ins-11112222。可通过登录控制台查询，也可通过 DescribeInstances 接口返回值中的InstanceId获取。", "example": "ins-11112222" }, { "name": "CvmRegion", "type": "string", "required": true, "description": "cvm实例所在地域，例如：ap-hongkong。", "example": "ap-hongkong" } ], "required": [ "InstanceId", "Eip", "CvmInstanceID", "CvmRegion" ] }, { "name": "AssociateDDoSEipLoadBalancer", "description": "本接口 (AssociateDDoSEipLoadBalancer) 用于将高防弹性公网IP绑定到负载均衡指定内网 IP 上。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID，实例ID形如：bgpip-0000011x。只能填写高防IP实例。", "example": "bgpip-0000011x" }, { "name": "Eip", "type": "string", "required": true, "description": "资源实例ID对应的高防弹性公网IP。", "example": "1.1.1.1" }, { "name": "LoadBalancerID", "type": "string", "required": true, "description": "要绑定的负载均衡ID。负载均衡 ID 形如：lb-0000002i。可通过登录控制台查询，也可通过 DescribeLoadBalancers 接口返回值中的LoadBalancerId获取。", "example": "lb-0000002i" }, { "name": "LoadBalancerRegion", "type": "string", "required": true, "description": "CLB所在地域，例如：ap-hongkong。", "example": "ap-hongkong" }, { "name": "Vip", "type": "string", "required": false, "description": "CLB内网IP", "example": "1.1.1.1" } ], "required": [ "InstanceId", "Eip", "LoadBalancerID", "LoadBalancerRegion" ] }, { "name": "CreateBgpInstance", "description": "通过API 购买高防包接口", "status": "online", "parameters": [ { "name": "InstanceChargeType", "type": "string", "required": true, "description": "付费类型：付费模式：PREPAID 预付费 POSTPAID_BY_MONTH 后付费", "example": "PREPAID" }, { "name": "PackageType", "type": "string", "required": true, "description": "高防包类型：高防包类型，Enterprise(企业版) Standard(标准版) StandardPlus(标准版2.0)", "example": "Standard" }, { "name": "InstanceCount", "type": "integer", "required": true, "description": "购买高防包的数量，一次购买数量不超过10", "example": "1" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "{ \"Period\": 3, \"RenewFlag\": \"NOTIFY_AND_AUTO_RENEW\" }", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": false, "description": "购买时长：单位月 注意：此字段可能返回 null，表示取不到有效值。", "example": "12" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 NOTIFY_AND_AUTO_RENEW：到期通知且自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 默认为：通知过期不自动续费 注意：此字段可能返回 null，表示取不到有效值。", "example": "NOTIFY_AND_MANUAL_RENEW" } ] }, { "name": "EnterprisePackageConfig", "type": "object", "required": false, "description": "{ \"Region\": \"ap-guangzhou\", \"ProtectIpCount\": 1, \"BasicProtectBandwidth\": 300, \"Bandwidth\": 100, \"ElasticProtectLimit\": 0, \"ElasticBandwidthFlag\": true }", "example": "无", "children": [ { "name": "Region", "type": "string", "required": true, "description": "购买高防包所属地域", "example": "ap-hongkong" }, { "name": "ProtectIpCount", "type": "integer", "required": true, "description": "防护IP数", "example": "100" }, { "name": "BasicProtectBandwidth", "type": "integer", "required": true, "description": "保底防护带宽", "example": "1000" }, { "name": "Bandwidth", "type": "integer", "required": true, "description": "业务带宽规模", "example": "50" }, { "name": "ElasticProtectBandwidth", "type": "integer", "required": false, "description": "弹性带宽 Gbps，可选择的弹性带宽[0,400,500,600,800,1000] 默认为0", "example": "400" }, { "name": "ElasticBandwidthFlag", "type": "boolean", "required": false, "description": "是否开启弹性业务带宽 默认为false", "example": "true" } ] }, { "name": "StandardPackageConfig", "type": "object", "required": false, "description": "{ \"Region\": \"ap-guangzhou\", \"ProtectIpCount\": 1, \"BasicProtectBandwidth\": 300, \"Bandwidth\": 100, \"ElasticProtectLimit\": 0, \"ElasticBandwidthFlag\": true }", "example": "无", "children": [ { "name": "Region", "type": "string", "required": true, "description": "高防包购买地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-nanjing" }, { "name": "ProtectIpCount", "type": "integer", "required": true, "description": "防护IP数量 注意：此字段可能返回 null，表示取不到有效值。", "example": "100" }, { "name": "Bandwidth", "type": "integer", "required": true, "description": "防护业务带宽 50Mbps 注意：此字段可能返回 null，表示取不到有效值。", "example": "50" }, { "name": "ElasticBandwidthFlag", "type": "boolean", "required": false, "description": "是否开启弹性防护带宽 true 开启 默认为false 不开启 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" } ] }, { "name": "StandardPlusPackageConfig", "type": "object", "required": false, "description": "{ \"Region\": \"ap-guangzhou\", \"ProtectCount\": \"TWO_TIMES\", \"ProtectIpCount\": 1, \"Bandwidth\": 100, \"ElasticBandwidthFlag\": true }", "example": "无", "children": [ { "name": "Region", "type": "string", "required": true, "description": "购买高防包所属地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "sg" }, { "name": "ProtectCount", "type": "string", "required": true, "description": "防护次数：TWO_TIMES:两次全力防 UNLIMITED无限次防 注意：此字段可能返回 null，表示取不到有效值。", "example": "UNLIMITED" }, { "name": "ProtectIpCount", "type": "integer", "required": true, "description": "防护IP数量 注意：此字段可能返回 null，表示取不到有效值。", "example": "11" }, { "name": "Bandwidth", "type": "integer", "required": true, "description": "防护带宽50Mbps 注意：此字段可能返回 null，表示取不到有效值。", "example": "50" }, { "name": "ElasticBandwidthFlag", "type": "boolean", "required": false, "description": "是否开启弹性业务带宽 true 开启 false 不开启 默认不开启 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" } ] }, { "name": "TagInfoList", "type": "array", "required": false, "description": "[ { \"TagKey\": \"beal-test\", \"TagValue\": \"beal-test\" } ]", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键。", "example": "business" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值。", "example": "protection" } ] }, { "name": "DryRun", "type": "boolean", "required": false, "description": "默认为false,true表示只进行参数校验，不进行实际购买", "example": "false" } ], "required": [ "InstanceChargeType", "PackageType", "InstanceCount" ] }, { "name": "CreateBlackWhiteIpList", "description": "添加DDoS防护的IP黑白名单", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-00001001" }, { "name": "IpList", "type": "array", "required": true, "description": "IP列表", "example": "[\"1.1.1.1\\r\\n\"]", "item_type": "string" }, { "name": "Type", "type": "string", "required": true, "description": "IP类型，取值[black(黑名单IP), white(白名单IP)]", "example": "black" } ], "required": [ "InstanceId", "IpList", "Type" ] }, { "name": "CreateBoundIP", "description": "绑定IP到高防包实例，支持独享包、共享包（新版）；需要注意的是此接口绑定或解绑IP是异步接口，当处于绑定或解绑中时，则不允许再进行绑定或解绑，需要等待当前绑定或解绑完成。", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgp表示独享包；bgp-multip表示共享包）", "example": "bgp" }, { "name": "Id", "type": "string", "required": true, "description": "资源实例ID", "example": "bgp-000000x1" }, { "name": "BoundDevList", "type": "array", "required": false, "description": "绑定到资源实例的IP数组，当资源实例为高防包(独享包)时，数组只允许填1个IP；当没有要绑定的IP时可以为空数组；但是BoundDevList和UnBoundDevList至少有一个不为空；", "example": "无", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "IP地址", "example": "1.1.1.1" }, { "name": "BizType", "type": "string", "required": false, "description": "绑定的产品分类，绑定操作为必填项，解绑操作可不填。取值[public（CVM、CLB产品），bm（黑石产品），eni（弹性网卡），vpngw（VPN网关）， natgw（NAT网关），waf（Web应用安全产品），fpc（金融产品），gaap（GAAP产品）, other(托管IP)]", "example": "public" }, { "name": "InstanceId", "type": "string", "required": false, "description": "IP所属的资源实例ID，绑定操作为必填项，解绑操作可不填。例如是弹性网卡的IP，则InstanceId填写弹性网卡的ID(eni-*); 如果绑定的是托管IP没有对应的资源实例ID，请填写\"none\";", "example": "none" }, { "name": "DeviceType", "type": "string", "required": false, "description": "产品分类下的子类型，绑定操作为必填项，解绑操作可不填。取值[cvm（CVM），lb（负载均衡器），eni（弹性网卡），vpngw（VPN），natgw（NAT），waf（WAF），fpc（金融），gaap（GAAP），other（托管IP），eip（弹性公网常规IP）]", "example": "cvm" }, { "name": "IspCode", "type": "integer", "required": false, "description": "运营商，绑定操作为必填项，解绑操作可不填。0：电信；1：联通；2：移动；5：BGP", "example": "5" }, { "name": "Domain", "type": "string", "required": false, "description": "域名化资产对应的域名", "example": "www.abc.com" } ] }, { "name": "UnBoundDevList", "type": "array", "required": false, "description": "与资源实例解绑的IP数组，当资源实例为高防包(独享包)时，数组只允许填1个IP；当没有要解绑的IP时可以为空数组；但是BoundDevList和UnBoundDevList至少有一个不为空；", "example": "无", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "IP地址", "example": "1.1.1.1" }, { "name": "BizType", "type": "string", "required": false, "description": "绑定的产品分类，绑定操作为必填项，解绑操作可不填。取值[public（CVM、CLB产品），bm（黑石产品），eni（弹性网卡），vpngw（VPN网关）， natgw（NAT网关），waf（Web应用安全产品），fpc（金融产品），gaap（GAAP产品）, other(托管IP)]", "example": "public" }, { "name": "InstanceId", "type": "string", "required": false, "description": "IP所属的资源实例ID，绑定操作为必填项，解绑操作可不填。例如是弹性网卡的IP，则InstanceId填写弹性网卡的ID(eni-*); 如果绑定的是托管IP没有对应的资源实例ID，请填写\"none\";", "example": "none" }, { "name": "DeviceType", "type": "string", "required": false, "description": "产品分类下的子类型，绑定操作为必填项，解绑操作可不填。取值[cvm（CVM），lb（负载均衡器），eni（弹性网卡），vpngw（VPN），natgw（NAT），waf（WAF），fpc（金融），gaap（GAAP），other（托管IP），eip（弹性公网常规IP）]", "example": "cvm" }, { "name": "IspCode", "type": "integer", "required": false, "description": "运营商，绑定操作为必填项，解绑操作可不填。0：电信；1：联通；2：移动；5：BGP", "example": "5" }, { "name": "Domain", "type": "string", "required": false, "description": "域名化资产对应的域名", "example": "www.abc.com" } ] }, { "name": "CopyPolicy", "type": "string", "required": false, "description": "已弃用，不填", "example": "yes" }, { "name": "FilterRegion", "type": "string", "required": false, "description": "如果该资源实例为域名化资产以及跨地域绑定则，该参数必填", "example": "ap-guangzhou" } ], "required": [ "Business", "Id" ] }, { "name": "CreateCCPrecisionPolicy", "description": "新增CC精准防护策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "bgpip-0000011x" }, { "name": "Ip", "type": "string", "required": true, "description": "IP值", "example": "1.2.1.3" }, { "name": "Protocol", "type": "string", "required": true, "description": "协议， 可取值http，https，http/https", "example": "http" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "1.acx.com" }, { "name": "PolicyAction", "type": "string", "required": true, "description": "策略方式，可取值alg表示人机校验，drop表示丢弃，trans表示放行", "example": "alg" }, { "name": "PolicyList", "type": "array", "required": true, "description": "策略记录", "example": "无", "item_type": "object", "children": [ { "name": "FieldType", "type": "string", "required": true, "description": "配置项类型，当前仅支持value", "example": "value" }, { "name": "FieldName", "type": "string", "required": true, "description": "配置字段，可取值cgi， ua， cookie， referer， accept, srcip", "example": "srcip" }, { "name": "Value", "type": "string", "required": true, "description": "配置取值", "example": "1.2.3.4" }, { "name": "ValueOperator", "type": "string", "required": true, "description": "配置项值比对方式，可取值equal：相等，not_equal：不相等， include：包含", "example": "equal" } ] } ], "required": [ "InstanceId", "Ip", "Protocol", "Domain", "PolicyAction", "PolicyList" ] }, { "name": "CreateCCReqLimitPolicy", "description": "新增CC频率限制策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "bgpip-00000235" }, { "name": "Ip", "type": "string", "required": true, "description": "IP值", "example": "1.2.1.5" }, { "name": "Protocol", "type": "string", "required": true, "description": "协议，可取值http, https, http/https", "example": "http" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "1.csq.com" }, { "name": "Policy", "type": "object", "required": true, "description": "策略项", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "统计周期，可取值1，10，30，60，单位秒", "example": "1" }, { "name": "RequestNum", "type": "integer", "required": true, "description": "请求数，取值1~20000", "example": "1" }, { "name": "Action", "type": "string", "required": true, "description": "频率限制策略方式，可取值alg表示验证码，drop表示丢弃", "example": "drop" }, { "name": "ExecuteDuration", "type": "integer", "required": true, "description": "频率限制策略时长，可取值1~86400，单位秒", "example": "1" }, { "name": "Mode", "type": "string", "required": true, "description": "策略项比对方式，可取值include表示包含，equal表示等于", "example": "include" }, { "name": "Uri", "type": "string", "required": false, "description": "Uri，三个策略项仅可填其中之一", "example": "www.a.com" }, { "name": "UserAgent", "type": "string", "required": false, "description": "User-Agent，三个策略项仅可填其中之一", "example": "Agent" }, { "name": "Cookie", "type": "string", "required": false, "description": "Cookie，三个策略项仅可填其中之一", "example": "Cookie" } ] }, { "name": "IsGlobal", "type": "integer", "required": false, "description": "是否为兜底频控 0表示不是 1表示是", "example": "1" } ], "required": [ "InstanceId", "Ip", "Protocol", "Domain", "Policy" ] }, { "name": "CreateCcBlackWhiteIpList", "description": "新建CC四层黑白名单", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-00001001" }, { "name": "IpList", "type": "array", "required": true, "description": "IP列表", "example": "无", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "ip地址", "example": "1.1.2.1" }, { "name": "Mask", "type": "integer", "required": true, "description": "ip掩码，如果为32位ip，填0", "example": "0" } ] }, { "name": "Type", "type": "string", "required": true, "description": "IP类型，取值[black(黑名单IP), white(白名单IP)]", "example": "black" }, { "name": "Ip", "type": "string", "required": true, "description": "Ip地址", "example": "1.1.1.1" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "www.xx.com" }, { "name": "Protocol", "type": "string", "required": true, "description": "协议", "example": "http" } ], "required": [ "InstanceId", "IpList", "Type", "Ip", "Domain", "Protocol" ] }, { "name": "CreateCcGeoIPBlockConfig", "description": "新建CC防护的地域封禁配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例id", "example": "bgpip-0000011x" }, { "name": "IP", "type": "string", "required": true, "description": "ip地址", "example": "1.1.1.1" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "www.qq.com" }, { "name": "Protocol", "type": "string", "required": true, "description": "协议类型", "example": "http" }, { "name": "CcGeoIPBlockConfig", "type": "object", "required": true, "description": "CC区域封禁配置", "example": "无", "children": [ { "name": "RegionType", "type": "string", "required": true, "description": "区域类型，取值[ oversea(境外) china(国内) customized(自定义地区) ]", "example": "oversea" }, { "name": "Action", "type": "string", "required": true, "description": "封禁动作，取值[ drop(拦截) alg(人机校验) ]", "example": "drop" }, { "name": "Id", "type": "string", "required": false, "description": "配置ID，配置添加成功后生成；添加新配置时不用填写此字段，修改或删除配置时需要填写配置ID", "example": "ccGeoip-00000111" }, { "name": "AreaList", "type": "array", "required": false, "description": "当RegionType为customized时，必须填写AreaList；当RegionType为china或oversea时，AreaList为空", "example": "100025", "item_type": "integer" } ] } ], "required": [ "InstanceId", "IP", "Domain", "Protocol", "CcGeoIPBlockConfig" ] }, { "name": "CreateDDoSAI", "description": "设置DDoS防护的AI防护开关", "status": "online", "parameters": [ { "name": "InstanceIdList", "type": "array", "required": true, "description": "资源实例ID列表", "example": "[\"bgpip-0000011x\\r\\n\"]", "item_type": "string" }, { "name": "DDoSAI", "type": "string", "required": true, "description": "AI防护开关，取值[ on(开启) off(关闭) ]", "example": "on" } ], "required": [ "InstanceIdList", "DDoSAI" ] }, { "name": "CreateDDoSBlackWhiteIpList", "description": "添加DDoS防护的IP网段黑白名单", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-00001001" }, { "name": "IpList", "type": "array", "required": true, "description": "IP列表", "example": "[{\"Ip\":\"1.1.1.1\\r\\n\", \"Mask\":0}]", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "ip地址", "example": "1.1.2.1" }, { "name": "Mask", "type": "integer", "required": true, "description": "ip掩码，如果为32位ip，填0", "example": "0" } ] }, { "name": "Type", "type": "string", "required": true, "description": "IP类型，取值[black(黑名单IP), white(白名单IP)]", "example": "black" } ], "required": [ "InstanceId", "IpList", "Type" ] }, { "name": "CreateDDoSConnectLimit", "description": "配置DDoS连接抑制选项", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例Id", "example": "bgpip-00000001" }, { "name": "ConnectLimitConfig", "type": "object", "required": true, "description": "连接抑制配置", "example": "无", "children": [ { "name": "SdNewLimit", "type": "integer", "required": true, "description": "基于源IP+目的IP的每秒新建数限制", "example": "1" }, { "name": "DstNewLimit", "type": "integer", "required": true, "description": "基于目的IP的每秒新建数限制", "example": "1" }, { "name": "SdConnLimit", "type": "integer", "required": true, "description": "基于源IP+目的IP的并发连接控制", "example": "1" }, { "name": "DstConnLimit", "type": "integer", "required": true, "description": "基于目的IP+目的端口的并发连接控制", "example": "1" }, { "name": "BadConnThreshold", "type": "integer", "required": true, "description": "基于连接抑制触发阈值，取值范围[0,4294967295]", "example": "1" }, { "name": "NullConnEnable", "type": "integer", "required": true, "description": "异常连接检测条件，空连接防护开关，，取值范围[0,1]", "example": "1" }, { "name": "ConnTimeout", "type": "integer", "required": true, "description": "异常连接检测条件，连接超时，，取值范围[0,65535]", "example": "1" }, { "name": "SynRate", "type": "integer", "required": true, "description": "异常连接检测条件，syn占比ack百分比，，取值范围[0,100]", "example": "1" }, { "name": "SynLimit", "type": "integer", "required": true, "description": "异常连接检测条件，syn阈值，取值范围[0,100]", "example": "1" } ] } ], "required": [ "InstanceId", "ConnectLimitConfig" ] }, { "name": "CreateDDoSGeoIPBlockConfig", "description": "添加DDoS防护的区域封禁配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" }, { "name": "DDoSGeoIPBlockConfig", "type": "object", "required": true, "description": "DDoS区域封禁配置，填写参数时配置ID请为空", "example": "无", "children": [ { "name": "RegionType", "type": "string", "required": true, "description": "区域类型，取值[ oversea(境外) china(国内) customized(自定义地区) ]", "example": "oversea" }, { "name": "Action", "type": "string", "required": true, "description": "封禁动作，取值[ drop(拦截) trans(放行) ]", "example": "drop" }, { "name": "Id", "type": "string", "required": false, "description": "配置ID，配置添加成功后生成；添加新配置时不用填写此字段，修改或删除配置时需要填写配置ID", "example": "0" }, { "name": "AreaList", "type": "array", "required": false, "description": "当RegionType为customized时，必须填写AreaList，且最多填写128个；", "example": "100025", "item_type": "integer" } ] } ], "required": [ "InstanceId", "DDoSGeoIPBlockConfig" ] }, { "name": "CreateDDoSSpeedLimitConfig", "description": "添加DDoS防护的访问限速配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" }, { "name": "DDoSSpeedLimitConfig", "type": "object", "required": true, "description": "访问限速配置，填写参数时配置ID请为空", "example": "无", "children": [ { "name": "Mode", "type": "integer", "required": true, "description": "限速模式，取值[ 1(基于源IP限速) 2(基于目的端口限速) ]", "example": "1" }, { "name": "SpeedValues", "type": "array", "required": true, "description": "限速值，每种类型的限速值最多支持1个；该字段数组至少有一种限速值", "example": "1", "item_type": "object", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "限速值类型，取值[ 1(包速率pps) 2(带宽bps) ]", "example": "1" }, { "name": "Value", "type": "integer", "required": true, "description": "值大小", "example": "1" } ] }, { "name": "DstPortScopes", "type": "array", "required": false, "description": "此字段已弃用，请填写新字段DstPortList。", "example": "DstPortList", "item_type": "object", "children": [ { "name": "BeginPort", "type": "integer", "required": true, "description": "起始端口，取值1~65535", "example": "1" }, { "name": "EndPort", "type": "integer", "required": true, "description": "结束端口，取值1~65535，必须不小于起始端口", "example": "1" } ] }, { "name": "Id", "type": "string", "required": false, "description": "配置ID，配置添加成功后生成；添加新限制配置时不用填写此字段，修改或删除限速配置时需要填写配置ID", "example": "id-xx" }, { "name": "ProtocolList", "type": "string", "required": false, "description": "IP protocol numbers, 取值[ ALL(所有协议) TCP(tcp协议) UDP(udp协议) SMP(smp协议) 1;2-100(自定义协议号范围,最多8个) ] 注意：当自定义协议号范围时，只能填写协议号，多个范围;分隔；当填写ALL时不能再填写其他协议或协议号。", "example": "1.1.1.1" }, { "name": "DstPortList", "type": "string", "required": false, "description": "端口范围列表，最多8个，多个;分隔，范围表示用-；此端口范围必须填写；填写样式1:0-65535，样式2:80;443;1000-2000", "example": "80" } ] } ], "required": [ "InstanceId", "DDoSSpeedLimitConfig" ] }, { "name": "CreateDefaultAlarmThreshold", "description": "设置单IP默认告警阈值配置", "status": "online", "parameters": [ { "name": "DefaultAlarmConfig", "type": "object", "required": true, "description": "默认告警阈值配置", "example": "无", "children": [ { "name": "AlarmType", "type": "integer", "required": false, "description": "告警阈值类型，取值[ 1(入流量告警阈值) 2(攻击清洗流量告警阈值) ]", "example": "1" }, { "name": "AlarmThreshold", "type": "integer", "required": false, "description": "告警阈值，单位Mbps，取值\u003e=0；当作为输入参数时，设置0会删除告警阈值配置；", "example": "10" } ] }, { "name": "InstanceType", "type": "string", "required": true, "description": "产品类型，取值[ bgp(表示高防包产品) bgpip(表示高防IP产品) ]", "example": "bgp" } ], "required": [ "DefaultAlarmConfig", "InstanceType" ] }, { "name": "CreateIPAlarmThresholdConfig", "description": "设置单IP告警阈值配置", "status": "online", "parameters": [ { "name": "IpAlarmThresholdConfigList", "type": "array", "required": true, "description": "IP告警阈值配置列表", "example": "无", "item_type": "object", "children": [ { "name": "AlarmType", "type": "integer", "required": true, "description": "告警阈值类型，取值[ 1(入流量告警阈值) 2(攻击清洗流量告警阈值) ]", "example": "1" }, { "name": "AlarmThreshold", "type": "integer", "required": true, "description": "告警阈值，单位Mbps，取值\u003e=0；当作为输入参数时，设置0会删除告警阈值配置；", "example": "1" }, { "name": "InstanceDetailList", "type": "array", "required": true, "description": "告警阈值所属的资源实例", "example": "bgp-xxx", "item_type": "object", "children": [ { "name": "EipList", "type": "array", "required": true, "description": "资源实例的IP", "example": "[1.1.1.1]", "item_type": "string" }, { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例的ID", "example": "bgpip-0000011x" } ] } ] } ], "required": [ "IpAlarmThresholdConfigList" ] }, { "name": "CreateL7RuleCerts", "description": "批量配置L7转发规则的证书供SSL测调用", "status": "online", "parameters": [ { "name": "CertId", "type": "string", "required": true, "description": "SSL证书ID", "example": "cMgC0TpV" }, { "name": "L7Rules", "type": "array", "required": true, "description": "L7域名转发规则列表", "example": "无", "item_type": "object", "children": [ { "name": "Status", "type": "integer", "required": true, "description": "规则在中间状态不可修改，只可在（0， 2， 8）状态可编辑。 规则状态，0: 正常运行中, 1: 配置规则中(配置生效中), 2: 配置规则失败（配置生效失败）, 3: 删除规则中(删除生效中), 5: 删除规则失败(删除失败), 6: 等待添加规则, 7: 等待删除规则, 8: 等待上传证书, 9: 规则对应的资源不存在，被隔离, 10:等待修改规则, 11:配置修改中", "example": "8" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "www.xxx.com" }, { "name": "Protocol", "type": "string", "required": true, "description": "协议", "example": "https" }, { "name": "InsId", "type": "string", "required": true, "description": "实例ID", "example": "bgpip-000001eo" }, { "name": "AppId", "type": "string", "required": true, "description": "用户AppID", "example": "251008915" }, { "name": "VirtualPort", "type": "string", "required": true, "description": "高防端口", "example": "443" }, { "name": "SSLId", "type": "string", "required": true, "description": "证书ID", "example": "kneSCNrZ" } ] } ], "required": [ "CertId", "L7Rules" ] }, { "name": "CreateNewL7Rules", "description": "添加7层转发规则", "status": "online", "parameters": [ { "name": "Rules", "type": "array", "required": true, "description": "规则列表", "example": "无", "item_type": "object", "children": [ { "name": "KeepTime", "type": "integer", "required": true, "description": "会话保持时间，单位秒", "example": "1" }, { "name": "Domain", "type": "string", "required": true, "description": "转发域名", "example": "www.abc.com" }, { "name": "Protocol", "type": "string", "required": true, "description": "转发协议，取值[http, https]", "example": "80" }, { "name": "SourceType", "type": "integer", "required": true, "description": "回源方式，取值[1(域名回源)，2(IP回源)]", "example": "1" }, { "name": "LbType", "type": "integer", "required": true, "description": "负载均衡方式，取值[1(加权轮询)]", "example": "1" }, { "name": "SourceList", "type": "array", "required": true, "description": "回源列表", "example": "无", "item_type": "object", "children": [ { "name": "Source", "type": "string", "required": true, "description": "回源IP或域名", "example": "source" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重值，取值[0,100]，暂不支持", "example": "100" }, { "name": "Port", "type": "integer", "required": false, "description": "8000 注意：此字段可能返回 null，表示取不到有效值。", "example": "8000" }, { "name": "Backup", "type": "integer", "required": false, "description": "备份源站，1: 备份源站，0: 普通源站", "example": "backup" } ] }, { "name": "KeepEnable", "type": "integer", "required": true, "description": "会话保持开关，取值[0(会话保持关闭)，1(会话保持开启)]", "example": "1" }, { "name": "Status", "type": "integer", "required": false, "description": "规则状态，取值[0(规则配置成功)，1(规则配置生效中)，2(规则配置失败)，3(规则删除生效中)，5(规则删除失败)，6(规则等待配置)，7(规则等待删除)，8(规则待配置证书)]", "example": "1" }, { "name": "RuleId", "type": "string", "required": false, "description": "规则ID，当添加新规则时可以不用填写此字段；当修改或者删除规则时需要填写此字段；", "example": "id-xxx" }, { "name": "CCThreshold", "type": "integer", "required": false, "description": "HTTPS协议的CC防护阈值", "example": "1" }, { "name": "PrivateKey", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书密钥；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)", "example": "key" }, { "name": "CCEnable", "type": "integer", "required": false, "description": "HTTPS协议的CC防护状态，取值[0(关闭), 1(开启)]", "example": "1" }, { "name": "HttpsToHttpEnable", "type": "integer", "required": false, "description": "是否开启Https协议使用Http回源，取值[0(关闭), 1(开启)]，不填写默认是关闭", "example": "1" }, { "name": "CertType", "type": "integer", "required": false, "description": "证书来源，当转发协议为https时必须填，取值[2(腾讯云托管证书)]，当转发协议为http时也可以填0", "example": "1" }, { "name": "Cert", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书内容；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)", "example": "cert" }, { "name": "CCLevel", "type": "string", "required": false, "description": "HTTPS协议的CC防护等级", "example": "1" }, { "name": "RuleName", "type": "string", "required": false, "description": "规则描述", "example": "name" }, { "name": "CCStatus", "type": "integer", "required": false, "description": "cc防护状态，取值[0(关闭), 1(开启)]", "example": "1" }, { "name": "VirtualPort", "type": "integer", "required": false, "description": "接入端口值", "example": "80" }, { "name": "SSLId", "type": "string", "required": false, "description": "当证书来源为腾讯云托管证书时，此字段必须填写托管证书ID", "example": "id-xxx" }, { "name": "Id", "type": "string", "required": false, "description": "同ruleId", "example": "id-xxx" }, { "name": "CCAIEnable", "type": "integer", "required": false, "description": "智能cc开关，取值[0(关闭), 1(开启)]", "example": "1" } ] }, { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgpip表示高防IP）", "example": "bgpip" }, { "name": "IdList", "type": "array", "required": true, "description": "资源ID列表", "example": "[\"bgpip-000001\"]", "item_type": "string" }, { "name": "VipList", "type": "array", "required": true, "description": "资源IP列表", "example": "[\"192.168.1.1\"]", "item_type": "string" } ], "required": [ "Rules", "Business", "IdList", "VipList" ] }, { "name": "CreatePacketFilterConfig", "description": "添加DDoS防护的特征过滤规则", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" }, { "name": "PacketFilterConfig", "type": "object", "required": true, "description": "特征过滤规则", "example": "无", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，取值[tcp udp icmp all]", "example": "tcp" }, { "name": "SportStart", "type": "integer", "required": true, "description": "起始源端口，取值0~65535", "example": "1000" }, { "name": "SportEnd", "type": "integer", "required": true, "description": "结束源端口，取值1~65535，必须大于等于起始源端口", "example": "1001" }, { "name": "DportStart", "type": "integer", "required": true, "description": "起始目的端口，取值0~65535", "example": "1000" }, { "name": "DportEnd", "type": "integer", "required": true, "description": "结束目的端口，取值1~65535，必须大于等于起始目的端口", "example": "1001" }, { "name": "PktlenMin", "type": "integer", "required": true, "description": "最小报文长度，取值1-1500", "example": "300" }, { "name": "PktlenMax", "type": "integer", "required": true, "description": "最大报文长度，取值1-1500，必须大于等于最小报文长度", "example": "500" }, { "name": "Action", "type": "string", "required": true, "description": "动作，取值[ drop(丢弃) transmit(放行) drop_black(丢弃并拉黑) drop_rst(拦截)（已废弃，不支持drop_rst） drop_black_rst(拦截并拉黑)（已废弃，不支持drop_black_rst） forward(继续防护) ]", "example": "drop" }, { "name": "MatchBegin", "type": "string", "required": false, "description": "检测位置，取值[ begin_l3(IP头) begin_l4(TCP/UDP头) begin_l5(T载荷) no_match(不匹配) ]", "example": "begin_l5" }, { "name": "MatchType", "type": "string", "required": false, "description": "检测类型，取值[ sunday(关键字) pcre(正则表达式) （已废弃，仅支持sunday） ]", "example": "sunday" }, { "name": "Str", "type": "string", "required": false, "description": "检测值，关键字符串或正则表达式,取值[ 当检测类型为sunday时，请填写字符串或者16进制字节码，例如\\x313233对应的是字符串\"123\"的16进制字节码; 最多支持63位; ]", "example": "\\x313233" }, { "name": "Depth", "type": "integer", "required": false, "description": "从检测位置开始的检测深度，取值[0,1500]", "example": "500" }, { "name": "Offset", "type": "integer", "required": false, "description": "从检测位置开始的偏移量，取值范围[0,Depth]", "example": "100" }, { "name": "IsNot", "type": "integer", "required": false, "description": "是否包含检测值，取值[ 0(包含) 1(不包含) （已废弃，仅支持0） ]", "example": "0" }, { "name": "MatchLogic", "type": "string", "required": false, "description": "当有第二个检测条件时，与第一检测条件的且或关系，取值[ and(且的关系) （已废弃，仅支持none） none(当没有第二个检测条件时填写此值) ]", "example": "none" }, { "name": "MatchBegin2", "type": "string", "required": false, "description": "（已废弃）", "example": "begin_l5" }, { "name": "MatchType2", "type": "string", "required": false, "description": "（已废弃）", "example": "sunday" }, { "name": "Str2", "type": "string", "required": false, "description": "（已废弃）", "example": "\\x313233" }, { "name": "Depth2", "type": "integer", "required": false, "description": "（已废弃）", "example": "500" }, { "name": "Offset2", "type": "integer", "required": false, "description": "（已废弃）", "example": "200" }, { "name": "IsNot2", "type": "integer", "required": false, "description": "（已废弃）", "example": "0" }, { "name": "Id", "type": "string", "required": false, "description": "特征过滤配置添加成功后自动生成的规则ID，当添加新特征过滤配置时，此字段不用填写；当修改/删除新特征过滤配置时，此字段必填；", "example": "id-xxx" }, { "name": "PktLenGT", "type": "integer", "required": false, "description": "大于报文长度，取值1+", "example": "50" } ] } ], "required": [ "InstanceId", "PacketFilterConfig" ] }, { "name": "CreatePortAclConfig", "description": "添加DDoS防护的端口acl策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-00001001" }, { "name": "AclConfig", "type": "object", "required": true, "description": "端口acl策略", "example": "无", "children": [ { "name": "ForwardProtocol", "type": "string", "required": true, "description": "协议类型, 可取值tcp, udp, all", "example": "tcp" }, { "name": "DPortStart", "type": "integer", "required": true, "description": "目的端口起始，可取值范围0~65535", "example": "0" }, { "name": "DPortEnd", "type": "integer", "required": true, "description": "目的端口结束，可取值范围0~65535", "example": "65535" }, { "name": "SPortStart", "type": "integer", "required": true, "description": "来源端口起始，可取值范围0~65535", "example": "0" }, { "name": "SPortEnd", "type": "integer", "required": true, "description": "来源端口结束，可取值范围0~65535", "example": "65535" }, { "name": "Action", "type": "string", "required": true, "description": "动作，可取值：drop， transmit， forward", "example": "65535" }, { "name": "Priority", "type": "integer", "required": false, "description": "策略优先级，数字越小，级别越高，该规则越靠前匹配，取值1-1000", "example": "10" } ] } ], "required": [ "InstanceId", "AclConfig" ] }, { "name": "CreatePortAclConfigList", "description": "批量添加DDoS防护的端口acl策略", "status": "online", "parameters": [ { "name": "InstanceIdList", "type": "array", "required": true, "description": "资源实例ID列表", "example": "[\"bgpip-00001001\"]", "item_type": "string" }, { "name": "AclConfig", "type": "object", "required": true, "description": "端口acl策略", "example": "无", "children": [ { "name": "ForwardProtocol", "type": "string", "required": true, "description": "协议类型, 可取值tcp, udp, all", "example": "tcp" }, { "name": "DPortStart", "type": "integer", "required": true, "description": "目的端口起始，可取值范围0~65535", "example": "0" }, { "name": "DPortEnd", "type": "integer", "required": true, "description": "目的端口结束，可取值范围0~65535", "example": "65535" }, { "name": "SPortStart", "type": "integer", "required": true, "description": "来源端口起始，可取值范围0~65535", "example": "0" }, { "name": "SPortEnd", "type": "integer", "required": true, "description": "来源端口结束，可取值范围0~65535", "example": "65535" }, { "name": "Action", "type": "string", "required": true, "description": "动作，可取值：drop， transmit， forward", "example": "65535" }, { "name": "Priority", "type": "integer", "required": false, "description": "策略优先级，数字越小，级别越高，该规则越靠前匹配，取值1-1000", "example": "10" } ] } ], "required": [ "InstanceIdList", "AclConfig" ] }, { "name": "CreateProtocolBlockConfig", "description": "设置DDoS防护的协议封禁配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" }, { "name": "ProtocolBlockConfig", "type": "object", "required": true, "description": "协议封禁配置", "example": "无", "children": [ { "name": "DropTcp", "type": "integer", "required": true, "description": "TCP封禁，取值[0(封禁关)，1(封禁开)]", "example": "1" }, { "name": "DropUdp", "type": "integer", "required": true, "description": "UDP封禁，取值[0(封禁关)，1(封禁开)]", "example": "1" }, { "name": "DropIcmp", "type": "integer", "required": true, "description": "ICMP封禁，取值[0(封禁关)，1(封禁开)]", "example": "1" }, { "name": "DropOther", "type": "integer", "required": true, "description": "其他协议封禁，取值[0(封禁关)，1(封禁开)]", "example": "1" }, { "name": "CheckExceptNullConnect", "type": "integer", "required": true, "description": "异常空连接防护，取值[0(防护关)，1(防护开)]", "example": "1" }, { "name": "PingOfDeath", "type": "integer", "required": false, "description": "ping of death防护，取值[0(防护关)，1(防护开)]", "example": "1" }, { "name": "TearDrop", "type": "integer", "required": false, "description": "tear drop防护，取值[0(防护关)，1(防护开)]", "example": "1" } ] } ], "required": [ "InstanceId", "ProtocolBlockConfig" ] }, { "name": "CreateSchedulingDomain", "description": "创建一个域名，可用于在封堵时调度切换IP", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": false, "description": "代表是否混合云本地化的产品。 hybrid: 宙斯盾本地化 不填写：其他", "example": "hybrid" } ], "required": [] }, { "name": "CreateWaterPrintConfig", "description": "添加DDoS防护的水印防护配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" }, { "name": "WaterPrintConfig", "type": "object", "required": true, "description": "水印防护配置", "example": "无", "children": [ { "name": "Offset", "type": "integer", "required": true, "description": "水印偏移量，取值范围[0, 100)", "example": "0" }, { "name": "OpenStatus", "type": "integer", "required": true, "description": "是否开启，取值[ 0（手动开启） 1（立即运行） ]", "example": "0" }, { "name": "Listeners", "type": "array", "required": true, "description": "水印所属的转发监听器列表", "example": "[{80,TCP}]", "item_type": "object", "children": [ { "name": "FrontendPort", "type": "integer", "required": true, "description": "转发监听端口下限，取值1~65535", "example": "80" }, { "name": "ForwardProtocol", "type": "string", "required": true, "description": "转发协议，取值[ TCP UDP ]", "example": "TCP" }, { "name": "FrontendPortEnd", "type": "integer", "required": false, "description": "转发监听端口上限，取值1~65535", "example": "8080" } ] }, { "name": "Keys", "type": "array", "required": false, "description": "水印添加成功后生成的水印密钥列表，一条水印最少1个密钥，最多2个密钥", "example": "[\"key\"]", "item_type": "object", "children": [ { "name": "KeyVersion", "type": "string", "required": true, "description": "密钥版本号", "example": "1" }, { "name": "KeyContent", "type": "string", "required": true, "description": "密钥内容", "example": "0090-12301-1212" }, { "name": "KeyId", "type": "string", "required": true, "description": "密钥ID", "example": "id-xxx" }, { "name": "KeyOpenStatus", "type": "integer", "required": true, "description": "密钥启用状态，只有一个取值1(启用)", "example": "1" }, { "name": "CreateTime", "type": "string", "required": true, "description": "密钥生成时间", "example": "2024.10.1" } ] }, { "name": "Verify", "type": "string", "required": false, "description": "水印检查模式, 取值[ checkall（普通模式） shortfpcheckall（精简模式） ]", "example": "checkall" }, { "name": "CloudSdkProxy", "type": "integer", "required": false, "description": "是否开启代理，1开启则忽略IP+端口校验；0关闭则需要IP+端口校验", "example": "1" } ] } ], "required": [ "InstanceId", "WaterPrintConfig" ] }, { "name": "CreateWaterPrintKey", "description": "添加DDoS防护的水印防护密钥", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" } ], "required": [ "InstanceId" ] }, { "name": "DeleteCCLevelPolicy", "description": "删除CC分级策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "bgpip-0000011x" }, { "name": "Ip", "type": "string", "required": true, "description": "配置策略的IP", "example": "1.1.1.3" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "test.com" }, { "name": "Protocol", "type": "string", "required": true, "description": "协议，可取值http", "example": "http" } ], "required": [ "InstanceId", "Ip", "Domain", "Protocol" ] }, { "name": "DeleteCCPrecisionPolicy", "description": "删除CC精准防护策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "bgpip-0000011x" }, { "name": "PolicyId", "type": "string", "required": true, "description": "策略Id", "example": "ccPrecs-00000324" } ], "required": [ "InstanceId", "PolicyId" ] }, { "name": "DeleteCCRequestLimitPolicy", "description": "删除CC频率限制策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "bgpip-0000023c" }, { "name": "PolicyId", "type": "string", "required": true, "description": "策略Id", "example": "ccRule-00000435" } ], "required": [ "InstanceId", "PolicyId" ] }, { "name": "DeleteCCThresholdPolicy", "description": "删除CC清洗阈值策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "bgpip-0000011x" }, { "name": "Ip", "type": "string", "required": true, "description": "配置策略的IP", "example": "1.1.1.3" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "test.com" }, { "name": "Protocol", "type": "string", "required": true, "description": "协议，可取值http", "example": "http" } ], "required": [ "InstanceId", "Ip", "Domain", "Protocol" ] }, { "name": "DeleteCcBlackWhiteIpList", "description": "删除CC四层黑白名单", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" }, { "name": "PolicyId", "type": "string", "required": true, "description": "策略Id", "example": "ccBlackWhite-00000312" } ], "required": [ "InstanceId", "PolicyId" ] }, { "name": "DeleteCcGeoIPBlockConfig", "description": "删除CC防护的区域封禁配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" }, { "name": "CcGeoIPBlockConfig", "type": "object", "required": true, "description": "CC区域封禁配置，填写参数时配置ID不能为空", "example": "无", "children": [ { "name": "RegionType", "type": "string", "required": true, "description": "区域类型，取值[ oversea(境外) china(国内) customized(自定义地区) ]", "example": "oversea" }, { "name": "Action", "type": "string", "required": true, "description": "封禁动作，取值[ drop(拦截) alg(人机校验) ]", "example": "drop" }, { "name": "Id", "type": "string", "required": false, "description": "配置ID，配置添加成功后生成；添加新配置时不用填写此字段，修改或删除配置时需要填写配置ID", "example": "ccGeoip-00000111" }, { "name": "AreaList", "type": "array", "required": false, "description": "当RegionType为customized时，必须填写AreaList；当RegionType为china或oversea时，AreaList为空", "example": "100025", "item_type": "integer" } ] } ], "required": [ "InstanceId", "CcGeoIPBlockConfig" ] }, { "name": "DeleteDDoSBlackWhiteIpList", "description": "删除DDoS防护的IP网段黑白名单", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-00001001" }, { "name": "IpList", "type": "array", "required": true, "description": "IP列表", "example": "[{\"ip\":\"1.1.1.1\",\"Mask\":0}]", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "ip地址", "example": "1.1.2.1" }, { "name": "Mask", "type": "integer", "required": true, "description": "ip掩码，如果为32位ip，填0", "example": "0" } ] }, { "name": "Type", "type": "string", "required": true, "description": "IP类型，取值[black(黑名单IP), white(白名单IP)]", "example": "black" } ], "required": [ "InstanceId", "IpList", "Type" ] }, { "name": "DeleteDDoSGeoIPBlockConfig", "description": "删除DDoS防护的区域封禁配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" }, { "name": "DDoSGeoIPBlockConfig", "type": "object", "required": true, "description": "DDoS区域封禁配置，填写参数时配置ID不能为空", "example": "无", "children": [ { "name": "RegionType", "type": "string", "required": true, "description": "区域类型，取值[ oversea(境外) china(国内) customized(自定义地区) ]", "example": "oversea" }, { "name": "Action", "type": "string", "required": true, "description": "封禁动作，取值[ drop(拦截) trans(放行) ]", "example": "drop" }, { "name": "Id", "type": "string", "required": false, "description": "配置ID，配置添加成功后生成；添加新配置时不用填写此字段，修改或删除配置时需要填写配置ID", "example": "0" }, { "name": "AreaList", "type": "array", "required": false, "description": "当RegionType为customized时，必须填写AreaList，且最多填写128个；", "example": "100025", "item_type": "integer" } ] } ], "required": [ "InstanceId", "DDoSGeoIPBlockConfig" ] }, { "name": "DeleteDDoSSpeedLimitConfig", "description": "删除DDoS防护的访问限速配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" }, { "name": "DDoSSpeedLimitConfig", "type": "object", "required": true, "description": "访问限速配置，填写参数时配置ID不能为空", "example": "无", "children": [ { "name": "Mode", "type": "integer", "required": true, "description": "限速模式，取值[ 1(基于源IP限速) 2(基于目的端口限速) ]", "example": "1" }, { "name": "SpeedValues", "type": "array", "required": true, "description": "限速值，每种类型的限速值最多支持1个；该字段数组至少有一种限速值", "example": "1", "item_type": "object", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "限速值类型，取值[ 1(包速率pps) 2(带宽bps) ]", "example": "1" }, { "name": "Value", "type": "integer", "required": true, "description": "值大小", "example": "1" } ] }, { "name": "DstPortScopes", "type": "array", "required": false, "description": "此字段已弃用，请填写新字段DstPortList。", "example": "DstPortList", "item_type": "object", "children": [ { "name": "BeginPort", "type": "integer", "required": true, "description": "起始端口，取值1~65535", "example": "1" }, { "name": "EndPort", "type": "integer", "required": true, "description": "结束端口，取值1~65535，必须不小于起始端口", "example": "1" } ] }, { "name": "Id", "type": "string", "required": false, "description": "配置ID，配置添加成功后生成；添加新限制配置时不用填写此字段，修改或删除限速配置时需要填写配置ID", "example": "id-xx" }, { "name": "ProtocolList", "type": "string", "required": false, "description": "IP protocol numbers, 取值[ ALL(所有协议) TCP(tcp协议) UDP(udp协议) SMP(smp协议) 1;2-100(自定义协议号范围,最多8个) ] 注意：当自定义协议号范围时，只能填写协议号，多个范围;分隔；当填写ALL时不能再填写其他协议或协议号。", "example": "1.1.1.1" }, { "name": "DstPortList", "type": "string", "required": false, "description": "端口范围列表，最多8个，多个;分隔，范围表示用-；此端口范围必须填写；填写样式1:0-65535，样式2:80;443;1000-2000", "example": "80" } ] } ], "required": [ "InstanceId", "DDoSSpeedLimitConfig" ] }, { "name": "DeletePacketFilterConfig", "description": "删除DDoS防护的特征过滤规则", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" }, { "name": "PacketFilterConfig", "type": "object", "required": true, "description": "特征过滤配置", "example": "无", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，取值[tcp udp icmp all]", "example": "tcp" }, { "name": "SportStart", "type": "integer", "required": true, "description": "起始源端口，取值0~65535", "example": "1000" }, { "name": "SportEnd", "type": "integer", "required": true, "description": "结束源端口，取值1~65535，必须大于等于起始源端口", "example": "1001" }, { "name": "DportStart", "type": "integer", "required": true, "description": "起始目的端口，取值0~65535", "example": "1000" }, { "name": "DportEnd", "type": "integer", "required": true, "description": "结束目的端口，取值1~65535，必须大于等于起始目的端口", "example": "1001" }, { "name": "PktlenMin", "type": "integer", "required": true, "description": "最小报文长度，取值1-1500", "example": "300" }, { "name": "PktlenMax", "type": "integer", "required": true, "description": "最大报文长度，取值1-1500，必须大于等于最小报文长度", "example": "500" }, { "name": "Action", "type": "string", "required": true, "description": "动作，取值[ drop(丢弃) transmit(放行) drop_black(丢弃并拉黑) drop_rst(拦截)（已废弃，不支持drop_rst） drop_black_rst(拦截并拉黑)（已废弃，不支持drop_black_rst） forward(继续防护) ]", "example": "drop" }, { "name": "MatchBegin", "type": "string", "required": false, "description": "检测位置，取值[ begin_l3(IP头) begin_l4(TCP/UDP头) begin_l5(T载荷) no_match(不匹配) ]", "example": "begin_l5" }, { "name": "MatchType", "type": "string", "required": false, "description": "检测类型，取值[ sunday(关键字) pcre(正则表达式) （已废弃，仅支持sunday） ]", "example": "sunday" }, { "name": "Str", "type": "string", "required": false, "description": "检测值，关键字符串或正则表达式,取值[ 当检测类型为sunday时，请填写字符串或者16进制字节码，例如\\x313233对应的是字符串\"123\"的16进制字节码; 最多支持63位; ]", "example": "\\x313233" }, { "name": "Depth", "type": "integer", "required": false, "description": "从检测位置开始的检测深度，取值[0,1500]", "example": "500" }, { "name": "Offset", "type": "integer", "required": false, "description": "从检测位置开始的偏移量，取值范围[0,Depth]", "example": "100" }, { "name": "IsNot", "type": "integer", "required": false, "description": "是否包含检测值，取值[ 0(包含) 1(不包含) （已废弃，仅支持0） ]", "example": "0" }, { "name": "MatchLogic", "type": "string", "required": false, "description": "当有第二个检测条件时，与第一检测条件的且或关系，取值[ and(且的关系) （已废弃，仅支持none） none(当没有第二个检测条件时填写此值) ]", "example": "none" }, { "name": "MatchBegin2", "type": "string", "required": false, "description": "（已废弃）", "example": "begin_l5" }, { "name": "MatchType2", "type": "string", "required": false, "description": "（已废弃）", "example": "sunday" }, { "name": "Str2", "type": "string", "required": false, "description": "（已废弃）", "example": "\\x313233" }, { "name": "Depth2", "type": "integer", "required": false, "description": "（已废弃）", "example": "500" }, { "name": "Offset2", "type": "integer", "required": false, "description": "（已废弃）", "example": "200" }, { "name": "IsNot2", "type": "integer", "required": false, "description": "（已废弃）", "example": "0" }, { "name": "Id", "type": "string", "required": false, "description": "特征过滤配置添加成功后自动生成的规则ID，当添加新特征过滤配置时，此字段不用填写；当修改/删除新特征过滤配置时，此字段必填；", "example": "id-xxx" }, { "name": "PktLenGT", "type": "integer", "required": false, "description": "大于报文长度，取值1+", "example": "50" } ] } ], "required": [ "InstanceId", "PacketFilterConfig" ] }, { "name": "DeletePortAclConfig", "description": "删除DDoS防护的端口acl策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-00001001" }, { "name": "AclConfig", "type": "object", "required": true, "description": "端口acl策略", "example": "无", "children": [ { "name": "ForwardProtocol", "type": "string", "required": true, "description": "协议类型, 可取值tcp, udp, all", "example": "tcp" }, { "name": "DPortStart", "type": "integer", "required": true, "description": "目的端口起始，可取值范围0~65535", "example": "0" }, { "name": "DPortEnd", "type": "integer", "required": true, "description": "目的端口结束，可取值范围0~65535", "example": "65535" }, { "name": "SPortStart", "type": "integer", "required": true, "description": "来源端口起始，可取值范围0~65535", "example": "0" }, { "name": "SPortEnd", "type": "integer", "required": true, "description": "来源端口结束，可取值范围0~65535", "example": "65535" }, { "name": "Action", "type": "string", "required": true, "description": "动作，可取值：drop， transmit， forward", "example": "65535" }, { "name": "Priority", "type": "integer", "required": false, "description": "策略优先级，数字越小，级别越高，该规则越靠前匹配，取值1-1000", "example": "10" } ] } ], "required": [ "InstanceId", "AclConfig" ] }, { "name": "DeleteWaterPrintConfig", "description": "删除DDoS防护的水印防护配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" } ], "required": [ "InstanceId" ] }, { "name": "DeleteWaterPrintKey", "description": "删除DDoS防护的水印防护密钥", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" }, { "name": "KeyId", "type": "string", "required": true, "description": "水印密钥ID", "example": "000000f8" } ], "required": [ "InstanceId", "KeyId" ] }, { "name": "DescribeBGPIPL7Rules", "description": "高防IP获取7层规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgpip表示高防IP）", "example": "bgpip" }, { "name": "StatusList", "type": "array", "required": false, "description": "状态搜索，选填，取值[0(规则配置成功)，1(规则配置生效中)，2(规则配置失败)，3(规则删除生效中)，5(规则删除失败)，6(规则等待配置)，7(规则等待删除)，8(规则待配置证书)]", "example": "creat", "item_type": "integer" }, { "name": "Domain", "type": "string", "required": false, "description": "域名搜索，选填，当需要搜索域名请填写", "example": "www.xxx.com" }, { "name": "Ip", "type": "string", "required": false, "description": "IP搜索，选填，当需要搜索IP请填写", "example": "1.1.1.1" }, { "name": "Limit", "type": "integer", "required": false, "description": "一页条数，默认值100，最大值100，超过100最大返回100条", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "规则偏移量，取值为(页码-1)*一页条数", "example": "1" }, { "name": "ProtocolList", "type": "array", "required": false, "description": "转发协议搜索，选填，取值[http, https, http/https]", "example": "http", "item_type": "string" }, { "name": "Cname", "type": "string", "required": false, "description": "高防IP实例的Cname", "example": "abcdefg" }, { "name": "Export", "type": "boolean", "required": false, "description": "默认为false，当为true时，将不对各个规则做策略检查，直接导出所有规则", "example": "false" }, { "name": "Source", "type": "string", "required": false, "description": "源站，模糊查询", "example": "1.1.1.1:80" } ], "required": [ "Business" ] }, { "name": "DescribeBasicDeviceStatus", "description": "获取基础防护攻击状态", "status": "online", "parameters": [ { "name": "IpList", "type": "array", "required": false, "description": "IP 资源列表", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "IdList", "type": "array", "required": false, "description": "域名化资源传id", "example": "id-xx", "item_type": "string" }, { "name": "FilterRegion", "type": "integer", "required": false, "description": "地域名称", "example": "guangzhou " }, { "name": "CnameWafIdList", "type": "array", "required": false, "description": "cnameWaf资源", "example": "id-xxx", "item_type": "string" } ], "required": [] }, { "name": "DescribeBgpBizTrend", "description": "获取高防包流量折线图", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgp-multip表示高防包）", "example": "bgp-multip" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间。 例：“2020-09-22 00:00:00”，注意该时间必须为5分钟的倍数", "example": "2020-09-22 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间。 例：“2020-09-22 00:00:00”，注意该时间必须为5分钟的倍数", "example": "2020-09-22 00:00:00" }, { "name": "MetricName", "type": "string", "required": true, "description": "统计维度，可取值intraffic, outtraffic, inpkg, outpkg； intraffic：入流量 outtraffic：出流量 inpkg：入包速率 outpkg：出包速率", "example": "outtraffic" }, { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgp-xxxxxxxx" }, { "name": "Flag", "type": "integer", "required": true, "description": "0表示固定时间，1表示自定义时间", "example": "1" } ], "required": [ "Business", "StartTime", "EndTime", "MetricName", "InstanceId", "Flag" ] }, { "name": "DescribeBgpInstances", "description": "购买后，查询购买的高防包实例信息", "status": "online", "parameters": [ { "name": "FilterRegion", "type": "string", "required": true, "description": "地域", "example": "ap-guangzhou" }, { "name": "FilterInstanceIdList", "type": "array", "required": false, "description": "[\"bgp-0000041i\"]", "example": "[\"bgp-000004rq\"]", "item_type": "string" }, { "name": "FilterTag", "type": "array", "required": false, "description": "[{}]", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键。", "example": "business" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值。", "example": "protection" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "分页数量", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" } ], "required": [ "FilterRegion" ] }, { "name": "DescribeBizHttpStatus", "description": "获取业务流量状态码统计列表", "status": "online", "parameters": [ { "name": "Statistics", "type": "string", "required": true, "description": "统计方式，仅支持sum", "example": "sum" }, { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgpip表示高防IP）", "example": "bgpip" }, { "name": "Period", "type": "integer", "required": true, "description": "统计周期，可取值60，300，1800，3600， 21600，86400，单位秒", "example": "300" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间。 如2020-02-01 12:04:12", "example": "2020-02-01 12:04:12" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间。如2020-02-03 18:03:23", "example": "2020-02-03 18:03:23" }, { "name": "Id", "type": "string", "required": true, "description": "资源Id", "example": "bgpip-000000xe" }, { "name": "Domain", "type": "string", "required": false, "description": "特定域名查询", "example": "www.xx.com" }, { "name": "ProtoInfo", "type": "array", "required": false, "description": "协议及端口列表，协议可取值TCP, UDP, HTTP, HTTPS，仅统计纬度为连接数时有效", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议（tcp；udp）", "example": "tcp" }, { "name": "Port", "type": "integer", "required": true, "description": "端口", "example": "80" } ] } ], "required": [ "Statistics", "Business", "Period", "StartTime", "EndTime", "Id" ] }, { "name": "DescribeBizMonitorTrend", "description": "获取高防IP业务监控流量曲线", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgpip表示高防IP）", "example": "bgpip" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间。 例：“2020-09-22 00:00:00”", "example": "2020-09-22 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间。 例：“2020-09-22 00:00:00”", "example": "2020-09-22 00:00:00" }, { "name": "Id", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-00000" }, { "name": "MetricName", "type": "string", "required": true, "description": "统计纬度，可取值intraffic outtraffic inpkg outpkg", "example": "inpkg" }, { "name": "Period", "type": "integer", "required": true, "description": "时间粒度 60 300 3600 21600 86400", "example": "60" } ], "required": [ "Business", "StartTime", "EndTime", "Id", "MetricName", "Period" ] }, { "name": "DescribeBizTrend", "description": "获取业务流量曲线", "status": "online", "parameters": [ { "name": "Statistics", "type": "string", "required": true, "description": "统计方式，可取值max, min, avg, sum, 如统计纬度是流量速率或包量速率，仅可取值max", "example": "max" }, { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgpip表示高防IP）", "example": "bgp" }, { "name": "Period", "type": "integer", "required": true, "description": "统计周期，可取值60，300，1800，3600，21600，86400，单位秒", "example": "1" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间。 例：“2020-09-22 00:00:00”", "example": "2020-09-22 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间。 例：“2020-09-22 00:00:00”", "example": "2020-09-22 00:00:00" }, { "name": "Id", "type": "string", "required": true, "description": "资源实例ID", "example": "bgp-0000" }, { "name": "MetricName", "type": "string", "required": true, "description": "统计纬度，可取值connum, new_conn, inactive_conn, intraffic, outtraffic, inpkg, outpkg, qps", "example": "intraffic" }, { "name": "Domain", "type": "string", "required": false, "description": "统计纬度为qps时，可选特定域名查询", "example": "test.tencentddos.com" }, { "name": "ProtoInfo", "type": "array", "required": false, "description": "协议及端口列表，协议可取值TCP, UDP, HTTP, HTTPS，仅统计纬度为连接数时有效", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议（tcp；udp）", "example": "tcp" }, { "name": "Port", "type": "integer", "required": true, "description": "端口", "example": "80" } ] }, { "name": "BusinessType", "type": "string", "required": false, "description": "业务类型： port：端口业务 domain：域名业务", "example": "domain" } ], "required": [ "Statistics", "Business", "Period", "StartTime", "EndTime", "Id", "MetricName" ] }, { "name": "DescribeCCLevelList", "description": "获取边界防护CC防护等级列表", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgp-multip表示高防包）", "example": "bgp-multip" }, { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数", "example": "1" }, { "name": "InstanceId", "type": "string", "required": false, "description": "指定实例Id", "example": "bgp-xxxx" } ], "required": [ "Business", "Offset", "Limit" ] }, { "name": "DescribeCCLevelPolicy", "description": "获取CC分级策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "bgpip-0000011x" }, { "name": "Ip", "type": "string", "required": true, "description": "IP值", "example": "1.3.2.5" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "1.sca.com" }, { "name": "Protocol", "type": "string", "required": true, "description": "协议，可取值http、https、http/https", "example": "http" } ], "required": [ "InstanceId", "Ip", "Domain", "Protocol" ] }, { "name": "DescribeCCPrecisionPlyList", "description": "获取CC精准防护列表", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgpip-multip：表示高防包；bgpip：表示高防IP）", "example": "bgp-multip" }, { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数", "example": "1" }, { "name": "InstanceId", "type": "string", "required": false, "description": "指定特定实例Id", "example": "bgp-xxxx" }, { "name": "Ip", "type": "string", "required": false, "description": "IP地址，普通高防IP要传该字段", "example": "1.1.1.1" }, { "name": "Domain", "type": "string", "required": false, "description": "域名，普通高防IP要传该字段", "example": "www.qq.com" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议，普通高防IP要传该字段", "example": "http" } ], "required": [ "Business", "Offset", "Limit" ] }, { "name": "DescribeCCReqLimitPolicyList", "description": "获取CC频率限制策略列表", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgp-multip表示高防包，bgpip表示高防IP）", "example": "bgp-multip" }, { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数", "example": "1" }, { "name": "InstanceId", "type": "string", "required": false, "description": "指定实例Id", "example": "id-xxx" }, { "name": "Ip", "type": "string", "required": false, "description": "IP地址，普通高防IP要传该字段", "example": "1.1.1.1" }, { "name": "Domain", "type": "string", "required": false, "description": "域名，普通高防IP要传该字段", "example": "www.xx.com" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议，普通高防IP要传该字段", "example": "http" } ], "required": [ "Business", "Offset", "Limit" ] }, { "name": "DescribeCCThresholdList", "description": "获取CC清洗阈值列表", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgp-multip表示高防包）", "example": "bgp-multip" }, { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数", "example": "1" }, { "name": "InstanceId", "type": "string", "required": false, "description": "指定实例Id", "example": "ins-xxx" } ], "required": [ "Business", "Offset", "Limit" ] }, { "name": "DescribeCCTrend", "description": "获取CC攻击指标数据，包括总请求峰值(QPS)和攻击请求(QPS)以及总请求次数和攻击请求次数", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版；basic表示DDoS基础防护）", "example": "bgp" }, { "name": "Ip", "type": "string", "required": true, "description": "资源的IP", "example": "1.1.1.1" }, { "name": "Period", "type": "integer", "required": true, "description": "统计粒度，取值[300(5分钟)，3600(小时)，86400(天)]", "example": "3600" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间", "example": "2018-08-2715:05:10" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间", "example": "2018-08-2716:05:10" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标，取值[inqps(总请求峰值，dropqps(攻击请求峰值))，incount(请求次数), dropcount(攻击次数)]", "example": "inqps" }, { "name": "Domain", "type": "string", "required": false, "description": "域名，可选", "example": "www.xx.com" }, { "name": "Id", "type": "string", "required": false, "description": "资源实例ID，当Business为basic时，此字段不用填写（因为基础防护没有资源实例）", "example": "bgp-00000010" } ], "required": [ "Business", "Ip", "Period", "StartTime", "EndTime", "MetricName" ] }, { "name": "DescribeCcBlackWhiteIpList", "description": "获取CC四层黑白名单列表", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgp-multip：表示高防包；bgpip：表示高防IP）", "example": "bgp-multip" }, { "name": "InstanceId", "type": "string", "required": true, "description": "指定特定实例Id", "example": "bgpip-0000011x" }, { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数", "example": "1" }, { "name": "Ip", "type": "string", "required": false, "description": "IP地址，普通高防IP要传该字段", "example": "1.1.1.1" }, { "name": "Domain", "type": "string", "required": false, "description": "域名，普通高防IP要传该字段", "example": "www.xx.com" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议，普通高防IP要传该字段", "example": "http" }, { "name": "FilterIp", "type": "string", "required": false, "description": "筛选IP，需要筛选黑白名单IP时传该字段", "example": "1.1.1.1" }, { "name": "FilterType", "type": "string", "required": false, "description": "黑白名单筛选字段，需要筛选黑白名单列表时传该字段", "example": "black" } ], "required": [ "Business", "InstanceId", "Offset", "Limit" ] }, { "name": "DescribeCcGeoIPBlockConfigList", "description": "获取CC防护的区域封禁配置列表", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgp-multip：表示高防包；bgpip：表示高防IP）", "example": "bgp-multip" }, { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数", "example": "1" }, { "name": "InstanceId", "type": "string", "required": false, "description": "指定特定实例ID", "example": "bgpip-0000011x" }, { "name": "Ip", "type": "string", "required": false, "description": "IP地址，普通高防IP要传该字段", "example": "1.1.1.1" }, { "name": "Domain", "type": "string", "required": false, "description": "域名，普通高防IP要传该字段", "example": "www.xx.com" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议，普通高防IP要传该字段", "example": "http" } ], "required": [ "Business", "Offset", "Limit" ] }, { "name": "DescribeDDoSBlackWhiteIpList", "description": "获取DDoS防护的IP网段黑白名单", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-00001001" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDDoSConnectLimitList", "description": "获取DDoS连接抑制配置列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数", "example": "10" }, { "name": "FilterIp", "type": "string", "required": false, "description": "可选参数，按照IP进行过滤", "example": "\"1.1.1.1\"" }, { "name": "FilterInstanceId", "type": "string", "required": false, "description": "可选参数，按照实例id进行过滤", "example": "\"id-xxxx\"" } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeDDoSTrend", "description": "获取DDoS攻击流量带宽和攻击包速率数据", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版；basic表示DDoS基础防护）", "example": "bgp" }, { "name": "Ip", "type": "string", "required": true, "description": "资源实例的IP", "example": "3.3.3.3" }, { "name": "Period", "type": "integer", "required": true, "description": "统计粒度，取值[300(5分钟)，3600(小时)，86400(天)]", "example": "3600" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间", "example": "2018-08-2715:05:10" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间", "example": "2018-08-2716:05:10" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标，取值[bps(攻击流量带宽，pps(攻击包速率))]", "example": "bps" }, { "name": "Id", "type": "string", "required": false, "description": "资源实例ID，当Business为basic时，此字段不用填写（因为基础防护没有资源实例）", "example": "bgp-00000010" } ], "required": [ "Business", "Ip", "Period", "StartTime", "EndTime", "MetricName" ] }, { "name": "DescribeDefaultAlarmThreshold", "description": "获取单IP默认告警阈值配置", "status": "online", "parameters": [ { "name": "InstanceType", "type": "string", "required": true, "description": "产品类型，取值[ bgp(表示高防包产品) bgpip(表示高防IP产品) ]", "example": "bgp" }, { "name": "FilterAlarmType", "type": "integer", "required": true, "description": "告警阈值类型搜索，取值[ 1(入流量告警阈值) 2(攻击清洗流量告警阈值) ]", "example": "1" } ], "required": [ "InstanceType", "FilterAlarmType" ] }, { "name": "DescribeIpBlockList", "description": "获取IP封堵列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeL7RulesBySSLCertId", "description": "查询与证书ID对于域名匹配的七层规则", "status": "online", "parameters": [ { "name": "Status", "type": "string", "required": true, "description": "域名状态，可取bindable, binded, opened, closed, all，all表示全部状态", "example": "bindable" }, { "name": "CertIds", "type": "array", "required": true, "description": "证书ID列表", "example": "[\"cMgC0TpV\", \"kmLKvJiD\", \"kmCL9Kv7\",\"kneSCNrZ\"]", "item_type": "string" } ], "required": [ "Status", "CertIds" ] }, { "name": "DescribeListBGPIPInstances", "description": "获取高防IP资产实例列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数，当Limit=0时，默认一页条数为20;最大取值为100", "example": "25" }, { "name": "FilterIp", "type": "string", "required": false, "description": "IP搜索", "example": "1.1.1.1" }, { "name": "FilterInstanceId", "type": "string", "required": false, "description": "资产实例ID搜索，例如，bgpip-00000001", "example": "bgpip-00000001" }, { "name": "FilterLine", "type": "integer", "required": false, "description": "高防IP线路搜索，取值为[ 1：BGP线路 2：电信 3：联通 4：移动 99：第三方合作线路 ]", "example": "1" }, { "name": "FilterRegion", "type": "string", "required": false, "description": "地域搜索，例如，ap-guangzhou", "example": "ap-guangzhou" }, { "name": "FilterName", "type": "string", "required": false, "description": "名称搜索", "example": "name" }, { "name": "FilterEipType", "type": "integer", "required": false, "description": "是否只获取高防弹性公网IP实例。填写时，只能填写1或者0。当填写1时，表示返回高防弹性公网IP实例。当填写0时，表示返回非高防弹性公网IP实例。", "example": "1" }, { "name": "FilterEipEipAddressStatus", "type": "array", "required": false, "description": "高防弹性公网IP实例的绑定状态搜索条件，取值范围 [BINDING、 BIND、UNBINDING、UNBIND]。该搜索条件只在FilterEipType=1时才有效。", "example": "1", "item_type": "string" }, { "name": "FilterDamDDoSStatus", "type": "integer", "required": false, "description": "是否只获取安全加速实例。填写时，只能填写1或者0。当填写1时，表示返回安全加速实例。当填写0时，表示返回非安全加速实例。", "example": "1" }, { "name": "FilterStatus", "type": "string", "required": false, "description": "获取特定状态的资源，运行中填idle，攻击中填attacking，封堵中填blocking，试用资源填trial", "example": "attacking" }, { "name": "FilterCname", "type": "string", "required": false, "description": "获取特定的实例Cname", "example": "abcdefg" }, { "name": "FilterInstanceIdList", "type": "array", "required": false, "description": "批量查询实例ID对应的高防IP实例资源", "example": "id-xxxx", "item_type": "string" }, { "name": "FilterTag", "type": "object", "required": false, "description": "标签搜索", "example": "tag", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "232" }, { "name": "TagValue", "type": "array", "required": true, "description": "标签键值列表", "example": "232", "item_type": "string" } ] }, { "name": "FilterPackType", "type": "array", "required": false, "description": "按照套餐类型进行过滤", "example": "type", "item_type": "string" }, { "name": "FilterConvoy", "type": "integer", "required": false, "description": "重保护航搜索", "example": "1" } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeListBGPInstances", "description": "获取高防包资产实例列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数，当Limit=0时，默认一页条数为20;最大取值为100", "example": "25" }, { "name": "FilterIp", "type": "string", "required": false, "description": "IP搜索", "example": "1.1.1.1" }, { "name": "FilterInstanceId", "type": "string", "required": false, "description": "资产实例ID搜索，例如，bgp-00000001", "example": "bgp-00000001" }, { "name": "FilterRegion", "type": "string", "required": false, "description": "地域搜索，例如，ap-guangzhou", "example": "ap-guangzhou" }, { "name": "FilterName", "type": "string", "required": false, "description": "名称搜索", "example": "name" }, { "name": "FilterLine", "type": "integer", "required": false, "description": "按照线路搜索, 1: BGP; 2: 三网", "example": "1" }, { "name": "FilterStatus", "type": "string", "required": false, "description": "状态搜索，idle：运行中；attacking：攻击中；blocking：封堵中", "example": "attacking" }, { "name": "FilterBoundStatus", "type": "string", "required": false, "description": "高防包绑定状态搜索，bounding：绑定中； failed：绑定失败", "example": "bounding" }, { "name": "FilterInstanceIdList", "type": "array", "required": false, "description": "实例id数组", "example": "[bgp-00000001]", "item_type": "string" }, { "name": "FilterEnterpriseFlag", "type": "integer", "required": false, "description": "企业版搜索, 1：包含重保护航套餐下的企业版列表, 2: 不包含重保护航套餐的企业版列表", "example": "1" }, { "name": "FilterLightFlag", "type": "integer", "required": false, "description": "轻量版搜索", "example": "1" }, { "name": "FilterChannelFlag", "type": "integer", "required": false, "description": "定制版搜索", "example": "1" }, { "name": "FilterTag", "type": "object", "required": false, "description": "标签搜索", "example": "无", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "232" }, { "name": "TagValue", "type": "array", "required": true, "description": "标签键值列表", "example": "232", "item_type": "string" } ] }, { "name": "FilterTrialFlag", "type": "integer", "required": false, "description": "试用资源搜索，1: 应急防护资源；2：PLG试用资源", "example": "1" }, { "name": "FilterConvoy", "type": "integer", "required": false, "description": "重保护航搜索", "example": "1" }, { "name": "ExcludeAdvancedInfo", "type": "boolean", "required": false, "description": "默认false；接口传true，返回数据中不包含高级信息，高级信息包含：InstanceList[0].Usage。", "example": "false" }, { "name": "FilterAssetIpList", "type": "array", "required": false, "description": "资产IP数组", "example": "[1.1.1.1]", "item_type": "string" }, { "name": "FilterBasicPlusFlag", "type": "integer", "required": false, "description": "是否包含基础防护增强版 0: 不包含 1: 包含", "example": "1" }, { "name": "FilterPlanCntFlag", "type": "integer", "required": false, "description": "是否标准版2.0 0: 包含标准版2.0 0 1: 只查询标准版2.0 0 2: 不查标准版2.0", "example": "1" }, { "name": "FilterTransRegionFlag", "type": "integer", "required": false, "description": "是否跨区域产品 0: 不包含跨区域产品 1: 中国大陆跨区域产品 2: 非中国大陆跨区域产品 3: 包含全部", "example": "0" }, { "name": "FilterZoneIdList", "type": "array", "required": false, "description": "ZoneID列表", "example": "1", "item_type": "integer" } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeListBlackWhiteIpList", "description": "获取DDoS防护的IP黑白名单列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数，当Limit=0时，默认一页条数为100;最大取值为100", "example": "25" }, { "name": "FilterInstanceId", "type": "string", "required": true, "description": "资源实例ID搜索, 支持资源实例前缀通配搜索，例如bgp-*表示获取高防包类型的资源实例", "example": "bgpip-0000011x" }, { "name": "FilterIp", "type": "string", "required": false, "description": "IP搜索", "example": "1.1.1.1" } ], "required": [ "Offset", "Limit", "FilterInstanceId" ] }, { "name": "DescribeListDDoSAI", "description": "获取DDoS防护的AI防护开关列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数，当Limit=0时，默认一页条数为100;最大取值为100", "example": "25" }, { "name": "FilterInstanceId", "type": "string", "required": true, "description": "资源实例ID搜索, 支持资源实例前缀通配搜索，例如bgp-*表示获取高防包类型的资源实例", "example": "bgpip-0000011x" }, { "name": "FilterIp", "type": "string", "required": false, "description": "IP搜索", "example": "1.1.1.1" } ], "required": [ "Offset", "Limit", "FilterInstanceId" ] }, { "name": "DescribeListDDoSGeoIPBlockConfig", "description": "获取DDoS防护的区域封禁配置列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数，当Limit=0时，默认一页条数为100;最大取值为100", "example": "25" }, { "name": "FilterInstanceId", "type": "string", "required": true, "description": "资源实例ID搜索, 支持资源实例前缀通配搜索，例如bgp-*表示获取高防包类型的资源实例", "example": "bgpip-*" }, { "name": "FilterIp", "type": "string", "required": false, "description": "IP搜索", "example": "1.1.1.1" } ], "required": [ "Offset", "Limit", "FilterInstanceId" ] }, { "name": "DescribeListDDoSSpeedLimitConfig", "description": "获取DDoS防护的访问限速配置列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数，当Limit=0时，默认一页条数为100;最大取值为100", "example": "25" }, { "name": "FilterInstanceId", "type": "string", "required": true, "description": "资源实例ID搜索, 支持资源实例前缀通配搜索，例如bgp-*表示获取高防包类型的资源实例", "example": "bgpip-*" }, { "name": "FilterIp", "type": "string", "required": false, "description": "IP搜索", "example": "1.1.1.1" } ], "required": [ "Offset", "Limit", "FilterInstanceId" ] }, { "name": "DescribeListIPAlarmConfig", "description": "获取单IP告警阈值配置列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数，当Limit=0时，默认一页条数为100;最大取值为100", "example": "25" }, { "name": "FilterInstanceId", "type": "string", "required": true, "description": "资源实例ID搜索, 支持资源实例前缀通配搜索，例如bgp-*表示获取高防包类型的资源实例", "example": "bgpip-0000011x" }, { "name": "FilterAlarmType", "type": "integer", "required": true, "description": "告警阈值类型搜索，取值[ 1(入流量告警阈值) 2(攻击清洗流量告警阈值) ]", "example": "1" }, { "name": "FilterIp", "type": "string", "required": false, "description": "IP搜索", "example": "1.1.1.1" }, { "name": "FilterCname", "type": "string", "required": false, "description": "高防IP实例资源的cname", "example": "abcdefg" } ], "required": [ "Offset", "Limit", "FilterInstanceId", "FilterAlarmType" ] }, { "name": "DescribeListListener", "description": "获取转发监听器列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeListPacketFilterConfig", "description": "获取DDoS防护的特征过滤规则列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数，当Limit=0时，默认一页条数为100;最大取值为100", "example": "25" }, { "name": "FilterInstanceId", "type": "string", "required": true, "description": "资源实例ID搜索, 支持资源实例前缀通配搜索，例如bgp-*表示获取高防包类型的资源实例", "example": "bgpip-0000011x" }, { "name": "FilterIp", "type": "string", "required": false, "description": "IP搜索", "example": "1.1.1.1" } ], "required": [ "Offset", "Limit", "FilterInstanceId" ] }, { "name": "DescribeListPortAclList", "description": "获取DDoS防护的端口acl策略列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数，当Limit=0时，默认一页条数为100;最大取值为100", "example": "10" }, { "name": "FilterInstanceId", "type": "string", "required": true, "description": "资源实例ID搜索, 支持资源实例前缀通配搜索，例如bgp-*表示获取高防包类型的资源实例", "example": "bgpip-0000011x" }, { "name": "FilterIp", "type": "string", "required": false, "description": "ip搜索", "example": "1.1.1.3" } ], "required": [ "Offset", "Limit", "FilterInstanceId" ] }, { "name": "DescribeListProtectThresholdConfigNew", "description": "获取防护阈值配置列表，包括DDoS的AI、等级、CC阈值开关等。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数，当Limit=0时，默认一页条数为100;最大取值为100", "example": "25" }, { "name": "FilterInstanceId", "type": "string", "required": true, "description": "资源实例ID搜索, 支持资源实例前缀通配搜索，例如bgp-*表示获取高防包类型的资源实例", "example": "bgpip-0000011x" }, { "name": "FilterIp", "type": "string", "required": false, "description": "IP搜索", "example": "1.1.1.1" }, { "name": "FilterDomain", "type": "string", "required": false, "description": "域名搜索，查询域名与协议的CC防护阈值时使用", "example": "无" }, { "name": "FilterProtocol", "type": "string", "required": false, "description": "协议搜索，查询域名与协议的CC防护阈值时使用", "example": "无" } ], "required": [ "Offset", "Limit", "FilterInstanceId" ] }, { "name": "DescribeListProtocolBlockConfig", "description": "获取DDoS防护的协议封禁配置列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数，当Limit=0时，默认一页条数为100;最大取值为100", "example": "25" }, { "name": "FilterInstanceId", "type": "string", "required": true, "description": "资源实例ID搜索, 支持资源实例前缀通配搜索，例如bgp-*表示获取高防包类型的资源实例", "example": "bgpip-0000011x" }, { "name": "FilterIp", "type": "string", "required": false, "description": "IP搜索", "example": "1.1.1.1" } ], "required": [ "Offset", "Limit", "FilterInstanceId" ] }, { "name": "DescribeListSchedulingDomain", "description": "获取智能调度域名列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数，当Limit=0时，默认一页条数为20;最大取值为100", "example": "25" }, { "name": "FilterDomain", "type": "string", "required": false, "description": "调度域名搜索", "example": "test.com" }, { "name": "Status", "type": "string", "required": false, "description": "运行状态 0 代表未运行 1 正在运行 2 运行异常", "example": "1" } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeListWaterPrintConfig", "description": "获取DDoS防护的水印防护配置列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数，当Limit=0时，默认一页条数为100;最大取值为100", "example": "25" }, { "name": "FilterInstanceId", "type": "string", "required": true, "description": "资源实例ID搜索, 支持资源实例前缀通配搜索，例如bgp-*表示获取高防包类型的资源实例", "example": "bgpip-0000011x" }, { "name": "FilterIp", "type": "string", "required": false, "description": "IP搜索", "example": "1.1.1.1" } ], "required": [ "Offset", "Limit", "FilterInstanceId" ] }, { "name": "DescribeNewL7Rules", "description": "高防IP获取7层规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgpip表示高防IP）", "example": "bgpip" }, { "name": "StatusList", "type": "array", "required": false, "description": "状态搜索，选填，取值[0(规则配置成功)，1(规则配置生效中)，2(规则配置失败)，3(规则删除生效中)，5(规则删除失败)，6(规则等待配置)，7(规则等待删除)，8(规则待配置证书)]", "example": "[1,2]", "item_type": "integer" }, { "name": "Domain", "type": "string", "required": false, "description": "域名搜索，选填，当需要搜索域名请填写", "example": "www.abc.com" }, { "name": "Ip", "type": "string", "required": false, "description": "IP搜索，选填，当需要搜索IP请填写", "example": "1.1.1.1" }, { "name": "Limit", "type": "integer", "required": false, "description": "一页条数，默认值100，最大值100，超过100最大返回100条", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "规则偏移量，取值为(页码-1)*一页条数", "example": "1" }, { "name": "ProtocolList", "type": "array", "required": false, "description": "转发协议搜索，选填，取值[http, https, http/https]", "example": "http", "item_type": "string" }, { "name": "Cname", "type": "string", "required": false, "description": "高防IP实例的Cname", "example": "abcdefg" }, { "name": "Export", "type": "boolean", "required": false, "description": "默认为false，当为true时，将不对各个规则做策略检查，直接导出所有规则", "example": "false" } ], "required": [ "Business" ] }, { "name": "DescribeNewL7RulesErrHealth", "description": "获取L7转发规则健康检查异常结果列表", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号(bgpip表示高防IP)", "example": "bgpip" }, { "name": "RuleIdList", "type": "array", "required": false, "description": "规则Id列表", "example": "id-xxx", "item_type": "string" } ], "required": [ "Business" ] }, { "name": "DescribeOverviewAttackTrend", "description": "拉取防护概览攻击趋势", "status": "online", "parameters": [ { "name": "Type", "type": "string", "required": true, "description": "攻击类型，取值ddos， cc", "example": "ddos" }, { "name": "Dimension", "type": "string", "required": true, "description": "纬度，当前仅支持attackcount", "example": "attackcount" }, { "name": "Period", "type": "integer", "required": true, "description": "周期，当前仅支持86400", "example": "86400" }, { "name": "StartTime", "type": "string", "required": true, "description": "防护概览攻击趋势开始时间", "example": "2021-03-17 12:32:12" }, { "name": "EndTime", "type": "string", "required": true, "description": "防护概览攻击趋势结束时间", "example": "2021-03-17 12:32:12" } ], "required": [ "Type", "Dimension", "Period", "StartTime", "EndTime" ] }, { "name": "DescribeOverviewCCTrend", "description": "获取防护概览总请求峰值(QPS)和攻击请求(QPS)以及总请求次数和攻击请求次数", "status": "online", "parameters": [ { "name": "Period", "type": "integer", "required": true, "description": "统计粒度，取值[300(5分钟)，3600(小时)，86400(天)]", "example": "3600" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间", "example": "2018-08-2715:05:10" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间", "example": "2018-08-2716:05:10" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标，取值[inqps(总请求峰值，dropqps(攻击请求峰值))，incount(请求次数), dropcount(攻击次数)]", "example": "inqps" }, { "name": "Business", "type": "string", "required": false, "description": "DDoS防护子产品代号（bgpip表示高防IP；bgp-multip表示共享包；basic表示DDoS基础防护）", "example": "bgp" }, { "name": "IpList", "type": "array", "required": false, "description": "资源的IP", "example": "1.1.1.1", "item_type": "string" }, { "name": "Id", "type": "string", "required": false, "description": "资源实例ID", "example": "bgp-00000010" } ], "required": [ "Period", "StartTime", "EndTime", "MetricName" ] }, { "name": "DescribeOverviewDDoSEventList", "description": "获取防护概览的ddos攻击事件", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始时间", "example": "2021-03-17 12:32:12" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间", "example": "2021-03-17 12:32:12" }, { "name": "AttackStatus", "type": "string", "required": false, "description": "可选按攻击状态过滤，start：攻击中；end：攻击结束", "example": "start" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "记录条数", "example": "10" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeOverviewDDoSTrend", "description": "获取防护概览DDoS攻击流量带宽和攻击包速率数据", "status": "online", "parameters": [ { "name": "Period", "type": "integer", "required": true, "description": "统计粒度，取值[300(5分钟)，3600(小时)，86400(天)]", "example": "3600" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间", "example": "2018-08-2715:05:10" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间", "example": "2018-08-2716:05:10" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标，取值[bps(攻击流量带宽，pps(攻击包速率))]", "example": "bps" }, { "name": "Business", "type": "string", "required": false, "description": "DDoS防护子产品代号（bgpip表示高防IP；bgp-multip表示高防包；basic表示DDoS基础防护）", "example": "bgp" }, { "name": "IpList", "type": "array", "required": false, "description": "资源实例的IP列表", "example": "1.1.1.1", "item_type": "string" }, { "name": "Id", "type": "string", "required": false, "description": "资源实例ID", "example": "bgp-00000010" } ], "required": [ "Period", "StartTime", "EndTime", "MetricName" ] }, { "name": "DescribeOverviewIndex", "description": "拉取防护概览指标", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "拉取指标起始时间", "example": "2021-03-17 12:32:12" }, { "name": "EndTime", "type": "string", "required": true, "description": "拉取指标结束时间", "example": "2021-03-17 12:32:12" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribePendingRiskInfo", "description": "查询账号维度待处理风险信息，包括是否为付费用户，查询攻击中、封堵中、过期资源数量等", "status": "online", "parameters": [], "required": [] }, { "name": "DisassociateDDoSEipAddress", "description": "本接口 (DisassociateDDoSEipAddress) 用于解绑高防弹性公网IP。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID，实例ID形如：bgpip-0000011x。只能填写高防IP实例。", "example": "bgpip-0000011x" }, { "name": "Eip", "type": "string", "required": true, "description": "资源实例ID对应的高防弹性公网IP。", "example": "1.1.1.1" } ], "required": [ "InstanceId", "Eip" ] }, { "name": "ModifyCCLevelPolicy", "description": "修改CC防护等级", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "bgpip-0000023c" }, { "name": "Ip", "type": "string", "required": true, "description": "IP地址", "example": "1.3.2.6" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "1.sdc.com" }, { "name": "Protocol", "type": "string", "required": true, "description": "协议，可取值http、https、http/https", "example": "http" }, { "name": "Level", "type": "string", "required": true, "description": "CC防护等级，可取值loose表示宽松，strict表示严格，normal表示适中， emergency表示攻击紧急， sup_loose表示超级宽松，default表示默认策略（无频控配置下发），customized表示自定义策略", "example": "loose" } ], "required": [ "InstanceId", "Ip", "Domain", "Protocol", "Level" ] }, { "name": "ModifyCCPrecisionPolicy", "description": "修改CC精准防护策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "bgpip-0000011x" }, { "name": "PolicyId", "type": "string", "required": true, "description": "策略Id", "example": "ccPrecs-00000326" }, { "name": "PolicyAction", "type": "string", "required": true, "description": "策略方式。可取值：alg、drop、trans。alg指返回验证码方式验证，drop表示该访问丢弃，trans表示该访问放行。", "example": "alg" }, { "name": "PolicyList", "type": "array", "required": true, "description": "策略记录", "example": "无", "item_type": "object", "children": [ { "name": "FieldType", "type": "string", "required": true, "description": "配置项类型，当前仅支持value", "example": "value" }, { "name": "FieldName", "type": "string", "required": true, "description": "配置字段，可取值cgi， ua， cookie， referer， accept, srcip", "example": "srcip" }, { "name": "Value", "type": "string", "required": true, "description": "配置取值", "example": "1.2.3.4" }, { "name": "ValueOperator", "type": "string", "required": true, "description": "配置项值比对方式，可取值equal：相等，not_equal：不相等， include：包含", "example": "equal" } ] } ], "required": [ "InstanceId", "PolicyId", "PolicyAction", "PolicyList" ] }, { "name": "ModifyCCReqLimitPolicy", "description": "修改CC频率限制策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "bgpip-0000023c" }, { "name": "PolicyId", "type": "string", "required": true, "description": "策略Id", "example": "ccRule-00000312" }, { "name": "Policy", "type": "object", "required": true, "description": "策略项", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "统计周期，可取值1，10，30，60，单位秒", "example": "1" }, { "name": "RequestNum", "type": "integer", "required": true, "description": "请求数，取值1~20000", "example": "1" }, { "name": "Action", "type": "string", "required": true, "description": "频率限制策略方式，可取值alg表示验证码，drop表示丢弃", "example": "drop" }, { "name": "ExecuteDuration", "type": "integer", "required": true, "description": "频率限制策略时长，可取值1~86400，单位秒", "example": "1" }, { "name": "Mode", "type": "string", "required": true, "description": "策略项比对方式，可取值include表示包含，equal表示等于", "example": "include" }, { "name": "Uri", "type": "string", "required": false, "description": "Uri，三个策略项仅可填其中之一", "example": "www.a.com" }, { "name": "UserAgent", "type": "string", "required": false, "description": "User-Agent，三个策略项仅可填其中之一", "example": "Agent" }, { "name": "Cookie", "type": "string", "required": false, "description": "Cookie，三个策略项仅可填其中之一", "example": "Cookie" } ] } ], "required": [ "InstanceId", "PolicyId", "Policy" ] }, { "name": "ModifyCCThresholdPolicy", "description": "修改CC清洗阈值", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "bgpip-0000023c" }, { "name": "Ip", "type": "string", "required": true, "description": "IP地址", "example": "1.3.2.6" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "1.sdc.com" }, { "name": "Protocol", "type": "string", "required": true, "description": "协议，可取值http，https，http/https", "example": "http" }, { "name": "Threshold", "type": "integer", "required": true, "description": "清洗阈值，-1表示开启“默认”模式", "example": "1000" } ], "required": [ "InstanceId", "Ip", "Domain", "Protocol", "Threshold" ] }, { "name": "ModifyCcBlackWhiteIpList", "description": "修改CC四层黑白名单", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" }, { "name": "IpList", "type": "array", "required": true, "description": "IP列表", "example": "无", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "ip地址", "example": "1.1.2.1" }, { "name": "Mask", "type": "integer", "required": true, "description": "ip掩码，如果为32位ip，填0", "example": "0" } ] }, { "name": "Type", "type": "string", "required": true, "description": "IP类型，取值[black(黑名单IP), white(白名单IP)]", "example": "black" }, { "name": "PolicyId", "type": "string", "required": true, "description": "策略Id", "example": "ccBlackWhite-00000312" } ], "required": [ "InstanceId", "IpList", "Type", "PolicyId" ] }, { "name": "ModifyDDoSBlackWhiteIpList", "description": "修改DDoS黑白名单列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源Id", "example": "bgpip-00023423" }, { "name": "OldIpType", "type": "string", "required": true, "description": "当前配置的黑白名单类型，取值black时表示黑名单；取值white时表示白名单", "example": "black" }, { "name": "OldIp", "type": "object", "required": true, "description": "当前配置的Ip段，包含ip与掩码", "example": "无", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "ip地址", "example": "1.1.2.1" }, { "name": "Mask", "type": "integer", "required": true, "description": "ip掩码，如果为32位ip，填0", "example": "0" } ] }, { "name": "NewIpType", "type": "string", "required": true, "description": "修改后黑白名单类型，取值black时黑名单，取值white时白名单", "example": "black" }, { "name": "NewIp", "type": "object", "required": true, "description": "当前配置的Ip段，包含ip与掩码", "example": "无", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "ip地址", "example": "1.1.2.1" }, { "name": "Mask", "type": "integer", "required": true, "description": "ip掩码，如果为32位ip，填0", "example": "0" } ] } ], "required": [ "InstanceId", "OldIpType", "OldIp", "NewIpType", "NewIp" ] }, { "name": "ModifyDDoSGeoIPBlockConfig", "description": "修改DDoS防护的区域封禁配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" }, { "name": "DDoSGeoIPBlockConfig", "type": "object", "required": true, "description": "DDoS区域封禁配置，填写参数时配置ID不能为空", "example": "无", "children": [ { "name": "RegionType", "type": "string", "required": true, "description": "区域类型，取值[ oversea(境外) china(国内) customized(自定义地区) ]", "example": "oversea" }, { "name": "Action", "type": "string", "required": true, "description": "封禁动作，取值[ drop(拦截) trans(放行) ]", "example": "drop" }, { "name": "Id", "type": "string", "required": false, "description": "配置ID，配置添加成功后生成；添加新配置时不用填写此字段，修改或删除配置时需要填写配置ID", "example": "0" }, { "name": "AreaList", "type": "array", "required": false, "description": "当RegionType为customized时，必须填写AreaList，且最多填写128个；", "example": "100025", "item_type": "integer" } ] } ], "required": [ "InstanceId", "DDoSGeoIPBlockConfig" ] }, { "name": "ModifyDDoSLevel", "description": "读取或修改DDoS的防护等级", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "资源ID", "example": "bgpip-000000xe" }, { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）", "example": "bgpip" }, { "name": "Method", "type": "string", "required": true, "description": "=get表示读取防护等级；=set表示修改防护等级", "example": "set" }, { "name": "DDoSLevel", "type": "string", "required": false, "description": "防护等级，取值[low,middle,high]；当Method=set时必填", "example": "low" } ], "required": [ "Id", "Business", "Method" ] }, { "name": "ModifyDDoSSpeedLimitConfig", "description": "修改DDoS防护的访问限速配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" }, { "name": "DDoSSpeedLimitConfig", "type": "object", "required": true, "description": "访问限速配置，填写参数时配置ID不能为空", "example": "无", "children": [ { "name": "Mode", "type": "integer", "required": true, "description": "限速模式，取值[ 1(基于源IP限速) 2(基于目的端口限速) ]", "example": "1" }, { "name": "SpeedValues", "type": "array", "required": true, "description": "限速值，每种类型的限速值最多支持1个；该字段数组至少有一种限速值", "example": "1", "item_type": "object", "children": [ { "name": "Type", "type": "integer", "required": true, "description": "限速值类型，取值[ 1(包速率pps) 2(带宽bps) ]", "example": "1" }, { "name": "Value", "type": "integer", "required": true, "description": "值大小", "example": "1" } ] }, { "name": "DstPortScopes", "type": "array", "required": false, "description": "此字段已弃用，请填写新字段DstPortList。", "example": "DstPortList", "item_type": "object", "children": [ { "name": "BeginPort", "type": "integer", "required": true, "description": "起始端口，取值1~65535", "example": "1" }, { "name": "EndPort", "type": "integer", "required": true, "description": "结束端口，取值1~65535，必须不小于起始端口", "example": "1" } ] }, { "name": "Id", "type": "string", "required": false, "description": "配置ID，配置添加成功后生成；添加新限制配置时不用填写此字段，修改或删除限速配置时需要填写配置ID", "example": "id-xx" }, { "name": "ProtocolList", "type": "string", "required": false, "description": "IP protocol numbers, 取值[ ALL(所有协议) TCP(tcp协议) UDP(udp协议) SMP(smp协议) 1;2-100(自定义协议号范围,最多8个) ] 注意：当自定义协议号范围时，只能填写协议号，多个范围;分隔；当填写ALL时不能再填写其他协议或协议号。", "example": "1.1.1.1" }, { "name": "DstPortList", "type": "string", "required": false, "description": "端口范围列表，最多8个，多个;分隔，范围表示用-；此端口范围必须填写；填写样式1:0-65535，样式2:80;443;1000-2000", "example": "80" } ] } ], "required": [ "InstanceId", "DDoSSpeedLimitConfig" ] }, { "name": "ModifyDDoSThreshold", "description": "修改DDoS清洗阈值", "status": "online", "parameters": [ { "name": "Threshold", "type": "integer", "required": true, "description": "DDoS清洗阈值，取值[0, 60, 80, 100, 150, 200, 250, 300, 400, 500, 700, 1000]; 当设置值为0时，表示采用默认值；", "example": "1000" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID", "example": "bgpip-000000xe" }, { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）", "example": "bgpip" }, { "name": "OtherThresholdFlag", "type": "integer", "required": false, "description": "配置其他阈值标志位，1表示配置其他阈值", "example": "1" }, { "name": "SynFloodThreshold", "type": "integer", "required": false, "description": "SYN FLOOD流量阈值", "example": "1000" }, { "name": "SynFloodPktThreshold", "type": "integer", "required": false, "description": "SYN FLOOD包量阈值", "example": "1000" }, { "name": "UdpFloodThreshold", "type": "integer", "required": false, "description": "UDP FLOOD流量阈值", "example": "1000" }, { "name": "UdpFloodPktThreshold", "type": "integer", "required": false, "description": "UDP FLOOD包量阈值", "example": "1000" }, { "name": "AckFloodThreshold", "type": "integer", "required": false, "description": "ACK FLOOD流量阈值", "example": "1000" }, { "name": "AckFloodPktThreshold", "type": "integer", "required": false, "description": "ACK FLOOD包量阈值", "example": "1000" }, { "name": "SynAckFloodThreshold", "type": "integer", "required": false, "description": "SYNACK FLOOD流量阈值", "example": "1000" }, { "name": "SynAckFloodPktThreshold", "type": "integer", "required": false, "description": "SYNACK FLOOD包量阈值", "example": "1000" }, { "name": "RstFloodThreshold", "type": "integer", "required": false, "description": "RST FLOOD流量阈值", "example": "1000" }, { "name": "RstFloodPktThreshold", "type": "integer", "required": false, "description": "RST FLOOD包量阈值", "example": "1000" } ], "required": [ "Threshold", "Id", "Business" ] }, { "name": "ModifyDomainUsrName", "description": "修改智能解析域名名称", "status": "online", "parameters": [ { "name": "DomainName", "type": "string", "required": true, "description": "用户CNAME", "example": "test.com" }, { "name": "DomainUserName", "type": "string", "required": true, "description": "域名名称", "example": "name" } ], "required": [ "DomainName", "DomainUserName" ] }, { "name": "ModifyNewDomainRules", "description": "修改7层转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "DDoS防护子产品代号（bgpip表示高防IP）", "example": "bgpip" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID", "example": "bgpip-000000xe" }, { "name": "Rule", "type": "object", "required": true, "description": "域名转发规则", "example": "无", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "转发协议，取值[http, https]", "example": "http" }, { "name": "Domain", "type": "string", "required": true, "description": "转发域名", "example": "www.abc.com" }, { "name": "LbType", "type": "integer", "required": true, "description": "负载均衡方式，取值[1(加权轮询)]", "example": "1" }, { "name": "KeepEnable", "type": "integer", "required": true, "description": "会话保持开关，取值[0(会话保持关闭)，1(会话保持开启)]", "example": "1" }, { "name": "KeepTime", "type": "integer", "required": true, "description": "会话保持时间，单位秒", "example": "15" }, { "name": "SourceType", "type": "integer", "required": true, "description": "回源方式，取值[1(域名回源)，2(IP回源)]", "example": "1" }, { "name": "SourceList", "type": "array", "required": true, "description": "回源列表", "example": "无", "item_type": "object", "children": [ { "name": "Source", "type": "string", "required": true, "description": "回源IP或域名", "example": "source" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重值，取值[0,100]，暂不支持", "example": "100" }, { "name": "Port", "type": "integer", "required": false, "description": "8000 注意：此字段可能返回 null，表示取不到有效值。", "example": "8000" }, { "name": "Backup", "type": "integer", "required": false, "description": "备份源站，1: 备份源站，0: 普通源站", "example": "backup" } ] }, { "name": "Region", "type": "integer", "required": false, "description": "区域码", "example": "1" }, { "name": "Id", "type": "string", "required": false, "description": "资源Id", "example": "id-xxx" }, { "name": "Ip", "type": "string", "required": false, "description": "资源Ip", "example": "1.1.1.1" }, { "name": "RuleId", "type": "string", "required": false, "description": "规则ID，当添加新规则时可以不用填写此字段；当修改或者删除规则时需要填写此字段；", "example": "id-xxx" }, { "name": "RuleName", "type": "string", "required": false, "description": "规则描述", "example": "name" }, { "name": "CertType", "type": "integer", "required": false, "description": "证书来源，当转发协议为https时必须填，取值[2(腾讯云托管证书)]，当转发协议为http时也可以填0", "example": "1" }, { "name": "SSLId", "type": "string", "required": false, "description": "当证书来源为腾讯云托管证书时，此字段必须填写托管证书ID", "example": "id-xx" }, { "name": "Cert", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书内容；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)", "example": "cert" }, { "name": "PrivateKey", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书密钥；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)", "example": "key" }, { "name": "Status", "type": "integer", "required": false, "description": "规则状态，取值[0(规则配置成功)，1(规则配置生效中)，2(规则配置失败)，3(规则删除生效中)，5(规则删除失败)，6(规则等待配置)，7(规则等待删除)，8(规则待配置证书)]", "example": "1" }, { "name": "CCStatus", "type": "integer", "required": false, "description": "cc防护状态，取值[0(关闭), 1(开启)]", "example": "1" }, { "name": "CCEnable", "type": "integer", "required": false, "description": "HTTPS协议的CC防护状态，取值[0(关闭), 1(开启)]", "example": "1" }, { "name": "CCThreshold", "type": "integer", "required": false, "description": "HTTPS协议的CC防护阈值（已废弃）", "example": "1" }, { "name": "CCThresholdNew", "type": "integer", "required": false, "description": "HTTPS协议的CC防护阈值 -1：默认防御阈值 0: 关闭 大于0：自定义防护阈值", "example": "1" }, { "name": "CCLevel", "type": "string", "required": false, "description": "HTTPS协议的CC防护等级", "example": "loose" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间", "example": "2024.10.01" }, { "name": "HttpsToHttpEnable", "type": "integer", "required": false, "description": "是否开启Https协议使用Http回源，取值[0(关闭), 1(开启)]，不填写默认是关闭", "example": "1" }, { "name": "VirtualPort", "type": "integer", "required": false, "description": "接入端口值", "example": "80" }, { "name": "RewriteHttps", "type": "integer", "required": false, "description": "http强制跳转https，1表示打开，0表示关闭", "example": "1" }, { "name": "ErrCode", "type": "integer", "required": false, "description": "规则配置失败时的详细错误原因(仅当Status=2时有效)，1001证书不存在，1002证书获取失败，1003证书上传失败，1004证书已过期", "example": "100" }, { "name": "Version", "type": "integer", "required": false, "description": "版本", "example": "2" } ] } ], "required": [ "Business", "Id", "Rule" ] }, { "name": "ModifyPacketFilterConfig", "description": "修改DDoS防护的特征过滤规则", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" }, { "name": "PacketFilterConfig", "type": "object", "required": true, "description": "特征过滤配置", "example": "无", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，取值[tcp udp icmp all]", "example": "tcp" }, { "name": "SportStart", "type": "integer", "required": true, "description": "起始源端口，取值0~65535", "example": "1000" }, { "name": "SportEnd", "type": "integer", "required": true, "description": "结束源端口，取值1~65535，必须大于等于起始源端口", "example": "1001" }, { "name": "DportStart", "type": "integer", "required": true, "description": "起始目的端口，取值0~65535", "example": "1000" }, { "name": "DportEnd", "type": "integer", "required": true, "description": "结束目的端口，取值1~65535，必须大于等于起始目的端口", "example": "1001" }, { "name": "PktlenMin", "type": "integer", "required": true, "description": "最小报文长度，取值1-1500", "example": "300" }, { "name": "PktlenMax", "type": "integer", "required": true, "description": "最大报文长度，取值1-1500，必须大于等于最小报文长度", "example": "500" }, { "name": "Action", "type": "string", "required": true, "description": "动作，取值[ drop(丢弃) transmit(放行) drop_black(丢弃并拉黑) drop_rst(拦截)（已废弃，不支持drop_rst） drop_black_rst(拦截并拉黑)（已废弃，不支持drop_black_rst） forward(继续防护) ]", "example": "drop" }, { "name": "MatchBegin", "type": "string", "required": false, "description": "检测位置，取值[ begin_l3(IP头) begin_l4(TCP/UDP头) begin_l5(T载荷) no_match(不匹配) ]", "example": "begin_l5" }, { "name": "MatchType", "type": "string", "required": false, "description": "检测类型，取值[ sunday(关键字) pcre(正则表达式) （已废弃，仅支持sunday） ]", "example": "sunday" }, { "name": "Str", "type": "string", "required": false, "description": "检测值，关键字符串或正则表达式,取值[ 当检测类型为sunday时，请填写字符串或者16进制字节码，例如\\x313233对应的是字符串\"123\"的16进制字节码; 最多支持63位; ]", "example": "\\x313233" }, { "name": "Depth", "type": "integer", "required": false, "description": "从检测位置开始的检测深度，取值[0,1500]", "example": "500" }, { "name": "Offset", "type": "integer", "required": false, "description": "从检测位置开始的偏移量，取值范围[0,Depth]", "example": "100" }, { "name": "IsNot", "type": "integer", "required": false, "description": "是否包含检测值，取值[ 0(包含) 1(不包含) （已废弃，仅支持0） ]", "example": "0" }, { "name": "MatchLogic", "type": "string", "required": false, "description": "当有第二个检测条件时，与第一检测条件的且或关系，取值[ and(且的关系) （已废弃，仅支持none） none(当没有第二个检测条件时填写此值) ]", "example": "none" }, { "name": "MatchBegin2", "type": "string", "required": false, "description": "（已废弃）", "example": "begin_l5" }, { "name": "MatchType2", "type": "string", "required": false, "description": "（已废弃）", "example": "sunday" }, { "name": "Str2", "type": "string", "required": false, "description": "（已废弃）", "example": "\\x313233" }, { "name": "Depth2", "type": "integer", "required": false, "description": "（已废弃）", "example": "500" }, { "name": "Offset2", "type": "integer", "required": false, "description": "（已废弃）", "example": "200" }, { "name": "IsNot2", "type": "integer", "required": false, "description": "（已废弃）", "example": "0" }, { "name": "Id", "type": "string", "required": false, "description": "特征过滤配置添加成功后自动生成的规则ID，当添加新特征过滤配置时，此字段不用填写；当修改/删除新特征过滤配置时，此字段必填；", "example": "id-xxx" }, { "name": "PktLenGT", "type": "integer", "required": false, "description": "大于报文长度，取值1+", "example": "50" } ] } ], "required": [ "InstanceId", "PacketFilterConfig" ] }, { "name": "ModifyPortAclConfig", "description": "修改DDoS防护的端口acl策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-00001001" }, { "name": "OldAclConfig", "type": "object", "required": true, "description": "旧端口acl策略", "example": "无", "children": [ { "name": "ForwardProtocol", "type": "string", "required": true, "description": "协议类型, 可取值tcp, udp, all", "example": "tcp" }, { "name": "DPortStart", "type": "integer", "required": true, "description": "目的端口起始，可取值范围0~65535", "example": "0" }, { "name": "DPortEnd", "type": "integer", "required": true, "description": "目的端口结束，可取值范围0~65535", "example": "65535" }, { "name": "SPortStart", "type": "integer", "required": true, "description": "来源端口起始，可取值范围0~65535", "example": "0" }, { "name": "SPortEnd", "type": "integer", "required": true, "description": "来源端口结束，可取值范围0~65535", "example": "65535" }, { "name": "Action", "type": "string", "required": true, "description": "动作，可取值：drop， transmit， forward", "example": "65535" }, { "name": "Priority", "type": "integer", "required": false, "description": "策略优先级，数字越小，级别越高，该规则越靠前匹配，取值1-1000", "example": "10" } ] }, { "name": "NewAclConfig", "type": "object", "required": true, "description": "新端口acl策略", "example": "无", "children": [ { "name": "ForwardProtocol", "type": "string", "required": true, "description": "协议类型, 可取值tcp, udp, all", "example": "tcp" }, { "name": "DPortStart", "type": "integer", "required": true, "description": "目的端口起始，可取值范围0~65535", "example": "0" }, { "name": "DPortEnd", "type": "integer", "required": true, "description": "目的端口结束，可取值范围0~65535", "example": "65535" }, { "name": "SPortStart", "type": "integer", "required": true, "description": "来源端口起始，可取值范围0~65535", "example": "0" }, { "name": "SPortEnd", "type": "integer", "required": true, "description": "来源端口结束，可取值范围0~65535", "example": "65535" }, { "name": "Action", "type": "string", "required": true, "description": "动作，可取值：drop， transmit， forward", "example": "65535" }, { "name": "Priority", "type": "integer", "required": false, "description": "策略优先级，数字越小，级别越高，该规则越靠前匹配，取值1-1000", "example": "10" } ] } ], "required": [ "InstanceId", "OldAclConfig", "NewAclConfig" ] }, { "name": "SwitchWaterPrintConfig", "description": "开启或关闭DDoS防护的水印防护配置，此功能为付费增值服务，有需求请联系售后", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "资源实例ID", "example": "bgpip-0000011x" }, { "name": "OpenStatus", "type": "integer", "required": true, "description": "水印开启/关闭状态，1表示开启；0表示关闭", "example": "1" }, { "name": "CloudSdkProxy", "type": "integer", "required": false, "description": "是否开启代理，1开启则忽略IP+端口校验；0关闭则需要IP+端口校验", "example": "1" } ], "required": [ "InstanceId", "OpenStatus" ] } ] }