{ "name": "dayu", "display_name": "DDoS 高防包", "description": "介绍如何使用API对DDoS高防包操作，包括CC攻击防护策略、DDoS攻击防护策略等。", "domain": "other", "api_version": "2018-07-09", "endpoint": "dayu.tencentcloudapi.com", "actions": [ { "name": "CreateBasicDDoSAlarmThreshold", "description": "设置基础防护的DDoS告警阈值，只支持基础防护产品", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（basic表示DDoS基础防护）" }, { "name": "Method", "type": "string", "required": true, "description": "=get表示读取告警阈值；=set表示设置告警阈值；" }, { "name": "AlarmType", "type": "integer", "required": false, "description": "可选，告警阈值类型，1-入流量，2-清洗流量；当Method为set时必须填写；" }, { "name": "AlarmThreshold", "type": "integer", "required": false, "description": "可选，告警阈值，当Method为set时必须填写；当设置阈值为0时表示清除告警阈值配置；" } ], "required": [ "Business", "Method" ] }, { "name": "CreateBoundIP", "description": "绑定IP到高防包实例，支持独享包、共享包；需要注意的是此接口绑定或解绑IP是异步接口，当处于绑定或解绑中时，则不允许再进行绑定或解绑，需要等待当前绑定或解绑完成。", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgp表示独享包；bgp-multip表示共享包）" }, { "name": "Id", "type": "string", "required": true, "description": "资源实例ID" }, { "name": "BoundDevList", "type": "array", "required": false, "description": "绑定到资源实例的IP数组，当资源实例为高防包(独享包)时，数组只允许填1个IP；当没有要绑定的IP时可以为空数组；但是BoundDevList和UnBoundDevList至少有一个不为空；", "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": "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": "InstanceId", "type": "string", "required": false, "description": "IP所属的资源实例ID，当绑定新IP时必须填写此字段；例如是弹性网卡的IP，则InstanceId填写弹性网卡的ID(eni-*); 如果绑定的是托管IP没有对应的资源实例ID，请填写\"none\";", "example": "none" }, { "name": "IspCode", "type": "integer", "required": false, "description": "运营商，0：电信；1：联通；2：移动；5：BGP", "example": "5" } ] }, { "name": "UnBoundDevList", "type": "array", "required": false, "description": "与资源实例解绑的IP数组，当资源实例为高防包(独享包)时，数组只允许填1个IP；当没有要解绑的IP时可以为空数组；但是BoundDevList和UnBoundDevList至少有一个不为空；", "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": "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": "InstanceId", "type": "string", "required": false, "description": "IP所属的资源实例ID，当绑定新IP时必须填写此字段；例如是弹性网卡的IP，则InstanceId填写弹性网卡的ID(eni-*); 如果绑定的是托管IP没有对应的资源实例ID，请填写\"none\";", "example": "none" }, { "name": "IspCode", "type": "integer", "required": false, "description": "运营商，0：电信；1：联通；2：移动；5：BGP", "example": "5" } ] }, { "name": "CopyPolicy", "type": "string", "required": false, "description": "已弃用，不填" } ], "required": [ "Business", "Id" ] }, { "name": "CreateCCFrequencyRules", "description": "添加CC防护的访问频率控制规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "RuleId", "type": "string", "required": true, "description": "7层转发规则ID（通过获取7层转发规则接口可以获取规则ID）" }, { "name": "Mode", "type": "string", "required": true, "description": "匹配规则，取值[\"include\"(前缀匹配)，\"equal\"(完全匹配)]" }, { "name": "Period", "type": "integer", "required": true, "description": "统计周期，单位秒，取值[10, 30, 60]" }, { "name": "ReqNumber", "type": "integer", "required": true, "description": "访问次数，取值[1-10000]" }, { "name": "Act", "type": "string", "required": true, "description": "执行动作，取值[\"alg\"（人机识别）, \"drop\"（拦截）]" }, { "name": "ExeDuration", "type": "integer", "required": true, "description": "执行时间，单位秒，取值[1-900]" }, { "name": "Uri", "type": "string", "required": false, "description": "URI字符串，必须以/开头，例如/abc/a.php，长度不超过31；当URI=/时，匹配模式只能选择前缀匹配；" }, { "name": "UserAgent", "type": "string", "required": false, "description": "User-Agent字符串，长度不超过80" }, { "name": "Cookie", "type": "string", "required": false, "description": "Cookie字符串，长度不超过40" } ], "required": [ "Business", "Id", "RuleId", "Mode", "Period", "ReqNumber", "Act", "ExeDuration" ] }, { "name": "CreateCCSelfDefinePolicy", "description": "创建CC自定义策略", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Policy", "type": "object", "required": true, "description": "CC策略描述", "children": [ { "name": "Name", "type": "string", "required": true, "description": "策略名称" }, { "name": "Smode", "type": "string", "required": true, "description": "匹配模式，取值[matching(匹配模式), speedlimit(限速模式)]" }, { "name": "SetId", "type": "string", "required": false, "description": "策略id" }, { "name": "Frequency", "type": "integer", "required": false, "description": "每分钟限制的次数" }, { "name": "ExeMode", "type": "string", "required": false, "description": "执行策略模式，拦截或者验证码，取值[alg（验证码）, drop（拦截）]" }, { "name": "Switch", "type": "integer", "required": false, "description": "生效开关" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间" }, { "name": "RuleList", "type": "array", "required": false, "description": "规则列表", "item_type": "object", "children": [ { "name": "Skey", "type": "string", "required": true, "description": "规则的key, 可以为host、cgi、ua、referer" }, { "name": "Operator", "type": "string", "required": true, "description": "规则的条件，可以为include、not_include、equal" }, { "name": "Value", "type": "string", "required": true, "description": "规则的值，长度小于31字节" } ] }, { "name": "IpList", "type": "array", "required": false, "description": "IP列表，如果不填时，请传空数组但不能为null；", "item_type": "string" }, { "name": "Protocol", "type": "string", "required": false, "description": "cc防护类型，取值[http，https]" }, { "name": "RuleId", "type": "string", "required": false, "description": "可选字段，表示HTTPS的CC防护域名对应的转发规则ID;" }, { "name": "Domain", "type": "string", "required": false, "description": "HTTPS的CC防护域名" } ] } ], "required": [ "Business", "Id", "Policy" ] }, { "name": "CreateDDoSPolicy", "description": "添加DDoS高级策略", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "DropOptions", "type": "array", "required": true, "description": "协议禁用，必须填写且数组长度必须为1", "item_type": "object", "children": [ { "name": "DropTcp", "type": "integer", "required": true, "description": "禁用TCP协议，取值范围[0,1]" }, { "name": "DropUdp", "type": "integer", "required": true, "description": "禁用UDP协议，取值范围[0,1]" }, { "name": "DropIcmp", "type": "integer", "required": true, "description": "禁用ICMP协议，取值范围[0,1]" }, { "name": "DropOther", "type": "integer", "required": true, "description": "禁用其他协议，取值范围[0,1]" }, { "name": "DropAbroad", "type": "integer", "required": true, "description": "拒绝海外流量，取值范围[0,1]" }, { "name": "CheckSyncConn", "type": "integer", "required": true, "description": "空连接防护，取值范围[0,1]" }, { "name": "SdNewLimit", "type": "integer", "required": false, "description": "基于来源IP及目的IP的新建连接抑制，取值范围[0,4294967295]" }, { "name": "DstNewLimit", "type": "integer", "required": false, "description": "基于目的IP的新建连接抑制，取值范围[0,4294967295]" }, { "name": "SdConnLimit", "type": "integer", "required": false, "description": "基于来源IP及目的IP的并发连接抑制，取值范围[0,4294967295]" }, { "name": "DstConnLimit", "type": "integer", "required": false, "description": "基于目的IP的并发连接抑制，取值范围[0,4294967295]" }, { "name": "BadConnThreshold", "type": "integer", "required": false, "description": "基于连接抑制触发阈值，取值范围[0,4294967295]" }, { "name": "NullConnEnable", "type": "integer", "required": false, "description": "异常连接检测条件，空连接防护开关，，取值范围[0,1]" }, { "name": "ConnTimeout", "type": "integer", "required": false, "description": "异常连接检测条件，连接超时，，取值范围[0,65535]" }, { "name": "SynRate", "type": "integer", "required": false, "description": "异常连接检测条件，syn占比ack百分比，，取值范围[0,100]" }, { "name": "SynLimit", "type": "integer", "required": false, "description": "异常连接检测条件，syn阈值，取值范围[0,100]" }, { "name": "DTcpMbpsLimit", "type": "integer", "required": false, "description": "tcp限速，取值范围[0,4294967295]" }, { "name": "DUdpMbpsLimit", "type": "integer", "required": false, "description": "udp限速，取值范围[0,4294967295]" }, { "name": "DIcmpMbpsLimit", "type": "integer", "required": false, "description": "icmp限速，取值范围[0,4294967295]" }, { "name": "DOtherMbpsLimit", "type": "integer", "required": false, "description": "other协议限速，取值范围[0,4294967295]" } ] }, { "name": "Name", "type": "string", "required": false, "description": "策略名称" }, { "name": "PortLimits", "type": "array", "required": false, "description": "端口禁用，当没有禁用端口时填空数组", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，取值范围[tcp,udp,all]" }, { "name": "DPortStart", "type": "integer", "required": true, "description": "开始目的端口，取值范围[0,65535]" }, { "name": "DPortEnd", "type": "integer", "required": true, "description": "结束目的端口，取值范围[0,65535]，要求大于等于开始目的端口" }, { "name": "SPortStart", "type": "integer", "required": false, "description": "开始源端口，取值范围[0,65535] 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "SPortEnd", "type": "integer", "required": false, "description": "结束源端口，取值范围[0,65535]，要求大于等于开始源端口 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "Action", "type": "string", "required": false, "description": "执行动作，取值[drop(丢弃) ，transmit(转发)] 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "Kind", "type": "integer", "required": false, "description": "禁用端口类型，取值[0（目的端口范围禁用）， 1（源端口范围禁用）， 2（目的和源端口范围同时禁用）] 注意：此字段可能返回 null，表示取不到有效值。" } ] }, { "name": "IpAllowDenys", "type": "array", "required": false, "description": "请求源IP黑白名单，当没有IP黑白名单时填空数组", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "IP地址" }, { "name": "Type", "type": "string", "required": true, "description": "黑白类型，取值范围[black，white]" } ] }, { "name": "PacketFilters", "type": "array", "required": false, "description": "报文过滤，当没有报文过滤时填空数组", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，取值范围[tcp,udp,icmp,all]" }, { "name": "SportStart", "type": "integer", "required": true, "description": "开始源端口，取值范围[0,65535]" }, { "name": "SportEnd", "type": "integer", "required": true, "description": "结束源端口，取值范围[0,65535]" }, { "name": "DportStart", "type": "integer", "required": true, "description": "开始目的端口，取值范围[0,65535]" }, { "name": "DportEnd", "type": "integer", "required": true, "description": "结束目的端口，取值范围[0,65535]" }, { "name": "PktlenMin", "type": "integer", "required": true, "description": "最小包长，取值范围[0,1500]" }, { "name": "PktlenMax", "type": "integer", "required": true, "description": "最大包长，取值范围[0,1500]" }, { "name": "MatchBegin", "type": "string", "required": true, "description": "是否检测载荷，取值范围[ begin_l3(IP头) begin_l4(TCP头) begin_l5(载荷) no_match(不检测) ]" }, { "name": "MatchType", "type": "string", "required": true, "description": "是否是正则表达式，取值范围[sunday(表示关键字),pcre(表示正则表达式)]" }, { "name": "Str", "type": "string", "required": true, "description": "关键字或正则表达式" }, { "name": "Depth", "type": "integer", "required": true, "description": "检测深度，取值范围[0,1500]" }, { "name": "Offset", "type": "integer", "required": true, "description": "检测偏移量，取值范围[0,1500]" }, { "name": "IsNot", "type": "integer", "required": true, "description": "是否包括，取值范围[0(表示不包含),1(表示包含)]" }, { "name": "Action", "type": "string", "required": true, "description": "策略动作，取值范围[drop，drop_black，drop_rst，drop_black_rst，transmit]" } ] }, { "name": "WaterPrint", "type": "array", "required": false, "description": "水印策略参数，当没有启用水印功能时填空数组，最多只能传一条水印策略（即数组大小不超过1）", "item_type": "object", "children": [ { "name": "TcpPortList", "type": "array", "required": true, "description": "TCP端口段，例如[\"2000-3000\",\"3500-4000\"]", "item_type": "string" }, { "name": "UdpPortList", "type": "array", "required": true, "description": "UDP端口段，例如[\"2000-3000\",\"3500-4000\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": true, "description": "水印偏移量，取值范围[0, 100)" }, { "name": "RemoveSwitch", "type": "integer", "required": true, "description": "是否自动剥离，取值[0（不自动剥离），1（自动剥离）]" }, { "name": "OpenStatus", "type": "integer", "required": true, "description": "是否开启，取值[0（没有开启），1（已开启）]" } ] } ], "required": [ "Business", "DropOptions" ] }, { "name": "CreateDDoSPolicyCase", "description": "添加策略场景", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "CaseName", "type": "string", "required": true, "description": "策略场景名，字符串长度小于64" }, { "name": "PlatformTypes", "type": "array", "required": false, "description": "开发平台，取值[PC（PC客户端）， MOBILE（移动端）， TV（电视端）， SERVER（主机）]", "item_type": "string" }, { "name": "AppType", "type": "string", "required": false, "description": "细分品类，取值[WEB（网站）， GAME（游戏）， APP（应用）， OTHER（其他）]" }, { "name": "AppProtocols", "type": "array", "required": false, "description": "应用协议，取值[tcp（TCP协议），udp（UDP协议），icmp（ICMP协议），all（其他协议）]", "item_type": "string" }, { "name": "TcpSportStart", "type": "string", "required": false, "description": "TCP业务起始端口，取值(0, 65535]" }, { "name": "TcpSportEnd", "type": "string", "required": false, "description": "TCP业务结束端口，取值(0, 65535]，必须大于等于TCP业务起始端口" }, { "name": "UdpSportStart", "type": "string", "required": false, "description": "UDP业务起始端口，取值范围(0, 65535]" }, { "name": "UdpSportEnd", "type": "string", "required": false, "description": "UDP业务结束端口，取值范围(0, 65535)，必须大于等于UDP业务起始端口" }, { "name": "HasAbroad", "type": "string", "required": false, "description": "是否有海外客户，取值[no（没有）, yes（有）]" }, { "name": "HasInitiateTcp", "type": "string", "required": false, "description": "是否会主动对外发起TCP请求，取值[no（不会）, yes（会）]" }, { "name": "HasInitiateUdp", "type": "string", "required": false, "description": "是否会主动对外发起UDP业务请求，取值[no（不会）, yes（会）]" }, { "name": "PeerTcpPort", "type": "string", "required": false, "description": "主动发起TCP请求的端口，取值范围(0, 65535]" }, { "name": "PeerUdpPort", "type": "string", "required": false, "description": "主动发起UDP请求的端口，取值范围(0, 65535]" }, { "name": "TcpFootprint", "type": "string", "required": false, "description": "TCP载荷的固定特征码，字符串长度小于512" }, { "name": "UdpFootprint", "type": "string", "required": false, "description": "UDP载荷的固定特征码，字符串长度小于512" }, { "name": "WebApiUrl", "type": "array", "required": false, "description": "Web业务的API的URL", "item_type": "string" }, { "name": "MinTcpPackageLen", "type": "string", "required": false, "description": "TCP业务报文长度最小值，取值范围(0, 1500)" }, { "name": "MaxTcpPackageLen", "type": "string", "required": false, "description": "TCP业务报文长度最大值，取值范围(0, 1500)，必须大于等于TCP业务报文长度最小值" }, { "name": "MinUdpPackageLen", "type": "string", "required": false, "description": "UDP业务报文长度最小值，取值范围(0, 1500)" }, { "name": "MaxUdpPackageLen", "type": "string", "required": false, "description": "UDP业务报文长度最大值，取值范围(0, 1500)，必须大于等于UDP业务报文长度最小值" }, { "name": "HasVPN", "type": "string", "required": false, "description": "是否有VPN业务，取值[no（没有）, yes（有）]" }, { "name": "TcpPortList", "type": "string", "required": false, "description": "TCP业务端口列表，同时支持单个端口和端口段，字符串格式，例如：80,443,700-800,53,1000-3000" }, { "name": "UdpPortList", "type": "string", "required": false, "description": "UDP业务端口列表，同时支持单个端口和端口段，字符串格式，例如：80,443,700-800,53,1000-3000" } ], "required": [ "Business", "CaseName" ] }, { "name": "CreateInstanceName", "description": "资源实例重命名，支持独享包、共享包、高防IP、高防IP专业版；", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Name", "type": "string", "required": true, "description": "资源实例名称，长度不超过32个字符" } ], "required": [ "Business", "Id", "Name" ] }, { "name": "CreateL4HealthConfig", "description": "上传四层健康检查配置", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "HealthConfig", "type": "array", "required": true, "description": "四层健康检查配置数组", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "转发协议，取值[TCP, UDP]" }, { "name": "VirtualPort", "type": "integer", "required": true, "description": "转发端口" }, { "name": "Enable", "type": "integer", "required": true, "description": "=1表示开启；=0表示关闭" }, { "name": "TimeOut", "type": "integer", "required": true, "description": "响应超时时间，单位秒" }, { "name": "Interval", "type": "integer", "required": true, "description": "检测间隔时间，单位秒" }, { "name": "KickNum", "type": "integer", "required": true, "description": "不健康阈值，单位次" }, { "name": "AliveNum", "type": "integer", "required": true, "description": "健康阈值，单位次" }, { "name": "KeepTime", "type": "integer", "required": true, "description": "会话保持时间，单位秒" } ] } ], "required": [ "Business", "Id", "HealthConfig" ] }, { "name": "CreateL4Rules", "description": "添加L4转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Rules", "type": "array", "required": true, "description": "规则列表", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "转发协议，取值[TCP, UDP]" }, { "name": "VirtualPort", "type": "integer", "required": true, "description": "转发端口" }, { "name": "SourcePort", "type": "integer", "required": true, "description": "源站端口" }, { "name": "SourceType", "type": "integer", "required": true, "description": "回源方式，取值[1(域名回源)，2(IP回源)]" }, { "name": "KeepTime", "type": "integer", "required": true, "description": "会话保持时间，单位秒" }, { "name": "SourceList", "type": "array", "required": true, "description": "回源列表", "item_type": "object", "children": [ { "name": "Source", "type": "string", "required": true, "description": "回源IP或域名" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重值，取值[0,100]" } ] }, { "name": "LbType", "type": "integer", "required": true, "description": "负载均衡方式，取值[1(加权轮询)，2(源IP hash)]" }, { "name": "KeepEnable", "type": "integer", "required": true, "description": "会话保持开关，取值[0(会话保持关闭)，1(会话保持开启)]；" }, { "name": "RuleId", "type": "string", "required": false, "description": "规则ID" }, { "name": "RuleName", "type": "string", "required": false, "description": "规则描述" }, { "name": "RemoveSwitch", "type": "integer", "required": false, "description": "移除水印状态，取值[0(关闭)，1(开启)]" } ] } ], "required": [ "Business", "Id", "Rules" ] }, { "name": "CreateL7CCRule", "description": "此接口是7层CC的访问频控自定义规则（IP+Host维度，不支持具体的URI），此接口已弃用，请调用新接口CreateCCFrequencyRules，新接口同时支持IP+Host维度以及具体的URI；", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Method", "type": "string", "required": true, "description": "操作码，取值[query(表示查询)，add(表示添加)，del(表示删除)]" }, { "name": "RuleId", "type": "string", "required": true, "description": "7层转发规则ID，例如：rule-0000001" }, { "name": "RuleConfig", "type": "array", "required": false, "description": "7层CC自定义规则参数，当操作码为query时，可以不用填写；当操作码为add或del时，必须填写，且数组长度只能为1；", "item_type": "object", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "统计周期，单位秒，取值[10, 30, 60]" }, { "name": "ReqNumber", "type": "integer", "required": true, "description": "访问次数，取值[1-10000]" }, { "name": "Action", "type": "string", "required": true, "description": "执行动作，取值[\"alg\"（人机识别）, \"drop\"（拦截）]" }, { "name": "ExeDuration", "type": "integer", "required": true, "description": "执行时间，单位秒，取值[1-900]" } ] } ], "required": [ "Business", "Id", "Method", "RuleId" ] }, { "name": "CreateL7HealthConfig", "description": "上传七层健康检查配置", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "HealthConfig", "type": "array", "required": true, "description": "七层健康检查配置数组", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "转发协议，取值[http, https, http/https]" }, { "name": "Domain", "type": "string", "required": true, "description": "转发域名" }, { "name": "Enable", "type": "integer", "required": true, "description": "=1表示开启；=0表示关闭" }, { "name": "Interval", "type": "integer", "required": true, "description": "检测间隔时间，单位秒" }, { "name": "KickNum", "type": "integer", "required": true, "description": "异常判定次数，单位次" }, { "name": "AliveNum", "type": "integer", "required": true, "description": "健康判定次数，单位次" }, { "name": "Method", "type": "string", "required": true, "description": "健康检查探测方法，可选HEAD或GET，默认为HEAD" }, { "name": "StatusCode", "type": "integer", "required": true, "description": "健康检查判定正常状态码，1xx =1, 2xx=2, 3xx=4, 4xx=8,5xx=16，多个状态码值加和" }, { "name": "Url", "type": "string", "required": true, "description": "检查目录的URL，默认为/" } ] } ], "required": [ "Business", "Id", "HealthConfig" ] }, { "name": "CreateL7RuleCert", "description": "配置7层转发规则的证书", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源实例ID，例如高防IP实例的ID，高防IP专业版实例的ID" }, { "name": "RuleId", "type": "string", "required": true, "description": "规则ID" }, { "name": "CertType", "type": "integer", "required": true, "description": "证书类型，当为协议为HTTPS协议时必须填，取值[2(腾讯云托管证书)]" }, { "name": "SSLId", "type": "string", "required": false, "description": "当证书来源为腾讯云托管证书时，此字段必须填写托管证书ID" }, { "name": "Cert", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书内容；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)" }, { "name": "PrivateKey", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书密钥；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)" } ], "required": [ "Business", "Id", "RuleId", "CertType" ] }, { "name": "CreateL7Rules", "description": "添加7层(网站)转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Rules", "type": "array", "required": true, "description": "规则列表", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "转发协议，取值[http, https]" }, { "name": "Domain", "type": "string", "required": true, "description": "转发域名" }, { "name": "SourceType", "type": "integer", "required": true, "description": "回源方式，取值[1(域名回源)，2(IP回源)]" }, { "name": "KeepTime", "type": "integer", "required": true, "description": "会话保持时间，单位秒" }, { "name": "SourceList", "type": "array", "required": true, "description": "回源列表", "item_type": "object", "children": [ { "name": "Source", "type": "string", "required": true, "description": "回源IP或域名" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重值，取值[0,100]" } ] }, { "name": "LbType", "type": "integer", "required": true, "description": "负载均衡方式，取值[1(加权轮询)]" }, { "name": "KeepEnable", "type": "integer", "required": true, "description": "会话保持开关，取值[0(会话保持关闭)，1(会话保持开启)]" }, { "name": "RuleId", "type": "string", "required": false, "description": "规则ID，当添加新规则时可以不用填写此字段；当修改或者删除规则时需要填写此字段；" }, { "name": "CertType", "type": "integer", "required": false, "description": "证书来源，当转发协议为https时必须填，取值[2(腾讯云托管证书)]，当转发协议为http时也可以填0" }, { "name": "SSLId", "type": "string", "required": false, "description": "当证书来源为腾讯云托管证书时，此字段必须填写托管证书ID" }, { "name": "Cert", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书内容；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)" }, { "name": "PrivateKey", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书密钥；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)" }, { "name": "RuleName", "type": "string", "required": false, "description": "规则描述" }, { "name": "Status", "type": "integer", "required": false, "description": "规则状态，取值[0(规则配置成功)，1(规则配置生效中)，2(规则配置失败)，3(规则删除生效中)，5(规则删除失败)，6(规则等待配置)，7(规则等待删除)，8(规则待配置证书)]" }, { "name": "CCStatus", "type": "integer", "required": false, "description": "cc防护状态，取值[0(关闭), 1(开启)]" }, { "name": "CCEnable", "type": "integer", "required": false, "description": "HTTPS协议的CC防护状态，取值[0(关闭), 1(开启)]" }, { "name": "CCThreshold", "type": "integer", "required": false, "description": "HTTPS协议的CC防护阈值" }, { "name": "CCLevel", "type": "string", "required": false, "description": "HTTPS协议的CC防护等级" }, { "name": "HttpsToHttpEnable", "type": "integer", "required": false, "description": "是否开启Https协议使用Http回源，取值[0(关闭), 1(开启)]，不填写默认是关闭 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "VirtualPort", "type": "integer", "required": false, "description": "接入端口值 注意：此字段可能返回 null，表示取不到有效值。" } ] } ], "required": [ "Business", "Id", "Rules" ] }, { "name": "CreateL7RulesUpload", "description": "批量上传7层转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Rules", "type": "array", "required": true, "description": "规则列表", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "转发协议，取值[http, https]" }, { "name": "Domain", "type": "string", "required": true, "description": "转发域名" }, { "name": "SourceType", "type": "integer", "required": true, "description": "回源方式，取值[1(域名回源)，2(IP回源)]" }, { "name": "KeepTime", "type": "integer", "required": true, "description": "会话保持时间，单位秒" }, { "name": "SourceList", "type": "array", "required": true, "description": "回源列表", "item_type": "object", "children": [ { "name": "Source", "type": "string", "required": true, "description": "回源IP或域名" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重值，取值[0,100]" } ] }, { "name": "LbType", "type": "integer", "required": true, "description": "负载均衡方式，取值[1(加权轮询)]" }, { "name": "KeepEnable", "type": "integer", "required": true, "description": "会话保持开关，取值[0(会话保持关闭)，1(会话保持开启)]" }, { "name": "RuleId", "type": "string", "required": false, "description": "规则ID，当添加新规则时可以不用填写此字段；当修改或者删除规则时需要填写此字段；" }, { "name": "CertType", "type": "integer", "required": false, "description": "证书来源，当转发协议为https时必须填，取值[2(腾讯云托管证书)]，当转发协议为http时也可以填0" }, { "name": "SSLId", "type": "string", "required": false, "description": "当证书来源为腾讯云托管证书时，此字段必须填写托管证书ID" }, { "name": "Cert", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书内容；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)" }, { "name": "PrivateKey", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书密钥；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)" }, { "name": "RuleName", "type": "string", "required": false, "description": "规则描述" }, { "name": "Status", "type": "integer", "required": false, "description": "规则状态，取值[0(规则配置成功)，1(规则配置生效中)，2(规则配置失败)，3(规则删除生效中)，5(规则删除失败)，6(规则等待配置)，7(规则等待删除)，8(规则待配置证书)]" }, { "name": "CCStatus", "type": "integer", "required": false, "description": "cc防护状态，取值[0(关闭), 1(开启)]" }, { "name": "CCEnable", "type": "integer", "required": false, "description": "HTTPS协议的CC防护状态，取值[0(关闭), 1(开启)]" }, { "name": "CCThreshold", "type": "integer", "required": false, "description": "HTTPS协议的CC防护阈值" }, { "name": "CCLevel", "type": "string", "required": false, "description": "HTTPS协议的CC防护等级" }, { "name": "HttpsToHttpEnable", "type": "integer", "required": false, "description": "是否开启Https协议使用Http回源，取值[0(关闭), 1(开启)]，不填写默认是关闭 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "VirtualPort", "type": "integer", "required": false, "description": "接入端口值 注意：此字段可能返回 null，表示取不到有效值。" } ] } ], "required": [ "Business", "Id", "Rules" ] }, { "name": "CreateNetReturn", "description": "高防IP专业版一键切回源站", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源实例ID" } ], "required": [ "Business", "Id" ] }, { "name": "CreateNewL4Rules", "description": "添加L4转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "高防产品代号：bgpip" }, { "name": "IdList", "type": "array", "required": true, "description": "添加规则资源列表", "item_type": "string" }, { "name": "VipList", "type": "array", "required": true, "description": "添加规则IP列表", "item_type": "string" }, { "name": "Rules", "type": "array", "required": true, "description": "规则列表", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "转发协议，取值[TCP, UDP]" }, { "name": "VirtualPort", "type": "integer", "required": true, "description": "转发端口" }, { "name": "SourcePort", "type": "integer", "required": true, "description": "源站端口" }, { "name": "SourceType", "type": "integer", "required": true, "description": "回源方式，取值[1(域名回源)，2(IP回源)]" }, { "name": "KeepTime", "type": "integer", "required": true, "description": "会话保持时间，单位秒" }, { "name": "SourceList", "type": "array", "required": true, "description": "回源列表", "item_type": "object", "children": [ { "name": "Source", "type": "string", "required": true, "description": "回源IP或域名" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重值，取值[0,100]" } ] }, { "name": "LbType", "type": "integer", "required": true, "description": "负载均衡方式，取值[1(加权轮询)，2(源IP hash)]" }, { "name": "KeepEnable", "type": "integer", "required": true, "description": "会话保持开关，取值[0(会话保持关闭)，1(会话保持开启)]；" }, { "name": "RuleId", "type": "string", "required": false, "description": "规则ID" }, { "name": "RuleName", "type": "string", "required": false, "description": "规则描述" }, { "name": "RemoveSwitch", "type": "integer", "required": false, "description": "移除水印状态，取值[0(关闭)，1(开启)]" } ] } ], "required": [ "Business", "IdList", "VipList", "Rules" ] }, { "name": "CreateNewL7Rules", "description": "添加7层转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP）" }, { "name": "IdList", "type": "array", "required": true, "description": "资源ID列表", "item_type": "string" }, { "name": "VipList", "type": "array", "required": true, "description": "资源IP列表", "item_type": "string" }, { "name": "Rules", "type": "array", "required": true, "description": "规则列表", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "转发协议，取值[http, https]" }, { "name": "Domain", "type": "string", "required": true, "description": "转发域名" }, { "name": "SourceType", "type": "integer", "required": true, "description": "回源方式，取值[1(域名回源)，2(IP回源)]" }, { "name": "KeepTime", "type": "integer", "required": true, "description": "会话保持时间，单位秒" }, { "name": "SourceList", "type": "array", "required": true, "description": "回源列表", "item_type": "object", "children": [ { "name": "Source", "type": "string", "required": true, "description": "回源IP或域名" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重值，取值[0,100]" } ] }, { "name": "LbType", "type": "integer", "required": true, "description": "负载均衡方式，取值[1(加权轮询)]" }, { "name": "KeepEnable", "type": "integer", "required": true, "description": "会话保持开关，取值[0(会话保持关闭)，1(会话保持开启)]" }, { "name": "RuleId", "type": "string", "required": false, "description": "规则ID，当添加新规则时可以不用填写此字段；当修改或者删除规则时需要填写此字段；" }, { "name": "CertType", "type": "integer", "required": false, "description": "证书来源，当转发协议为https时必须填，取值[2(腾讯云托管证书)]，当转发协议为http时也可以填0" }, { "name": "SSLId", "type": "string", "required": false, "description": "当证书来源为腾讯云托管证书时，此字段必须填写托管证书ID" }, { "name": "Cert", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书内容；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)" }, { "name": "PrivateKey", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书密钥；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)" }, { "name": "RuleName", "type": "string", "required": false, "description": "规则描述" }, { "name": "Status", "type": "integer", "required": false, "description": "规则状态，取值[0(规则配置成功)，1(规则配置生效中)，2(规则配置失败)，3(规则删除生效中)，5(规则删除失败)，6(规则等待配置)，7(规则等待删除)，8(规则待配置证书)]" }, { "name": "CCStatus", "type": "integer", "required": false, "description": "cc防护状态，取值[0(关闭), 1(开启)]" }, { "name": "CCEnable", "type": "integer", "required": false, "description": "HTTPS协议的CC防护状态，取值[0(关闭), 1(开启)]" }, { "name": "CCThreshold", "type": "integer", "required": false, "description": "HTTPS协议的CC防护阈值" }, { "name": "CCLevel", "type": "string", "required": false, "description": "HTTPS协议的CC防护等级" }, { "name": "HttpsToHttpEnable", "type": "integer", "required": false, "description": "是否开启Https协议使用Http回源，取值[0(关闭), 1(开启)]，不填写默认是关闭 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "VirtualPort", "type": "integer", "required": false, "description": "接入端口值 注意：此字段可能返回 null，表示取不到有效值。" } ] } ], "required": [ "Business", "IdList", "VipList", "Rules" ] }, { "name": "CreateNewL7RulesUpload", "description": "批量上传7层转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP）" }, { "name": "IdList", "type": "array", "required": true, "description": "资源ID列表", "item_type": "string" }, { "name": "VipList", "type": "array", "required": true, "description": "资源IP列表", "item_type": "string" }, { "name": "Rules", "type": "array", "required": true, "description": "规则列表", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "转发协议，取值[http, https]" }, { "name": "Domain", "type": "string", "required": true, "description": "转发域名" }, { "name": "SourceType", "type": "integer", "required": true, "description": "回源方式，取值[1(域名回源)，2(IP回源)]" }, { "name": "KeepTime", "type": "integer", "required": true, "description": "会话保持时间，单位秒" }, { "name": "SourceList", "type": "array", "required": true, "description": "回源列表", "item_type": "object", "children": [ { "name": "Source", "type": "string", "required": true, "description": "回源IP或域名" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重值，取值[0,100]" } ] }, { "name": "LbType", "type": "integer", "required": true, "description": "负载均衡方式，取值[1(加权轮询)]" }, { "name": "KeepEnable", "type": "integer", "required": true, "description": "会话保持开关，取值[0(会话保持关闭)，1(会话保持开启)]" }, { "name": "RuleId", "type": "string", "required": false, "description": "规则ID，当添加新规则时可以不用填写此字段；当修改或者删除规则时需要填写此字段；" }, { "name": "CertType", "type": "integer", "required": false, "description": "证书来源，当转发协议为https时必须填，取值[2(腾讯云托管证书)]，当转发协议为http时也可以填0" }, { "name": "SSLId", "type": "string", "required": false, "description": "当证书来源为腾讯云托管证书时，此字段必须填写托管证书ID" }, { "name": "Cert", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书内容；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)" }, { "name": "PrivateKey", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书密钥；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)" }, { "name": "RuleName", "type": "string", "required": false, "description": "规则描述" }, { "name": "Status", "type": "integer", "required": false, "description": "规则状态，取值[0(规则配置成功)，1(规则配置生效中)，2(规则配置失败)，3(规则删除生效中)，5(规则删除失败)，6(规则等待配置)，7(规则等待删除)，8(规则待配置证书)]" }, { "name": "CCStatus", "type": "integer", "required": false, "description": "cc防护状态，取值[0(关闭), 1(开启)]" }, { "name": "CCEnable", "type": "integer", "required": false, "description": "HTTPS协议的CC防护状态，取值[0(关闭), 1(开启)]" }, { "name": "CCThreshold", "type": "integer", "required": false, "description": "HTTPS协议的CC防护阈值" }, { "name": "CCLevel", "type": "string", "required": false, "description": "HTTPS协议的CC防护等级" }, { "name": "HttpsToHttpEnable", "type": "integer", "required": false, "description": "是否开启Https协议使用Http回源，取值[0(关闭), 1(开启)]，不填写默认是关闭 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "VirtualPort", "type": "integer", "required": false, "description": "接入端口值 注意：此字段可能返回 null，表示取不到有效值。" } ] } ], "required": [ "Business", "IdList", "VipList", "Rules" ] }, { "name": "CreateUnblockIp", "description": "IP解封操作", "status": "online", "parameters": [ { "name": "Ip", "type": "string", "required": true, "description": "IP" }, { "name": "ActionType", "type": "string", "required": true, "description": "解封类型（user：自助解封；auto：自动解封； update：升级解封；bind：绑定高防包解封）" } ], "required": [ "Ip", "ActionType" ] }, { "name": "DeleteCCFrequencyRules", "description": "删除CC防护的访问频率控制规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "CCFrequencyRuleId", "type": "string", "required": true, "description": "CC防护的访问频率控制规则ID" } ], "required": [ "Business", "CCFrequencyRuleId" ] }, { "name": "DeleteCCSelfDefinePolicy", "description": "删除CC自定义策略", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "SetId", "type": "string", "required": true, "description": "策略ID" } ], "required": [ "Business", "Id", "SetId" ] }, { "name": "DeleteDDoSPolicy", "description": "删除DDoS高级策略", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "PolicyId", "type": "string", "required": true, "description": "策略ID" } ], "required": [ "Business", "PolicyId" ] }, { "name": "DeleteDDoSPolicyCase", "description": "删除策略场景", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "SceneId", "type": "string", "required": true, "description": "策略场景ID" } ], "required": [ "Business", "SceneId" ] }, { "name": "DeleteL4Rules", "description": "删除四层转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "RuleIdList", "type": "array", "required": true, "description": "规则ID列表", "item_type": "string" } ], "required": [ "Business", "Id", "RuleIdList" ] }, { "name": "DeleteL7Rules", "description": "删除七层转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "RuleIdList", "type": "array", "required": true, "description": "规则ID列表", "item_type": "string" } ], "required": [ "Business", "Id", "RuleIdList" ] }, { "name": "DeleteNewL4Rules", "description": "删除L4转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP）" }, { "name": "Rule", "type": "array", "required": true, "description": "删除接口结构体", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": true, "description": "资源Id" }, { "name": "Ip", "type": "string", "required": true, "description": "资源IP" }, { "name": "RuleIdList", "type": "array", "required": true, "description": "规则Id", "item_type": "string" } ] } ], "required": [ "Business", "Rule" ] }, { "name": "DeleteNewL7Rules", "description": "删除L7转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP)" }, { "name": "Rule", "type": "array", "required": true, "description": "删除规则列表", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": true, "description": "资源Id" }, { "name": "Ip", "type": "string", "required": true, "description": "资源IP" }, { "name": "RuleIdList", "type": "array", "required": true, "description": "规则Id", "item_type": "string" } ] } ], "required": [ "Business", "Rule" ] }, { "name": "DescribeActionLog", "description": "获取操作日志", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间" }, { "name": "Business", "type": "string", "required": false, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Filter", "type": "string", "required": false, "description": "搜索值，只支持资源ID或用户UIN" }, { "name": "Limit", "type": "integer", "required": false, "description": "一页条数，填0表示不分页" }, { "name": "Offset", "type": "integer", "required": false, "description": "页起始偏移，取值为(页码-1)*一页条数" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeBGPIPL7RuleMaxCnt", "description": "获取高防IP可添加的最多7层规则数量", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP）" }, { "name": "Id", "type": "string", "required": true, "description": "资源实例ID" } ], "required": [ "Business", "Id" ] }, { "name": "DescribeBaradData", "description": "为大禹子产品提供业务转发指标数据的接口", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源实例ID" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标名，取值： connum表示TCP活跃连接数； new_conn表示新建TCP连接数； inactive_conn表示非活跃连接数; intraffic表示入流量； outtraffic表示出流量； alltraffic表示出流量和入流量之和； inpkg表示入包速率； outpkg表示出包速率；" }, { "name": "Period", "type": "integer", "required": true, "description": "统计时间粒度，单位秒（300表示5分钟；3600表示小时；86400表示天）" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间，秒部分保持为0，分钟部分为5的倍数" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间，秒部分保持为0，分钟部分为5的倍数" }, { "name": "Statistics", "type": "string", "required": true, "description": "统计方式，取值： max表示最大值； min表示最小值； avg表示均值；" }, { "name": "ProtocolPort", "type": "array", "required": false, "description": "协议端口数组", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议（tcp；udp）" }, { "name": "Port", "type": "integer", "required": true, "description": "端口" } ] }, { "name": "Ip", "type": "string", "required": false, "description": "资源实例下的IP，只有当Business=net(高防IP专业版)时才必须填写资源的一个IP（因为高防IP专业版资源实例有多个IP，才需要指定）；" } ], "required": [ "Business", "Id", "MetricName", "Period", "StartTime", "EndTime", "Statistics" ] }, { "name": "DescribeBasicCCThreshold", "description": "获取基础防护CC防护阈值", "status": "online", "parameters": [ { "name": "BasicIp", "type": "string", "required": true, "description": "查询的IP地址，取值如：1.1.1.1" }, { "name": "BasicRegion", "type": "string", "required": true, "description": "查询IP所属地域，取值如：gz、bj、sh、hk等地域缩写" }, { "name": "BasicBizType", "type": "string", "required": true, "description": "专区类型，取值如：公有云专区：public，黑石专区：bm, NAT服务器专区：nat，互联网通道：channel。" }, { "name": "BasicDeviceType", "type": "string", "required": true, "description": "设备类型，取值如：服务器：cvm，公有云负载均衡：clb，黑石负载均衡：lb，NAT服务器：nat，互联网通道：channel." }, { "name": "BasicIpInstance", "type": "string", "required": false, "description": "可选，IPInstance Nat 网关（如果查询的设备类型是NAT服务器，需要传此参数，通过nat资源查询接口获取）" }, { "name": "BasicIspCode", "type": "integer", "required": false, "description": "可选，运营商线路（如果查询的设备类型是NAT服务器，需要传此参数为5）" } ], "required": [ "BasicIp", "BasicRegion", "BasicBizType", "BasicDeviceType" ] }, { "name": "DescribeBasicDeviceThreshold", "description": "获取基础防护黑洞阈值", "status": "online", "parameters": [ { "name": "BasicIp", "type": "string", "required": true, "description": "查询的IP地址，取值如：1.1.1.1" }, { "name": "BasicRegion", "type": "string", "required": true, "description": "查询IP所属地域，取值如：gz、bj、sh、hk等地域缩写" }, { "name": "BasicBizType", "type": "string", "required": true, "description": "专区类型，取值如：公有云专区：public，黑石专区：bm, NAT服务器专区：nat，互联网通道：channel。" }, { "name": "BasicDeviceType", "type": "string", "required": true, "description": "设备类型，取值如：服务器：cvm，公有云负载均衡：clb，黑石负载均衡：lb，NAT服务器：nat，互联网通道：channel." }, { "name": "BasicCheckFlag", "type": "integer", "required": true, "description": "有效性检查，取值为1" }, { "name": "BasicIpInstance", "type": "string", "required": false, "description": "可选，IPInstance Nat 网关（如果查询的设备类型是NAT服务器，需要传此参数，通过nat资源查询接口获取）" }, { "name": "BasicIspCode", "type": "integer", "required": false, "description": "可选，运营商线路（如果查询的设备类型是NAT服务器，需要传此参数为5）" } ], "required": [ "BasicIp", "BasicRegion", "BasicBizType", "BasicDeviceType", "BasicCheckFlag" ] }, { "name": "DescribeBizHttpStatus", "description": "获取业务流量状态码统计", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP）", "example": "bgpip" }, { "name": "Id", "type": "string", "required": true, "description": "资源Id", "example": "bgpip-000000xe" }, { "name": "Period", "type": "integer", "required": true, "description": "统计周期，可取值300，1800，3600， 21600，86400，单位秒", "example": "300" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间", "example": "2020-02-01 12:04:12" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间", "example": "2020-02-03 18:03:23" }, { "name": "Statistics", "type": "string", "required": true, "description": "统计方式，仅支持sum", "example": "sum" }, { "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）" }, { "name": "Port", "type": "integer", "required": true, "description": "端口" } ] }, { "name": "Domain", "type": "string", "required": false, "description": "特定域名查询", "example": "www.xx.com" } ], "required": [ "Business", "Id", "Period", "StartTime", "EndTime", "Statistics" ] }, { "name": "DescribeBizTrend", "description": "获取业务流量曲线", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP）" }, { "name": "Id", "type": "string", "required": true, "description": "资源实例ID" }, { "name": "Period", "type": "integer", "required": true, "description": "统计周期，可取值300，1800，3600，21600，86400，单位秒" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间" }, { "name": "Statistics", "type": "string", "required": true, "description": "统计方式，可取值max, min, avg, sum, 如统计纬度是流量速率或包量速率，仅可取值max" }, { "name": "MetricName", "type": "string", "required": true, "description": "统计纬度，可取值connum, new_conn, inactive_conn, intraffic, outtraffic, inpkg, outpkg, qps" }, { "name": "ProtoInfo", "type": "array", "required": false, "description": "协议及端口列表，协议可取值TCP, UDP, HTTP, HTTPS，仅统计纬度为连接数时有效", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议（tcp；udp）" }, { "name": "Port", "type": "integer", "required": true, "description": "端口" } ] }, { "name": "Domain", "type": "string", "required": false, "description": "统计纬度为qps时，可选特定域名查询" } ], "required": [ "Business", "Id", "Period", "StartTime", "EndTime", "Statistics", "MetricName" ] }, { "name": "DescribeCCAlarmThreshold", "description": "获取高防包、高防IP、高防IP专业版、棋牌盾产品设置CC攻击的告警通知阈值", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（shield表示棋牌；bgpip表示高防IP；bgp表示高防包；bgp-multip表示多ip高防包；net表示高防IP专业版）" }, { "name": "RsId", "type": "string", "required": true, "description": "资源ID,字符串类型" } ], "required": [ "Business", "RsId" ] }, { "name": "DescribeCCEvList", "description": "获取CC攻击事件列表", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版；basic表示DDoS基础防护）" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间" }, { "name": "Id", "type": "string", "required": false, "description": "资源实例ID" }, { "name": "IpList", "type": "array", "required": false, "description": "资源实例的IP，当business不为basic时，如果IpList不为空则Id也必须不能为空；", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "一页条数，填0表示不分页" }, { "name": "Offset", "type": "integer", "required": false, "description": "页起始偏移，取值为(页码-1)*一页条数" } ], "required": [ "Business", "StartTime", "EndTime" ] }, { "name": "DescribeCCFrequencyRules", "description": "获取CC防护的访问频率控制规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "RuleId", "type": "string", "required": true, "description": "7层转发规则ID（通过获取7层转发规则接口可以获取规则ID）；当填写时表示获取转发规则的访问频率控制规则；" } ], "required": [ "Business", "Id", "RuleId" ] }, { "name": "DescribeCCIpAllowDeny", "description": "获取CC的IP黑白名单", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Type", "type": "array", "required": true, "description": "黑或白名单，取值[white(白名单)，black(黑名单)] 注意：此数组只能有一个值，不能同时获取黑名单和白名单", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页参数" }, { "name": "Protocol", "type": "string", "required": false, "description": "可选，代表HTTP协议或HTTPS协议的CC防护，取值[http（HTTP协议的CC防护），https（HTTPS协议的CC防护）]；" } ], "required": [ "Business", "Id", "Type" ] }, { "name": "DescribeCCSelfDefinePolicy", "description": "获取CC自定义策略", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgp高防包；bgp-multip共享包）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Limit", "type": "integer", "required": false, "description": "拉取的条数" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量" } ], "required": [ "Business", "Id" ] }, { "name": "DescribeCCTrend", "description": "获取CC攻击指标数据，包括总请求峰值(QPS)和攻击请求(QPS)", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版；basic表示DDoS基础防护）" }, { "name": "Ip", "type": "string", "required": true, "description": "资源的IP" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标，取值[inqps(总请求峰值，dropqps(攻击请求峰值))]" }, { "name": "Period", "type": "integer", "required": true, "description": "统计粒度，取值[300(5分钟)，3600(小时)，86400(天)]" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间" }, { "name": "Id", "type": "string", "required": false, "description": "资源实例ID，当Business为basic时，此字段不用填写（因为基础防护没有资源实例）" }, { "name": "Domain", "type": "string", "required": false, "description": "域名，可选" } ], "required": [ "Business", "Ip", "MetricName", "Period", "StartTime", "EndTime" ] }, { "name": "DescribeCCUrlAllow", "description": "获取CC的Url白名单", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Type", "type": "array", "required": true, "description": "黑或白名单，取值[white(白名单)]，目前只支持白名单 注意：此数组只能有一个值，且只能为white", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页参数" }, { "name": "Protocol", "type": "string", "required": false, "description": "可选，代表HTTP协议或HTTPS协议的CC防护，取值[http（HTTP协议的CC防护），https（HTTPS协议的CC防护）]；" } ], "required": [ "Business", "Id", "Type" ] }, { "name": "DescribeDDoSAlarmThreshold", "description": "获取高防包、高防IP、高防IP专业版、棋牌盾产品设置DDoS攻击的告警通知阈值", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（shield表示棋牌；bgpip表示高防IP；bgp表示高防包；bgp-multip表示多ip高防包；net表示高防IP专业版）" }, { "name": "RsId", "type": "string", "required": true, "description": "资源ID,字符串类型" } ], "required": [ "Business", "RsId" ] }, { "name": "DescribeDDoSAttackIPRegionMap", "description": "获取DDoS攻击源IP地域分布图，支持全球攻击分布和国内省份攻击分布；", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（shield表示棋牌；bgpip表示高防IP；bgp表示高防包；bgp-multip表示多ip高防包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间，最大可统计的时间范围是半年；" }, { "name": "IpList", "type": "array", "required": false, "description": "指定资源的特定IP的攻击源，可选", "item_type": "string" } ], "required": [ "Business", "Id", "StartTime", "EndTime" ] }, { "name": "DescribeDDoSAttackSource", "description": "获取DDoS攻击源列表", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "StartTime", "type": "string", "required": true, "description": "起始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页条数，填0表示不分页" }, { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数" }, { "name": "IpList", "type": "array", "required": false, "description": "获取指定资源的特定ip的攻击源，可选", "item_type": "string" } ], "required": [ "Business", "Id", "StartTime", "EndTime", "Limit", "Offset" ] }, { "name": "DescribeDDoSCount", "description": "获取DDoS攻击占比分析", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Ip", "type": "string", "required": true, "description": "资源的IP" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标，取值[traffic（攻击协议流量, 单位KB）, pkg（攻击协议报文数）, classnum（攻击事件次数）]" } ], "required": [ "Business", "Id", "Ip", "StartTime", "EndTime", "MetricName" ] }, { "name": "DescribeDDoSDefendStatus", "description": "获取DDoS防护状态（临时关闭状态），支持产品：基础防护，独享包，共享包，高防IP，高防IP专业版；调用此接口是获取当前是否有设置临时关闭DDoS防护状态，如果有设置会返回临时关闭的时长等参数。", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（basic表示基础防护；bgp表示独享包；bgp-multip表示共享包；bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": false, "description": "资源实例ID，只有当Business不是基础防护时才需要填写此字段；" }, { "name": "Ip", "type": "string", "required": false, "description": "基础防护的IP，只有当Business为基础防护时才需要填写此字段；" }, { "name": "BizType", "type": "string", "required": false, "description": "只有当Business为基础防护时才需要填写此字段，IP所属的产品类型，取值[public（CVM产品），bm（黑石产品），eni（弹性网卡），vpngw（VPN网关）， natgw（NAT网关），waf（Web应用安全产品），fpc（金融产品），gaap（GAAP产品）, other(托管IP)]" }, { "name": "DeviceType", "type": "string", "required": false, "description": "只有当Business为基础防护时才需要填写此字段，IP所属的产品子类，取值[cvm（CVM），lb（负载均衡器），eni（弹性网卡），vpngw（VPN），natgw（NAT），waf（WAF），fpc（金融），gaap（GAAP），other（托管IP），eip（黑石弹性IP）]" }, { "name": "InstanceId", "type": "string", "required": false, "description": "只有当Business为基础防护时才需要填写此字段，IP所属的资源实例ID，当绑定新IP时必须填写此字段；例如是弹性网卡的IP，则InstanceId填写弹性网卡的ID(eni-*);" }, { "name": "IPRegion", "type": "string", "required": false, "description": "只有当Business为基础防护时才需要填写此字段，表示IP所属的地域，取值： \"bj\": 华北地区(北京) \"cd\": 西南地区(成都) \"cq\": 西南地区(重庆) \"gz\": 华南地区(广州) \"gzopen\": 华南地区(广州Open) \"hk\": 中国香港 \"kr\": 东南亚地区(首尔) \"sh\": 华东地区(上海) \"shjr\": 华东地区(上海金融) \"szjr\": 华南地区(深圳金融) \"sg\": 东南亚地区(新加坡) \"th\": 东南亚地区(泰国) \"de\": 欧洲地区(德国) \"usw\": 美国西部（\ufffd..." } ], "required": [ "Business" ] }, { "name": "DescribeDDoSEvInfo", "description": "获取DDoS攻击事件详情", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Ip", "type": "string", "required": true, "description": "资源的IP" }, { "name": "StartTime", "type": "string", "required": true, "description": "攻击开始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "攻击结束时间" } ], "required": [ "Business", "Id", "Ip", "StartTime", "EndTime" ] }, { "name": "DescribeDDoSEvList", "description": "获取DDoS攻击事件列表", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版；basic表示DDoS基础防护）" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间" }, { "name": "Id", "type": "string", "required": false, "description": "资源实例ID，当Business为basic时，此字段不用填写（因为基础防护没有资源实例）" }, { "name": "IpList", "type": "array", "required": false, "description": "资源的IP", "item_type": "string" }, { "name": "OverLoad", "type": "string", "required": false, "description": "是否超过弹性防护峰值，取值[yes(是)，no(否)]，填写空字符串时表示不进行过滤" }, { "name": "Limit", "type": "integer", "required": false, "description": "一页条数，填0表示不分页" }, { "name": "Offset", "type": "integer", "required": false, "description": "页起始偏移，取值为(页码-1)*一页条数" } ], "required": [ "Business", "StartTime", "EndTime" ] }, { "name": "DescribeDDoSIpLog", "description": "获取DDoSIP攻击日志", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Ip", "type": "string", "required": true, "description": "资源的IP" }, { "name": "StartTime", "type": "string", "required": true, "description": "攻击开始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "攻击结束时间" } ], "required": [ "Business", "Id", "Ip", "StartTime", "EndTime" ] }, { "name": "DescribeDDoSNetCount", "description": "获取高防IP专业版资源的DDoS攻击占比分析", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标，取值[traffic（攻击协议流量, 单位KB）, pkg（攻击协议报文数）, classnum（攻击事件次数）]" } ], "required": [ "Business", "Id", "StartTime", "EndTime", "MetricName" ] }, { "name": "DescribeDDoSNetEvInfo", "description": "获取高防IP专业版资源的DDoS攻击事件详情", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "StartTime", "type": "string", "required": true, "description": "攻击开始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "攻击结束时间" } ], "required": [ "Business", "Id", "StartTime", "EndTime" ] }, { "name": "DescribeDDoSNetEvList", "description": "获取高防IP专业版资源的DDoS攻击事件列表", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间" }, { "name": "Limit", "type": "integer", "required": false, "description": "一页条数，填0表示不分页" }, { "name": "Offset", "type": "integer", "required": false, "description": "页起始偏移，取值为(页码-1)*一页条数" } ], "required": [ "Business", "Id", "StartTime", "EndTime" ] }, { "name": "DescribeDDoSNetIpLog", "description": "获取高防IP专业版资源的DDoSIP攻击日志", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "StartTime", "type": "string", "required": true, "description": "攻击开始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "攻击结束时间" } ], "required": [ "Business", "Id", "StartTime", "EndTime" ] }, { "name": "DescribeDDoSNetTrend", "description": "获取高防IP专业版资源的DDoS攻击指标数据", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标，取值[bps(攻击流量带宽，pps(攻击包速率))]" }, { "name": "Period", "type": "integer", "required": true, "description": "统计粒度，取值[300(5分钟)，3600(小时)，86400(天)]" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间" } ], "required": [ "Business", "Id", "MetricName", "Period", "StartTime", "EndTime" ] }, { "name": "DescribeDDoSPolicy", "description": "获取DDoS高级策略", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": false, "description": "可选字段，资源ID，如果填写则表示该资源绑定的DDoS高级策略" } ], "required": [ "Business" ] }, { "name": "DescribeDDoSTrend", "description": "获取DDoS攻击流量带宽和攻击包速率数据", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版；basic表示DDoS基础防护）" }, { "name": "Ip", "type": "string", "required": true, "description": "资源实例的IP" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标，取值[bps(攻击流量带宽，pps(攻击包速率))]" }, { "name": "Period", "type": "integer", "required": true, "description": "统计粒度，取值[300(5分钟)，3600(小时)，86400(天)]" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间" }, { "name": "Id", "type": "string", "required": false, "description": "资源实例ID，当Business为basic时，此字段不用填写（因为基础防护没有资源实例）" } ], "required": [ "Business", "Ip", "MetricName", "Period", "StartTime", "EndTime" ] }, { "name": "DescribeDDoSUsedStatis", "description": "统计用户的高防资源的使用天数和DDoS攻击防护次数", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP）" } ], "required": [ "Business" ] }, { "name": "DescribeIPProductInfo", "description": "获取独享包或共享包IP对应的云资产信息，只支持独享包和共享包的IP", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgp表示独享包；bgp-multip表示共享包）" }, { "name": "IpList", "type": "array", "required": true, "description": "IP列表", "item_type": "string" } ], "required": [ "Business", "IpList" ] }, { "name": "DescribeInsurePacks", "description": "获取保险包套餐列表", "status": "online", "parameters": [ { "name": "IdList", "type": "array", "required": false, "description": "可选字段，保险包套餐ID，当要获取指定ID（例如insure-000000xe）的保险包套餐时请填写此字段；", "item_type": "string" } ], "required": [] }, { "name": "DescribeIpBlockList", "description": "获取IP封堵列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeIpUnBlockList", "description": "获取IP解封记录", "status": "online", "parameters": [ { "name": "BeginTime", "type": "string", "required": true, "description": "开始时间" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间" }, { "name": "Ip", "type": "string", "required": false, "description": "IP（不为空时，进行IP过滤）" }, { "name": "Paging", "type": "object", "required": false, "description": "分页参数（不为空时，进行分页查询），此字段后面会弃用，请用Limit和Offset字段代替；", "children": [ { "name": "Offset", "type": "integer", "required": true, "description": "起始位置" }, { "name": "Limit", "type": "integer", "required": true, "description": "数量" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "一页条数，填0表示不分页" }, { "name": "Offset", "type": "integer", "required": false, "description": "页起始偏移，取值为(页码-1)*一页条数" } ], "required": [ "BeginTime", "EndTime" ] }, { "name": "DescribeL4HealthConfig", "description": "导出四层健康检查配置", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "RuleIdList", "type": "array", "required": false, "description": "规则ID数组，当导出所有规则的健康检查配置则不填或填空数组；", "item_type": "string" } ], "required": [ "Business", "Id" ] }, { "name": "DescribeL4RulesErrHealth", "description": "获取L4转发规则健康检查异常结果", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" } ], "required": [ "Business", "Id" ] }, { "name": "DescribeL7HealthConfig", "description": "导出七层健康检查配置", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "RuleIdList", "type": "array", "required": false, "description": "规则ID数组，当导出所有规则的健康检查配置则不填或填空数组；", "item_type": "string" } ], "required": [ "Business", "Id" ] }, { "name": "DescribeNewL4Rules", "description": "获取L4转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP）" }, { "name": "Ip", "type": "string", "required": false, "description": "指定IP查询" }, { "name": "VirtualPort", "type": "integer", "required": false, "description": "指定高防IP端口查询" }, { "name": "Limit", "type": "integer", "required": false, "description": "一页条数，填0表示不分页" }, { "name": "Offset", "type": "integer", "required": false, "description": "页起始偏移，取值为(页码-1)*一页条数" } ], "required": [ "Business" ] }, { "name": "DescribeNewL4RulesErrHealth", "description": "获取L4转发规则健康检查异常结果", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP）" }, { "name": "RuleIdList", "type": "array", "required": false, "description": "规则ID列表", "item_type": "string" } ], "required": [ "Business" ] }, { "name": "DescribeNewL7RulesErrHealth", "description": "获取L7转发规则健康检查异常结果", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP)" }, { "name": "RuleIdList", "type": "array", "required": false, "description": "规则Id列表", "item_type": "string" } ], "required": [ "Business" ] }, { "name": "DescribePackIndex", "description": "获取产品总览统计，支持高防包、高防IP、高防IP专业版；", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示高防包；net表示高防IP专业版）" } ], "required": [ "Business" ] }, { "name": "DescribePcap", "description": "下载攻击事件的pcap包", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源实例ID" }, { "name": "StartTime", "type": "string", "required": true, "description": "攻击事件的开始时间，格式为\"2018-08-28 07:00:00\"" }, { "name": "EndTime", "type": "string", "required": true, "description": "攻击事件的结束时间，格式为\"2018-08-28 07:02:00\"" }, { "name": "Ip", "type": "string", "required": false, "description": "资源的IP，只有当Business为net时才需要填写资源实例下的IP；" } ], "required": [ "Business", "Id", "StartTime", "EndTime" ] }, { "name": "DescribePolicyCase", "description": "获取策略场景", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "SceneId", "type": "string", "required": false, "description": "策略场景ID" } ], "required": [ "Business" ] }, { "name": "DescribeResIpList", "description": "获取资源的IP列表", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "IdList", "type": "array", "required": false, "description": "资源ID, 如果不填，则获取用户所有资源的IP", "item_type": "string" } ], "required": [ "Business" ] }, { "name": "DescribeResourceList", "description": "获取资源列表", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgp表示独享包；bgp-multip表示共享包；bgpip表示高防IP；net表示高防IP专业版）", "example": "bgpip" }, { "name": "RegionList", "type": "array", "required": false, "description": "地域码搜索，可选，当不指定地域时空数组，当指定地域时，填地域码。例如：[\"gz\", \"sh\"]", "example": "gz", "item_type": "string" }, { "name": "Line", "type": "array", "required": false, "description": "线路搜索，可选，只有当获取高防IP资源列表是可以选填，取值为[1（BGP线路），2（南京电信），3（南京联通），99（第三方合作线路）]，当获取其他产品时请填空数组；", "example": "1", "item_type": "integer" }, { "name": "IdList", "type": "array", "required": false, "description": "资源ID搜索，可选，当不为空数组时表示获取指定资源的资源列表；", "example": "无", "item_type": "string" }, { "name": "Name", "type": "string", "required": false, "description": "资源名称搜索，可选，当不为空字符串时表示按名称搜索资源；", "example": "无" }, { "name": "IpList", "type": "array", "required": false, "description": "IP搜索列表，可选，当不为空时表示按照IP搜索资源；", "example": "无", "item_type": "string" }, { "name": "Status", "type": "array", "required": false, "description": "资源状态搜索列表，可选，取值为[0（运行中）, 1（清洗中）, 2（封堵中）]，当填空数组时不进行状态搜索；", "example": "无", "item_type": "integer" }, { "name": "Expire", "type": "integer", "required": false, "description": "即将到期搜索；可选，取值为[0（不搜索），1（搜索即将到期的资源）]", "example": "无" }, { "name": "OderBy", "type": "array", "required": false, "description": "排序字段，可选", "example": "无", "item_type": "object", "children": [ { "name": "Field", "type": "string", "required": true, "description": "排序字段名称，取值[ bandwidth（带宽）， overloadCount（超峰值次数） ]" }, { "name": "Order", "type": "string", "required": true, "description": "升降序，取值为[asc（升序），（升序），desc（降序）， DESC（降序）]" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "一页条数，填0表示不分页", "example": "无" }, { "name": "Offset", "type": "integer", "required": false, "description": "页起始偏移，取值为(页码-1)*一页条数", "example": "无" }, { "name": "CName", "type": "string", "required": false, "description": "高防IP专业版资源的CNAME，可选，只对高防IP专业版资源列表有效；", "example": "无" }, { "name": "Domain", "type": "string", "required": false, "description": "高防IP专业版资源的域名，可选，只对高防IP专业版资源列表有效；", "example": "无" } ], "required": [ "Business" ] }, { "name": "DescribeRuleSets", "description": "获取资源的规则数", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "IdList", "type": "array", "required": true, "description": "资源ID列表", "item_type": "string" } ], "required": [ "Business", "IdList" ] }, { "name": "DescribeSchedulingDomainList", "description": "获取调度域名列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "一页条数，填0表示不分页" }, { "name": "Offset", "type": "integer", "required": true, "description": "页起始偏移，取值为(页码-1)*一页条数" }, { "name": "Domain", "type": "string", "required": false, "description": "可选，筛选特定的域名" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeSecIndex", "description": "获取本月安全统计", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeSourceIpSegment", "description": "获取回源IP段，支持的产品：高防IP，高防IP专业版；", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" } ], "required": [ "Business", "Id" ] }, { "name": "DescribeTransmitStatis", "description": "获取业务转发统计数据，支持转发流量和转发包速率", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版；bgp表示独享包；bgp-multip表示共享包）" }, { "name": "Id", "type": "string", "required": true, "description": "资源实例ID" }, { "name": "MetricName", "type": "string", "required": true, "description": "指标名，取值： traffic表示流量带宽； pkg表示包速率；" }, { "name": "Period", "type": "integer", "required": true, "description": "统计时间粒度（300表示5分钟；3600表示小时；86400表示天）" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计开始时间，秒部分保持为0，分钟部分为5的倍数" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计结束时间，秒部分保持为0，分钟部分为5的倍数" }, { "name": "IpList", "type": "array", "required": false, "description": "资源的IP（当Business为bgp-multip时必填，且仅支持一个IP）；当不填写时，默认统计资源实例的所有IP；资源实例有多个IP（比如高防IP专业版）时，统计方式是求和；", "item_type": "string" } ], "required": [ "Business", "Id", "MetricName", "Period", "StartTime", "EndTime" ] }, { "name": "DescribeUnBlockStatis", "description": "获取黑洞解封次数", "status": "online", "parameters": [], "required": [] }, { "name": "DescribleL4Rules", "description": "获取四层转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "RuleIdList", "type": "array", "required": false, "description": "规则ID，可选参数，填写后获取指定的规则", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "一页条数，填0表示不分页" }, { "name": "Offset", "type": "integer", "required": false, "description": "页起始偏移，取值为(页码-1)*一页条数" } ], "required": [ "Business", "Id" ] }, { "name": "DescribleL7Rules", "description": "获取七层转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "RuleIdList", "type": "array", "required": false, "description": "规则ID，可选参数，填写后获取指定的规则", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "一页条数，填0表示不分页" }, { "name": "Offset", "type": "integer", "required": false, "description": "页起始偏移，取值为(页码-1)*一页条数" }, { "name": "Domain", "type": "string", "required": false, "description": "域名搜索，选填，当需要搜索域名请填写" }, { "name": "ProtocolList", "type": "array", "required": false, "description": "转发协议搜索，选填，取值[http, https, http/https]", "item_type": "string" }, { "name": "StatusList", "type": "array", "required": false, "description": "状态搜索，选填，取值[0(规则配置成功)，1(规则配置生效中)，2(规则配置失败)，3(规则删除生效中)，5(规则删除失败)，6(规则等待配置)，7(规则等待删除)，8(规则待配置证书)]", "item_type": "integer" } ], "required": [ "Business", "Id" ] }, { "name": "DescribleNewL7Rules", "description": "获取7层规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP）" }, { "name": "Limit", "type": "integer", "required": false, "description": "一页条数，填0表示不分页" }, { "name": "Offset", "type": "integer", "required": false, "description": "页起始偏移，取值为(页码-1)*一页条数" }, { "name": "Domain", "type": "string", "required": false, "description": "域名搜索，选填，当需要搜索域名请填写" }, { "name": "ProtocolList", "type": "array", "required": false, "description": "转发协议搜索，选填，取值[http, https, http/https]", "item_type": "string" }, { "name": "StatusList", "type": "array", "required": false, "description": "状态搜索，选填，取值[0(规则配置成功)，1(规则配置生效中)，2(规则配置失败)，3(规则删除生效中)，5(规则删除失败)，6(规则等待配置)，7(规则等待删除)，8(规则待配置证书)]", "item_type": "integer" }, { "name": "Ip", "type": "string", "required": false, "description": "IP搜索，选填，当需要搜索IP请填写" } ], "required": [ "Business" ] }, { "name": "DescribleRegionCount", "description": "获取地域的资源实例数", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；）" }, { "name": "LineList", "type": "array", "required": false, "description": "根据线路统计，取值为[1（BGP线路），2（南京电信），3（南京联通），99（第三方合作线路）]；只对高防IP产品有效，其他产品此字段忽略", "item_type": "integer" } ], "required": [ "Business" ] }, { "name": "ModifyCCAlarmThreshold", "description": "为高防包、高防IP、高防IP专业版、棋牌盾产品设置CC攻击的告警通知阈值", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（shield表示棋牌；bgpip表示高防IP；bgp表示高防包；bgp-multip表示多ip高防包；net表示高防IP专业版）" }, { "name": "RsId", "type": "string", "required": true, "description": "资源ID,字符串类型" }, { "name": "AlarmThreshold", "type": "integer", "required": true, "description": "告警阈值，大于0（目前排定的值），后台设置默认值为1000" }, { "name": "IpList", "type": "array", "required": true, "description": "资源关联的IP列表，高防包未绑定时，传空数组，高防IP专业版传多个IP的数据", "item_type": "string" } ], "required": [ "Business", "RsId", "AlarmThreshold", "IpList" ] }, { "name": "ModifyCCFrequencyRules", "description": "修改CC防护的访问频率控制规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "CCFrequencyRuleId", "type": "string", "required": true, "description": "CC的访问频率控制规则ID" }, { "name": "Mode", "type": "string", "required": true, "description": "匹配规则，取值[\"include\"(前缀匹配)，\"equal\"(完全匹配)]" }, { "name": "Period", "type": "integer", "required": true, "description": "统计周期，单位秒，取值[10, 30, 60]" }, { "name": "ReqNumber", "type": "integer", "required": true, "description": "访问次数，取值[1-10000]" }, { "name": "Act", "type": "string", "required": true, "description": "执行动作，取值[\"alg\"（人机识别）, \"drop\"（拦截）]" }, { "name": "ExeDuration", "type": "integer", "required": true, "description": "执行时间，单位秒，取值[1-900]" }, { "name": "Uri", "type": "string", "required": false, "description": "URI字符串，必须以/开头，例如/abc/a.php，长度不超过31；当URI=/时，匹配模式只能选择前缀匹配；" }, { "name": "UserAgent", "type": "string", "required": false, "description": "User-Agent字符串，长度不超过80" }, { "name": "Cookie", "type": "string", "required": false, "description": "Cookie字符串，长度不超过40" } ], "required": [ "Business", "CCFrequencyRuleId", "Mode", "Period", "ReqNumber", "Act", "ExeDuration" ] }, { "name": "ModifyCCFrequencyRulesStatus", "description": "开启或关闭CC防护的访问频率控制规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "RuleId", "type": "string", "required": true, "description": "7层转发规则ID（通过获取7层转发规则接口可以获取规则ID）" }, { "name": "Method", "type": "string", "required": true, "description": "开启或关闭，取值[\"on\"(开启)，\"off\"(关闭)]" } ], "required": [ "Business", "Id", "RuleId", "Method" ] }, { "name": "ModifyCCHostProtection", "description": "开启或关闭CC域名防护", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "RuleId", "type": "string", "required": true, "description": "规则ID" }, { "name": "Method", "type": "string", "required": true, "description": "开启/关闭CC域名防护，取值[open(表示开启)，close(表示关闭)]" } ], "required": [ "Business", "Id", "RuleId", "Method" ] }, { "name": "ModifyCCIpAllowDeny", "description": "添加或删除CC的IP黑白名单", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Method", "type": "string", "required": true, "description": "add表示添加，delete表示删除" }, { "name": "Type", "type": "string", "required": true, "description": "黑/白名单类型；取值[white(白名单)，black(黑名单)]" }, { "name": "IpList", "type": "array", "required": true, "description": "黑/白名单的IP数组", "item_type": "string" }, { "name": "Protocol", "type": "string", "required": false, "description": "可选字段，代表CC防护类型，取值[http（HTTP协议的CC防护），https（HTTPS协议的CC防护）]；当不填时，默认为HTTP协议的CC防护；当填写https时还需要填写Domain和RuleId字段；" }, { "name": "Domain", "type": "string", "required": false, "description": "可选字段，表示HTTPS协议的7层转发规则域名（通过获取7层转发规则接口可以获取域名），只有当Protocol字段为https时才必须填写此字段；" }, { "name": "RuleId", "type": "string", "required": false, "description": "可选字段，表示HTTPS协议的7层转发规则ID（通过获取7层转发规则接口可以获取规则ID）， 当Method为delete时，不用填写此字段；" } ], "required": [ "Business", "Id", "Method", "Type", "IpList" ] }, { "name": "ModifyCCLevel", "description": "修改CC防护等级", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Level", "type": "string", "required": true, "description": "CC防护等级，取值[default(正常), loose(宽松), strict(严格)];" }, { "name": "Protocol", "type": "string", "required": true, "description": "可选字段，代表CC防护类型，取值[http（HTTP协议的CC防护），https（HTTPS协议的CC防护）]；当不填时，默认为HTTP协议的CC防护；当填写https时还需要填写RuleId字段；" }, { "name": "RuleId", "type": "string", "required": true, "description": "表示7层转发规则ID（通过获取7层转发规则接口可以获取规则ID）；" } ], "required": [ "Business", "Id", "Level", "Protocol", "RuleId" ] }, { "name": "ModifyCCPolicySwitch", "description": "修改CC自定义策略开关", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "SetId", "type": "string", "required": true, "description": "策略ID" }, { "name": "Switch", "type": "integer", "required": true, "description": "开关状态" } ], "required": [ "Business", "Id", "SetId", "Switch" ] }, { "name": "ModifyCCSelfDefinePolicy", "description": "修改CC自定义策略", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "SetId", "type": "string", "required": true, "description": "策略ID" }, { "name": "Policy", "type": "object", "required": true, "description": "CC策略描述", "children": [ { "name": "Name", "type": "string", "required": true, "description": "策略名称" }, { "name": "Smode", "type": "string", "required": true, "description": "匹配模式，取值[matching(匹配模式), speedlimit(限速模式)]" }, { "name": "SetId", "type": "string", "required": false, "description": "策略id" }, { "name": "Frequency", "type": "integer", "required": false, "description": "每分钟限制的次数" }, { "name": "ExeMode", "type": "string", "required": false, "description": "执行策略模式，拦截或者验证码，取值[alg（验证码）, drop（拦截）]" }, { "name": "Switch", "type": "integer", "required": false, "description": "生效开关" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间" }, { "name": "RuleList", "type": "array", "required": false, "description": "规则列表", "item_type": "object", "children": [ { "name": "Skey", "type": "string", "required": true, "description": "规则的key, 可以为host、cgi、ua、referer" }, { "name": "Operator", "type": "string", "required": true, "description": "规则的条件，可以为include、not_include、equal" }, { "name": "Value", "type": "string", "required": true, "description": "规则的值，长度小于31字节" } ] }, { "name": "IpList", "type": "array", "required": false, "description": "IP列表，如果不填时，请传空数组但不能为null；", "item_type": "string" }, { "name": "Protocol", "type": "string", "required": false, "description": "cc防护类型，取值[http，https]" }, { "name": "RuleId", "type": "string", "required": false, "description": "可选字段，表示HTTPS的CC防护域名对应的转发规则ID;" }, { "name": "Domain", "type": "string", "required": false, "description": "HTTPS的CC防护域名" } ] } ], "required": [ "Business", "Id", "SetId", "Policy" ] }, { "name": "ModifyCCThreshold", "description": "修改CC的防护阈值", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版；basic表示基础防护）" }, { "name": "Threshold", "type": "integer", "required": true, "description": "CC防护阈值，取值(0 100 150 240 350 480 550 700 850 1000 1500 2000 3000 5000 10000 20000); 当Business为高防IP、高防IP专业版时，其CC防护最大阈值跟资源的保底防护带宽有关，对应关系如下： 保底带宽: 最大C防护阈值 10: 20000, 20: 40000, 30: 70000, 40: 100000, 50: 150000, 60: 200000, 80: 250000, 100: 300000," }, { "name": "Id", "type": "string", "required": false, "description": "资源ID" }, { "name": "Protocol", "type": "string", "required": false, "description": "可选字段，代表CC防护类型，取值[http（HTTP协议的CC防护），https（HTTPS协议的CC防护）]；当不填时，默认为HTTP协议的CC防护；当填写https时还需要填写RuleId字段；" }, { "name": "RuleId", "type": "string", "required": false, "description": "可选字段，表示HTTPS协议的7层转发规则ID（通过获取7层转发规则接口可以获取规则ID）； 当Protocol=https时必须填写；" }, { "name": "BasicIp", "type": "string", "required": false, "description": "查询的IP地址（仅基础防护提供），取值如：1.1.1.1" }, { "name": "BasicRegion", "type": "string", "required": false, "description": "查询IP所属地域（仅基础防护提供），取值如：gz、bj、sh、hk等地域缩写" }, { "name": "BasicBizType", "type": "string", "required": false, "description": "专区类型（仅基础防护提供），取值如：公有云专区：public，黑石专区：bm, NAT服务器专区：nat，互联网通道：channel。" }, { "name": "BasicDeviceType", "type": "string", "required": false, "description": "设备类型（仅基础防护提供），取值如：服务器：cvm，公有云负载均衡：clb，黑石负载均衡：lb，NAT服务器：nat，互联网通道：channel." }, { "name": "BasicIpInstance", "type": "string", "required": false, "description": "仅基础防护提供。可选，IPInstance Nat 网关（如果查询的设备类型是NAT服务器，需要传此参数，通过nat资源查询接口获取）" }, { "name": "BasicIspCode", "type": "integer", "required": false, "description": "仅基础防护提供。可选，运营商线路（如果查询的设备类型是NAT服务器，需要传此参数为5）" }, { "name": "Domain", "type": "string", "required": false, "description": "可选字段，当协议取值HTTPS时，必填" } ], "required": [ "Business", "Threshold" ] }, { "name": "ModifyCCUrlAllow", "description": "添加或删除CC的URL白名单", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Method", "type": "string", "required": true, "description": "=add表示添加，=delete表示删除" }, { "name": "Type", "type": "string", "required": true, "description": "黑/白名单类型；取值[white(白名单)]" }, { "name": "UrlList", "type": "array", "required": true, "description": "URL数组，URL格式如下： http://域名/cgi https://域名/cgi", "item_type": "string" }, { "name": "Protocol", "type": "string", "required": false, "description": "可选字段，代表CC防护类型，取值[http（HTTP协议的CC防护），https（HTTPS协议的CC防护）]；当不填时，默认为HTTP协议的CC防护；当填写https时还需要填写Domain和RuleId字段；" }, { "name": "Domain", "type": "string", "required": false, "description": "可选字段，表示HTTPS协议的7层转发规则域名（通过获取7层转发规则接口可以获取域名），只有当Protocol字段为https时才必须填写此字段；" }, { "name": "RuleId", "type": "string", "required": false, "description": "可选字段，表示HTTPS协议的7层转发规则ID（通过获取7层转发规则接口可以获取规则ID），当添加并且Protocol=https时必须填写； 当Method为delete时，可以不用填写此字段；" } ], "required": [ "Business", "Id", "Method", "Type", "UrlList" ] }, { "name": "ModifyDDoSAIStatus", "description": "读取或修改DDoS的AI防护状态", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Method", "type": "string", "required": true, "description": "=get表示读取AI防护状态；=set表示修改AI防护状态；" }, { "name": "DDoSAI", "type": "string", "required": false, "description": "AI防护状态，取值[on，off]；当Method=set时必填；" } ], "required": [ "Business", "Id", "Method" ] }, { "name": "ModifyDDoSAlarmThreshold", "description": "为高防包、高防IP、高防IP专业版、棋牌盾等产品设置DDoS攻击的告警通知阈值", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（shield表示棋牌；bgpip表示高防IP；bgp表示高防包；bgp-multip表示多ip高防包；net表示高防IP专业版）" }, { "name": "RsId", "type": "string", "required": true, "description": "资源ID,字符串类型" }, { "name": "AlarmType", "type": "integer", "required": true, "description": "告警阈值类型，0-未设置，1-入流量，2-清洗流量" }, { "name": "AlarmThreshold", "type": "integer", "required": true, "description": "告警阈值，大于0（目前暂定的值）" }, { "name": "IpList", "type": "array", "required": true, "description": "资源关联的IP列表，高防包未绑定时，传空数组，高防IP专业版传多个IP的数据", "item_type": "string" } ], "required": [ "Business", "RsId", "AlarmType", "AlarmThreshold", "IpList" ] }, { "name": "ModifyDDoSDefendStatus", "description": "开启或关闭DDoS防护状态，调用此接口允许临时关闭DDoS防护一段时间，等时间到了会自动开启DDoS防护；", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgp表示独享包；bgp-multip表示共享包；bgpip表示高防IP；net表示高防IP专业版；basic表示基础防护）" }, { "name": "Status", "type": "integer", "required": true, "description": "防护状态值，取值[0（关闭），1（开启）]" }, { "name": "Hour", "type": "integer", "required": true, "description": "关闭时长，单位小时，取值[0，1，2，3，4，5，6]；当Status=0表示关闭时，Hour必须大于0；" }, { "name": "Id", "type": "string", "required": false, "description": "资源ID；当Business不是基础防护时必须填写此字段；" }, { "name": "Ip", "type": "string", "required": false, "description": "基础防护的IP，只有当Business为基础防护时才需要填写此字段；" }, { "name": "BizType", "type": "string", "required": false, "description": "只有当Business为基础防护时才需要填写此字段，IP所属的产品类型，取值[public（CVM产品），bm（黑石产品），eni（弹性网卡），vpngw（VPN网关）， natgw（NAT网关），waf（Web应用安全产品），fpc（金融产品），gaap（GAAP产品）, other(托管IP)]" }, { "name": "DeviceType", "type": "string", "required": false, "description": "只有当Business为基础防护时才需要填写此字段，IP所属的产品子类，取值[cvm（CVM），lb（负载均衡器），eni（弹性网卡），vpngw（VPN），natgw（NAT），waf（WAF），fpc（金融），gaap（GAAP），other（托管IP），eip（黑石弹性IP）]" }, { "name": "InstanceId", "type": "string", "required": false, "description": "只有当Business为基础防护时才需要填写此字段，IP所属的资源实例ID，当绑定新IP时必须填写此字段；例如是弹性网卡的IP，则InstanceId填写弹性网卡的ID(eni-*);" }, { "name": "IPRegion", "type": "string", "required": false, "description": "只有当Business为基础防护时才需要填写此字段，表示IP所属的地域，取值： \"bj\": 华北地区(北京) \"cd\": 西南地区(成都) \"cq\": 西南地区(重庆) \"gz\": 华南地区(广州) \"gzopen\": 华南地区(广州Open) \"hk\": 中国香港 \"kr\": 东南亚地区(首尔) \"sh\": 华东地区(上海) \"shjr\": 华东地区(上海金融) \"szjr\": 华南地区(深圳金融) \"sg\": 东南亚地区(新加坡) \"th\": 东南亚地区(泰国) \"de\": 欧洲地区(德国) \"usw\": 美国西部（\ufffd..." } ], "required": [ "Business", "Status", "Hour" ] }, { "name": "ModifyDDoSLevel", "description": "读取或修改DDoS的防护等级", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Method", "type": "string", "required": true, "description": "=get表示读取防护等级；=set表示修改防护等级" }, { "name": "DDoSLevel", "type": "string", "required": false, "description": "防护等级，取值[low,middle,high]；当Method=set时必填" } ], "required": [ "Business", "Id", "Method" ] }, { "name": "ModifyDDoSPolicy", "description": "修改DDoS高级策略", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "PolicyId", "type": "string", "required": true, "description": "策略ID" }, { "name": "DropOptions", "type": "array", "required": true, "description": "协议禁用，必须填写且数组长度必须为1", "item_type": "object", "children": [ { "name": "DropTcp", "type": "integer", "required": true, "description": "禁用TCP协议，取值范围[0,1]" }, { "name": "DropUdp", "type": "integer", "required": true, "description": "禁用UDP协议，取值范围[0,1]" }, { "name": "DropIcmp", "type": "integer", "required": true, "description": "禁用ICMP协议，取值范围[0,1]" }, { "name": "DropOther", "type": "integer", "required": true, "description": "禁用其他协议，取值范围[0,1]" }, { "name": "DropAbroad", "type": "integer", "required": true, "description": "拒绝海外流量，取值范围[0,1]" }, { "name": "CheckSyncConn", "type": "integer", "required": true, "description": "空连接防护，取值范围[0,1]" }, { "name": "SdNewLimit", "type": "integer", "required": false, "description": "基于来源IP及目的IP的新建连接抑制，取值范围[0,4294967295]" }, { "name": "DstNewLimit", "type": "integer", "required": false, "description": "基于目的IP的新建连接抑制，取值范围[0,4294967295]" }, { "name": "SdConnLimit", "type": "integer", "required": false, "description": "基于来源IP及目的IP的并发连接抑制，取值范围[0,4294967295]" }, { "name": "DstConnLimit", "type": "integer", "required": false, "description": "基于目的IP的并发连接抑制，取值范围[0,4294967295]" }, { "name": "BadConnThreshold", "type": "integer", "required": false, "description": "基于连接抑制触发阈值，取值范围[0,4294967295]" }, { "name": "NullConnEnable", "type": "integer", "required": false, "description": "异常连接检测条件，空连接防护开关，，取值范围[0,1]" }, { "name": "ConnTimeout", "type": "integer", "required": false, "description": "异常连接检测条件，连接超时，，取值范围[0,65535]" }, { "name": "SynRate", "type": "integer", "required": false, "description": "异常连接检测条件，syn占比ack百分比，，取值范围[0,100]" }, { "name": "SynLimit", "type": "integer", "required": false, "description": "异常连接检测条件，syn阈值，取值范围[0,100]" }, { "name": "DTcpMbpsLimit", "type": "integer", "required": false, "description": "tcp限速，取值范围[0,4294967295]" }, { "name": "DUdpMbpsLimit", "type": "integer", "required": false, "description": "udp限速，取值范围[0,4294967295]" }, { "name": "DIcmpMbpsLimit", "type": "integer", "required": false, "description": "icmp限速，取值范围[0,4294967295]" }, { "name": "DOtherMbpsLimit", "type": "integer", "required": false, "description": "other协议限速，取值范围[0,4294967295]" } ] }, { "name": "PortLimits", "type": "array", "required": false, "description": "端口禁用，当没有禁用端口时填空数组", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，取值范围[tcp,udp,all]" }, { "name": "DPortStart", "type": "integer", "required": true, "description": "开始目的端口，取值范围[0,65535]" }, { "name": "DPortEnd", "type": "integer", "required": true, "description": "结束目的端口，取值范围[0,65535]，要求大于等于开始目的端口" }, { "name": "SPortStart", "type": "integer", "required": false, "description": "开始源端口，取值范围[0,65535] 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "SPortEnd", "type": "integer", "required": false, "description": "结束源端口，取值范围[0,65535]，要求大于等于开始源端口 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "Action", "type": "string", "required": false, "description": "执行动作，取值[drop(丢弃) ，transmit(转发)] 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "Kind", "type": "integer", "required": false, "description": "禁用端口类型，取值[0（目的端口范围禁用）， 1（源端口范围禁用）， 2（目的和源端口范围同时禁用）] 注意：此字段可能返回 null，表示取不到有效值。" } ] }, { "name": "IpAllowDenys", "type": "array", "required": false, "description": "IP黑白名单，当没有IP黑白名单时填空数组", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "IP地址" }, { "name": "Type", "type": "string", "required": true, "description": "黑白类型，取值范围[black，white]" } ] }, { "name": "PacketFilters", "type": "array", "required": false, "description": "报文过滤，当没有报文过滤时填空数组", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，取值范围[tcp,udp,icmp,all]" }, { "name": "SportStart", "type": "integer", "required": true, "description": "开始源端口，取值范围[0,65535]" }, { "name": "SportEnd", "type": "integer", "required": true, "description": "结束源端口，取值范围[0,65535]" }, { "name": "DportStart", "type": "integer", "required": true, "description": "开始目的端口，取值范围[0,65535]" }, { "name": "DportEnd", "type": "integer", "required": true, "description": "结束目的端口，取值范围[0,65535]" }, { "name": "PktlenMin", "type": "integer", "required": true, "description": "最小包长，取值范围[0,1500]" }, { "name": "PktlenMax", "type": "integer", "required": true, "description": "最大包长，取值范围[0,1500]" }, { "name": "MatchBegin", "type": "string", "required": true, "description": "是否检测载荷，取值范围[ begin_l3(IP头) begin_l4(TCP头) begin_l5(载荷) no_match(不检测) ]" }, { "name": "MatchType", "type": "string", "required": true, "description": "是否是正则表达式，取值范围[sunday(表示关键字),pcre(表示正则表达式)]" }, { "name": "Str", "type": "string", "required": true, "description": "关键字或正则表达式" }, { "name": "Depth", "type": "integer", "required": true, "description": "检测深度，取值范围[0,1500]" }, { "name": "Offset", "type": "integer", "required": true, "description": "检测偏移量，取值范围[0,1500]" }, { "name": "IsNot", "type": "integer", "required": true, "description": "是否包括，取值范围[0(表示不包含),1(表示包含)]" }, { "name": "Action", "type": "string", "required": true, "description": "策略动作，取值范围[drop，drop_black，drop_rst，drop_black_rst，transmit]" } ] }, { "name": "WaterPrint", "type": "array", "required": false, "description": "水印策略参数，当没有启用水印功能时填空数组，最多只能传一条水印策略（即数组大小不超过1）", "item_type": "object", "children": [ { "name": "TcpPortList", "type": "array", "required": true, "description": "TCP端口段，例如[\"2000-3000\",\"3500-4000\"]", "item_type": "string" }, { "name": "UdpPortList", "type": "array", "required": true, "description": "UDP端口段，例如[\"2000-3000\",\"3500-4000\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": true, "description": "水印偏移量，取值范围[0, 100)" }, { "name": "RemoveSwitch", "type": "integer", "required": true, "description": "是否自动剥离，取值[0（不自动剥离），1（自动剥离）]" }, { "name": "OpenStatus", "type": "integer", "required": true, "description": "是否开启，取值[0（没有开启），1（已开启）]" } ] } ], "required": [ "Business", "PolicyId", "DropOptions" ] }, { "name": "ModifyDDoSPolicyCase", "description": "修改策略场景", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "SceneId", "type": "string", "required": true, "description": "策略场景ID" }, { "name": "PlatformTypes", "type": "array", "required": false, "description": "开发平台，取值[PC（PC客户端）， MOBILE（移动端）， TV（电视端）， SERVER（主机）]", "item_type": "string" }, { "name": "AppType", "type": "string", "required": false, "description": "细分品类，取值[WEB（网站）， GAME（游戏）， APP（应用）， OTHER（其他）]" }, { "name": "AppProtocols", "type": "array", "required": false, "description": "应用协议，取值[tcp（TCP协议），udp（UDP协议），icmp（ICMP协议），all（其他协议）]", "item_type": "string" }, { "name": "TcpSportStart", "type": "string", "required": false, "description": "TCP业务起始端口，取值(0, 65535]" }, { "name": "TcpSportEnd", "type": "string", "required": false, "description": "TCP业务结束端口，取值(0, 65535]，必须大于等于TCP业务起始端口" }, { "name": "UdpSportStart", "type": "string", "required": false, "description": "UDP业务起始端口，取值范围(0, 65535]" }, { "name": "UdpSportEnd", "type": "string", "required": false, "description": "UDP业务结束端口，取值范围(0, 65535)，必须大于等于UDP业务起始端口" }, { "name": "HasAbroad", "type": "string", "required": false, "description": "是否有海外客户，取值[no（没有）, yes（有）]" }, { "name": "HasInitiateTcp", "type": "string", "required": false, "description": "是否会主动对外发起TCP请求，取值[no（不会）, yes（会）]" }, { "name": "HasInitiateUdp", "type": "string", "required": false, "description": "是否会主动对外发起UDP业务请求，取值[no（不会）, yes（会）]" }, { "name": "PeerTcpPort", "type": "string", "required": false, "description": "主动发起TCP请求的端口，取值范围(0, 65535]" }, { "name": "PeerUdpPort", "type": "string", "required": false, "description": "主动发起UDP请求的端口，取值范围(0, 65535]" }, { "name": "TcpFootprint", "type": "string", "required": false, "description": "TCP载荷的固定特征码，字符串长度小于512" }, { "name": "UdpFootprint", "type": "string", "required": false, "description": "UDP载荷的固定特征码，字符串长度小于512" }, { "name": "WebApiUrl", "type": "array", "required": false, "description": "Web业务的API的URL", "item_type": "string" }, { "name": "MinTcpPackageLen", "type": "string", "required": false, "description": "TCP业务报文长度最小值，取值范围(0, 1500)" }, { "name": "MaxTcpPackageLen", "type": "string", "required": false, "description": "TCP业务报文长度最大值，取值范围(0, 1500)，必须大于等于TCP业务报文长度最小值" }, { "name": "MinUdpPackageLen", "type": "string", "required": false, "description": "UDP业务报文长度最小值，取值范围(0, 1500)" }, { "name": "MaxUdpPackageLen", "type": "string", "required": false, "description": "UDP业务报文长度最大值，取值范围(0, 1500)，必须大于等于UDP业务报文长度最小值" }, { "name": "HasVPN", "type": "string", "required": false, "description": "是否有VPN业务，取值[no（没有）, yes（有）]" }, { "name": "TcpPortList", "type": "string", "required": false, "description": "TCP业务端口列表，同时支持单个端口和端口段，字符串格式，例如：80,443,700-800,53,1000-3000" }, { "name": "UdpPortList", "type": "string", "required": false, "description": "UDP业务端口列表，同时支持单个端口和端口段，字符串格式，例如：80,443,700-800,53,1000-3000" } ], "required": [ "Business", "SceneId" ] }, { "name": "ModifyDDoSPolicyName", "description": "修改DDoS高级策略名称", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "PolicyId", "type": "string", "required": true, "description": "策略ID" }, { "name": "Name", "type": "string", "required": true, "description": "策略名称" } ], "required": [ "Business", "PolicyId", "Name" ] }, { "name": "ModifyDDoSSwitch", "description": "开启或关闭DDoS防护，只支持基础防护产品；", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（basic表示基础防护）" }, { "name": "Method", "type": "string", "required": true, "description": "=get表示读取DDoS防护状态；=set表示修改DDoS防护状态；" }, { "name": "Ip", "type": "string", "required": false, "description": "基础防护的IP，只有当Business为基础防护时才需要填写此字段；" }, { "name": "BizType", "type": "string", "required": false, "description": "只有当Business为基础防护时才需要填写此字段，IP所属的产品类型，取值[public（CVM产品），bm（黑石产品），eni（弹性网卡），vpngw（VPN网关）， natgw（NAT网关），waf（Web应用安全产品），fpc（金融产品），gaap（GAAP产品）, other(托管IP)]" }, { "name": "DeviceType", "type": "string", "required": false, "description": "只有当Business为基础防护时才需要填写此字段，IP所属的产品子类，取值[cvm（CVM），lb（负载均衡器），eni（弹性网卡），vpngw（VPN），natgw（NAT），waf（WAF），fpc（金融），gaap（GAAP），other（托管IP），eip（黑石弹性IP）]" }, { "name": "InstanceId", "type": "string", "required": false, "description": "只有当Business为基础防护时才需要填写此字段，IP所属的资源实例ID，当绑定新IP时必须填写此字段；例如是弹性网卡的IP，则InstanceId填写弹性网卡的ID(eni-*);" }, { "name": "IPRegion", "type": "string", "required": false, "description": "只有当Business为基础防护时才需要填写此字段，表示IP所属的地域，取值： \"bj\": 华北地区(北京) \"cd\": 西南地区(成都) \"cq\": 西南地区(重庆) \"gz\": 华南地区(广州) \"gzopen\": 华南地区(广州Open) \"hk\": 中国香港 \"kr\": 东南亚地区(首尔) \"sh\": 华东地区(上海) \"shjr\": 华东地区(上海金融) \"szjr\": 华南地区(深圳金融) \"sg\": 东南亚地区(新加坡) \"th\": 东南亚地区(泰国) \"de\": 欧洲地区(德国) \"usw\": 美国西部（\ufffd..." }, { "name": "Status", "type": "integer", "required": false, "description": "可选字段，防护状态值，取值[0（关闭），1（开启）]；当Method为get时可以不填写此字段；" } ], "required": [ "Business", "Method" ] }, { "name": "ModifyDDoSThreshold", "description": "修改DDoS清洗阈值", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Threshold", "type": "integer", "required": true, "description": "DDoS清洗阈值，取值[0, 60, 80, 100, 150, 200, 250, 300, 400, 500, 700, 1000]; 当设置值为0时，表示采用默认值；" } ], "required": [ "Business", "Id", "Threshold" ] }, { "name": "ModifyDDoSWaterKey", "description": "支持水印密钥的添加，删除，开启，关闭", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "PolicyId", "type": "string", "required": true, "description": "策略ID" }, { "name": "Method", "type": "string", "required": true, "description": "密钥操作，取值：[add（添加），delete（删除），open（开启），close（关闭），get（获取密钥）]" }, { "name": "KeyId", "type": "integer", "required": false, "description": "密钥ID，当添加密钥操作时可以不填或填0，其他操作时必须填写；" } ], "required": [ "Business", "PolicyId", "Method" ] }, { "name": "ModifyElasticLimit", "description": "修改弹性防护阈值", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Limit", "type": "integer", "required": true, "description": "弹性防护阈值，取值[0 10000 20000 30000 40000 50000 60000 70000 80000 90000 100000 120000 150000 200000 250000 300000 400000 600000 800000 220000 310000 110000 270000 610000]" } ], "required": [ "Business", "Id", "Limit" ] }, { "name": "ModifyL4Health", "description": "修改L4转发规则健康检查参数，支持的子产品：高防IP、高防IP专业版", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Healths", "type": "array", "required": true, "description": "健康检查参数数组", "item_type": "object", "children": [ { "name": "RuleId", "type": "string", "required": true, "description": "规则ID" }, { "name": "Enable", "type": "integer", "required": true, "description": "=1表示开启；=0表示关闭" }, { "name": "TimeOut", "type": "integer", "required": true, "description": "响应超时时间，单位秒" }, { "name": "Interval", "type": "integer", "required": true, "description": "检测间隔时间，单位秒，必须要大于响应超时时间" }, { "name": "KickNum", "type": "integer", "required": true, "description": "不健康阈值，单位次" }, { "name": "AliveNum", "type": "integer", "required": true, "description": "健康阈值，单位次" } ] } ], "required": [ "Business", "Id", "Healths" ] }, { "name": "ModifyL4KeepTime", "description": "修改L4转发规则的会话保持，支持的子产品：高防IP、高防IP专业版", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "RuleId", "type": "string", "required": true, "description": "规则ID" }, { "name": "KeepEnable", "type": "integer", "required": true, "description": "会话保持开关，取值[0(会话保持关闭)，1(会话保持开启)]" }, { "name": "KeepTime", "type": "integer", "required": true, "description": "会话保持时间，单位秒" } ], "required": [ "Business", "Id", "RuleId", "KeepEnable", "KeepTime" ] }, { "name": "ModifyL4Rules", "description": "修改L4转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Rule", "type": "object", "required": true, "description": "规则", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "转发协议，取值[TCP, UDP]" }, { "name": "VirtualPort", "type": "integer", "required": true, "description": "转发端口" }, { "name": "SourcePort", "type": "integer", "required": true, "description": "源站端口" }, { "name": "SourceType", "type": "integer", "required": true, "description": "回源方式，取值[1(域名回源)，2(IP回源)]" }, { "name": "KeepTime", "type": "integer", "required": true, "description": "会话保持时间，单位秒" }, { "name": "SourceList", "type": "array", "required": true, "description": "回源列表", "item_type": "object", "children": [ { "name": "Source", "type": "string", "required": true, "description": "回源IP或域名" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重值，取值[0,100]" } ] }, { "name": "LbType", "type": "integer", "required": true, "description": "负载均衡方式，取值[1(加权轮询)，2(源IP hash)]" }, { "name": "KeepEnable", "type": "integer", "required": true, "description": "会话保持开关，取值[0(会话保持关闭)，1(会话保持开启)]；" }, { "name": "RuleId", "type": "string", "required": false, "description": "规则ID" }, { "name": "RuleName", "type": "string", "required": false, "description": "规则描述" }, { "name": "RemoveSwitch", "type": "integer", "required": false, "description": "移除水印状态，取值[0(关闭)，1(开启)]" } ] } ], "required": [ "Business", "Id", "Rule" ] }, { "name": "ModifyL7Rules", "description": "修改L7转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Rule", "type": "object", "required": true, "description": "规则", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "转发协议，取值[http, https]" }, { "name": "Domain", "type": "string", "required": true, "description": "转发域名" }, { "name": "SourceType", "type": "integer", "required": true, "description": "回源方式，取值[1(域名回源)，2(IP回源)]" }, { "name": "KeepTime", "type": "integer", "required": true, "description": "会话保持时间，单位秒" }, { "name": "SourceList", "type": "array", "required": true, "description": "回源列表", "item_type": "object", "children": [ { "name": "Source", "type": "string", "required": true, "description": "回源IP或域名" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重值，取值[0,100]" } ] }, { "name": "LbType", "type": "integer", "required": true, "description": "负载均衡方式，取值[1(加权轮询)]" }, { "name": "KeepEnable", "type": "integer", "required": true, "description": "会话保持开关，取值[0(会话保持关闭)，1(会话保持开启)]" }, { "name": "RuleId", "type": "string", "required": false, "description": "规则ID，当添加新规则时可以不用填写此字段；当修改或者删除规则时需要填写此字段；" }, { "name": "CertType", "type": "integer", "required": false, "description": "证书来源，当转发协议为https时必须填，取值[2(腾讯云托管证书)]，当转发协议为http时也可以填0" }, { "name": "SSLId", "type": "string", "required": false, "description": "当证书来源为腾讯云托管证书时，此字段必须填写托管证书ID" }, { "name": "Cert", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书内容；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)" }, { "name": "PrivateKey", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书密钥；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)" }, { "name": "RuleName", "type": "string", "required": false, "description": "规则描述" }, { "name": "Status", "type": "integer", "required": false, "description": "规则状态，取值[0(规则配置成功)，1(规则配置生效中)，2(规则配置失败)，3(规则删除生效中)，5(规则删除失败)，6(规则等待配置)，7(规则等待删除)，8(规则待配置证书)]" }, { "name": "CCStatus", "type": "integer", "required": false, "description": "cc防护状态，取值[0(关闭), 1(开启)]" }, { "name": "CCEnable", "type": "integer", "required": false, "description": "HTTPS协议的CC防护状态，取值[0(关闭), 1(开启)]" }, { "name": "CCThreshold", "type": "integer", "required": false, "description": "HTTPS协议的CC防护阈值" }, { "name": "CCLevel", "type": "string", "required": false, "description": "HTTPS协议的CC防护等级" }, { "name": "HttpsToHttpEnable", "type": "integer", "required": false, "description": "是否开启Https协议使用Http回源，取值[0(关闭), 1(开启)]，不填写默认是关闭 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "VirtualPort", "type": "integer", "required": false, "description": "接入端口值 注意：此字段可能返回 null，表示取不到有效值。" } ] } ], "required": [ "Business", "Id", "Rule" ] }, { "name": "ModifyNetReturnSwitch", "description": "在客户收攻击或者被封堵时，切回到源站，并设置回切的时长", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源实例ID" }, { "name": "Status", "type": "integer", "required": true, "description": "Status 表示回切开关，0: 关闭， 1:打开" }, { "name": "Hour", "type": "integer", "required": true, "description": "回切时长，单位：小时，取值[0,1,2,3,4,5,6;]当status=1时必选填写Hour\u003e0" } ], "required": [ "Business", "Id", "Status", "Hour" ] }, { "name": "ModifyNewDomainRules", "description": "修改7层转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Rule", "type": "object", "required": true, "description": "域名转发规则", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "转发协议，取值[http, https]" }, { "name": "Domain", "type": "string", "required": true, "description": "转发域名" }, { "name": "SourceType", "type": "integer", "required": true, "description": "回源方式，取值[1(域名回源)，2(IP回源)]" }, { "name": "KeepTime", "type": "integer", "required": true, "description": "会话保持时间，单位秒" }, { "name": "SourceList", "type": "array", "required": true, "description": "回源列表", "item_type": "object", "children": [ { "name": "Source", "type": "string", "required": true, "description": "回源IP或域名" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重值，取值[0,100]" } ] }, { "name": "LbType", "type": "integer", "required": true, "description": "负载均衡方式，取值[1(加权轮询)]" }, { "name": "KeepEnable", "type": "integer", "required": true, "description": "会话保持开关，取值[0(会话保持关闭)，1(会话保持开启)]" }, { "name": "RuleId", "type": "string", "required": false, "description": "规则ID，当添加新规则时可以不用填写此字段；当修改或者删除规则时需要填写此字段；" }, { "name": "CertType", "type": "integer", "required": false, "description": "证书来源，当转发协议为https时必须填，取值[2(腾讯云托管证书)]，当转发协议为http时也可以填0" }, { "name": "SSLId", "type": "string", "required": false, "description": "当证书来源为腾讯云托管证书时，此字段必须填写托管证书ID" }, { "name": "Cert", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书内容；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)" }, { "name": "PrivateKey", "type": "string", "required": false, "description": "当证书来源为自有证书时，此字段必须填写证书密钥；(因已不再支持自有证书，此字段已弃用，请不用填写此字段)" }, { "name": "RuleName", "type": "string", "required": false, "description": "规则描述" }, { "name": "Status", "type": "integer", "required": false, "description": "规则状态，取值[0(规则配置成功)，1(规则配置生效中)，2(规则配置失败)，3(规则删除生效中)，5(规则删除失败)，6(规则等待配置)，7(规则等待删除)，8(规则待配置证书)]" }, { "name": "CCStatus", "type": "integer", "required": false, "description": "cc防护状态，取值[0(关闭), 1(开启)]" }, { "name": "CCEnable", "type": "integer", "required": false, "description": "HTTPS协议的CC防护状态，取值[0(关闭), 1(开启)]" }, { "name": "CCThreshold", "type": "integer", "required": false, "description": "HTTPS协议的CC防护阈值" }, { "name": "CCLevel", "type": "string", "required": false, "description": "HTTPS协议的CC防护等级" }, { "name": "Region", "type": "integer", "required": false, "description": "区域码" }, { "name": "Id", "type": "string", "required": false, "description": "资源Id" }, { "name": "Ip", "type": "string", "required": false, "description": "资源Ip" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间" }, { "name": "HttpsToHttpEnable", "type": "integer", "required": false, "description": "是否开启Https协议使用Http回源，取值[0(关闭), 1(开启)]，不填写默认是关闭" }, { "name": "VirtualPort", "type": "integer", "required": false, "description": "接入端口值 注意：此字段可能返回 null，表示取不到有效值。" } ] } ], "required": [ "Business", "Id", "Rule" ] }, { "name": "ModifyNewL4Rule", "description": "修改4层转发规则", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "Rule", "type": "object", "required": true, "description": "转发规则", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "转发协议，取值[TCP, UDP]" }, { "name": "VirtualPort", "type": "integer", "required": true, "description": "转发端口" }, { "name": "SourcePort", "type": "integer", "required": true, "description": "源站端口" }, { "name": "SourceType", "type": "integer", "required": true, "description": "回源方式，取值[1(域名回源)，2(IP回源)]" }, { "name": "KeepTime", "type": "integer", "required": true, "description": "会话保持时间，单位秒" }, { "name": "SourceList", "type": "array", "required": true, "description": "回源列表", "item_type": "object", "children": [ { "name": "Source", "type": "string", "required": true, "description": "回源IP或域名" }, { "name": "Weight", "type": "integer", "required": true, "description": "权重值，取值[0,100]" } ] }, { "name": "LbType", "type": "integer", "required": true, "description": "负载均衡方式，取值[1(加权轮询)，2(源IP hash)]" }, { "name": "KeepEnable", "type": "integer", "required": true, "description": "会话保持开关，取值[0(会话保持关闭)，1(会话保持开启)]；" }, { "name": "RuleId", "type": "string", "required": false, "description": "规则ID" }, { "name": "RuleName", "type": "string", "required": false, "description": "规则描述" }, { "name": "RemoveSwitch", "type": "integer", "required": false, "description": "移除水印状态，取值[0(关闭)，1(开启)]" } ] } ], "required": [ "Business", "Id", "Rule" ] }, { "name": "ModifyResBindDDoSPolicy", "description": "资源实例绑定DDoS高级策略", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；bgp表示独享包；bgp-multip表示共享包；net表示高防IP专业版）" }, { "name": "Id", "type": "string", "required": true, "description": "资源ID" }, { "name": "PolicyId", "type": "string", "required": true, "description": "策略ID" }, { "name": "Method", "type": "string", "required": true, "description": "绑定或解绑，bind表示绑定策略，unbind表示解绑策略" } ], "required": [ "Business", "Id", "PolicyId", "Method" ] }, { "name": "ModifyResourceRenewFlag", "description": "修改资源自动续费标记", "status": "online", "parameters": [ { "name": "Business", "type": "string", "required": true, "description": "大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版；shield表示棋牌盾；bgp表示独享包；bgp-multip表示共享包；insurance表示保险包；staticpack表示三网套餐包）" }, { "name": "Id", "type": "string", "required": true, "description": "资源Id" }, { "name": "RenewFlag", "type": "integer", "required": true, "description": "自动续费标记（0手动续费；1自动续费；2到期不续费）" } ], "required": [ "Business", "Id", "RenewFlag" ] } ] }