models

package
v1.62.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 16, 2023 License: Apache-2.0 Imports: 0 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AlarmConfig added in v1.6.0

type AlarmConfig struct {

	/* 黑洞告警邮件开关 0 关闭 1 开启 (Optional) */
	BlackHoleAlarmEmailStatus int `json:"blackHoleAlarmEmailStatus"`

	/* 黑洞告警短信开关 0 关闭 1 开启 (Optional) */
	BlackHoleAlarmSmsStatus int `json:"blackHoleAlarmSmsStatus"`

	/* 黑洞告警总开关  0 关闭 1 开启 (Optional) */
	BlackHoleAlarmStatus int `json:"blackHoleAlarmStatus"`

	/* DDos 攻击告警邮件开关  0 关闭 1 开启 (Optional) */
	DdosAlarmEmailStatus int `json:"ddosAlarmEmailStatus"`

	/* DDos 攻击告警短信开关  0 关闭 1 开启 (Optional) */
	DdosAlarmSmsStatus int `json:"ddosAlarmSmsStatus"`

	/* DDos 告警总开关 0 关闭 1 开启 (Optional) */
	DdosAlarmStatus int `json:"ddosAlarmStatus"`

	/* 错误码告警总开关 (Optional) */
	ErrorCodeAlarmStatus int `json:"errorCodeAlarmStatus"`

	/* 错误码告警域名列表 (Optional) */
	ErrorCodeDomain []string `json:"errorCodeDomain"`

	/* 错误码列表 (Optional) */
	ErrorCode []int `json:"errorCode"`

	/* 错误码触发告警比例 (Optional) */
	ErrorCodePercent int `json:"errorCodePercent"`

	/* 错误码触发告警次数 (Optional) */
	ErrorCodeCount int `json:"errorCodeCount"`
}

type AlarmConfigSpec added in v1.6.0

type AlarmConfigSpec struct {

	/* 黑洞告警邮件开关 0 关闭 1 开启 (Optional) */
	BlackHoleAlarmEmailStatus *int `json:"blackHoleAlarmEmailStatus"`

	/* 黑洞告警短信开关 0 关闭 1 开启 (Optional) */
	BlackHoleAlarmSmsStatus *int `json:"blackHoleAlarmSmsStatus"`

	/* 黑洞告警总开关  0 关闭 1 开启 (Optional) */
	BlackHoleAlarmStatus *int `json:"blackHoleAlarmStatus"`

	/* DDos 攻击告警邮件开关  0 关闭 1 开启 (Optional) */
	DdosAlarmEmailStatus *int `json:"ddosAlarmEmailStatus"`

	/* DDos 攻击告警短信开关  0 关闭 1 开启 (Optional) */
	DdosAlarmSmsStatus *int `json:"ddosAlarmSmsStatus"`

	/* DDos 告警总开关 0 关闭 1 开启 (Optional) */
	DdosAlarmStatus *int `json:"ddosAlarmStatus"`

	/* 错误码告警总开关 (Optional) */
	ErrorCodeAlarmStatus *int `json:"errorCodeAlarmStatus"`

	/* 错误码告警域名列表 (Optional) */
	ErrorCodeDomain []string `json:"errorCodeDomain"`

	/* 错误码列表 (Optional) */
	ErrorCode []int `json:"errorCode"`

	/* 错误码触发告警比例 (Optional) */
	ErrorCodePercent *int `json:"errorCodePercent"`

	/* 错误码触发告警次数 (Optional) */
	ErrorCodeCount *int `json:"errorCodeCount"`
}

type AttackTypeCount added in v1.6.0

type AttackTypeCount struct {

	/* 攻击类型 (Optional) */
	Type string `json:"type"`

	/* 攻击次数 (Optional) */
	Count int `json:"count"`
}

type AutoRenewalSpec added in v1.32.0

type AutoRenewalSpec struct {

	/* 是否开通自动续费, true: 开通自动续费, false: 不开通自动续费  */
	AutoRenewalEnable bool `json:"autoRenewalEnable"`

	/* 购买时长, 开通自动续费时必传. <br>- timeUnit 为 3 时, 可取值 1-9<br>- timeUnit 为 4 时, 可取值 1-3 (Optional) */
	TimeSpan *int `json:"timeSpan"`

	/* 自动续费时长类型, 开通自动续费时必传. <br>- 3: 月<br>- 4: 年 (Optional) */
	TimeUnit *int `json:"timeUnit"`
}

type BlackIpSet added in v1.56.0

type BlackIpSet struct {

	/* IP 黑名单 Id (Optional) */
	Id string `json:"id"`

	/* IP 黑名单的名称 (Optional) */
	Name string `json:"name"`

	/* IP 或 IP 段的数组 (Optional) */
	Ip []string `json:"ip"`

	/* 是否打开 (Optional) */
	Enable bool `json:"enable"`
}

type BlackIpSetSpec added in v1.56.0

type BlackIpSetSpec struct {

	/* IP 黑名单名称  */
	Name string `json:"name"`

	/* IP 或 IP 段的数组  */
	Ip []string `json:"ip"`
}

type BwRepeatMsg added in v1.6.0

type BwRepeatMsg struct {

	/* 黑名单重复 IP/IP段 (Optional) */
	Black string `json:"black"`

	/* 白名单重复 IP/IP段 (Optional) */
	White string `json:"white"`
}

type CCAttackLog added in v1.10.0

type CCAttackLog struct {

	/* CC 攻击记录Id (Optional) */
	AttackId string `json:"attackId"`

	/* 攻击流量大小 (Optional) */
	AttackTraffic float64 `json:"attackTraffic"`

	/* 是否触发黑洞, 0否 1是 (Optional) */
	BlackHole int `json:"blackHole"`

	/* 攻击开始时间 (Optional) */
	StartTime string `json:"startTime"`

	/* 攻击结束时间 (Optional) */
	EndTime string `json:"endTime"`

	/* 流量单位, bps、Kbps、Mbps、Gbps (Optional) */
	Unit string `json:"unit"`

	/* 高防实例id (Optional) */
	InstanceId string `json:"instanceId"`

	/* 高防实例名称 (Optional) */
	Name string `json:"name"`
}

type CCAttackLogDetail added in v1.0.3

type CCAttackLogDetail struct {

	/* 特征key (Optional) */
	Key string `json:"key"`

	/* 攻击次数 (Optional) */
	Num int `json:"num"`
}

type CCDefaultThresholds added in v1.6.0

type CCDefaultThresholds struct {

	/* 每个 Host 的防护阈值 (Optional) */
	HostQps int `json:"hostQps"`

	/* 每个 Host + URL 的防护阈值 (Optional) */
	HostUrlQps int `json:"hostUrlQps"`

	/* 每个源 IP 对 Host 的防护阈值 (Optional) */
	IpHostQps int `json:"ipHostQps"`

	/* 每个源 IP 对 Host + URI 的防护阈值 (Optional) */
	IpHostUrlQps int `json:"ipHostUrlQps"`
}

type CCProtectionConfig added in v1.6.0

type CCProtectionConfig struct {

	/* 网站规则的 CC 防护状态, 0: 关闭, 1: 开启 (Optional) */
	Enable int `json:"enable"`

	/* 观察者模式, 0: 关闭, 1: 开启 (Optional) */
	ObserverMode int `json:"observerMode"`

	/* 防护等级, 0: 正常, 1: 宽松, 2: 紧急, 3: 自定义 (Optional) */
	Level int `json:"level"`

	/* HTTP 请求数阈值 (Optional) */
	CcThreshold int64 `json:"ccThreshold"`

	/* Host 的防护阈值 (Optional) */
	HostQps int64 `json:"hostQps"`

	/* Host + Url 的防护阈值 (Optional) */
	HostUrlQps int64 `json:"hostUrlQps"`

	/* 每个源 IP 对 Host 的防护阈值 (Optional) */
	IpHostQps int64 `json:"ipHostQps"`

	/* 每个源 IP 对 Host + Url 的防护阈值 (Optional) */
	IpHostUrlQps int64 `json:"ipHostUrlQps"`

	/* 开启的 CC 防护规则数量 (Optional) */
	CcProtectionRuleEnableCount int64 `json:"ccProtectionRuleEnableCount"`
}

type CCProtectionConfigSpec added in v1.6.0

type CCProtectionConfigSpec struct {

	/* 防护等级, 0: 正常, 1: 宽松, 2: 紧急, 3: 自定义  */
	Level int `json:"level"`

	/* HTTP 请求数阈值, 防护等级为自定义时必传 (Optional) */
	CcThreshold *int64 `json:"ccThreshold"`

	/* Host 的防护阈值, 防护等级为自定义时必传 (Optional) */
	HostQps *int64 `json:"hostQps"`

	/* Host + Url 的防护阈值, 防护等级为自定义时必传 (Optional) */
	HostUrlQps *int64 `json:"hostUrlQps"`

	/* 每个源 IP 对 Host 的防护阈值, 防护等级为自定义时必传 (Optional) */
	IpHostQps *int64 `json:"ipHostQps"`

	/* 每个源 IP 对 Host + Url 的防护阈值, 防护等级为自定义时必传 (Optional) */
	IpHostUrlQps *int64 `json:"ipHostUrlQps"`
}

type CCProtectionDefaultConfig added in v1.6.0

type CCProtectionDefaultConfig struct {

	/* HTTP 请求数阈值 (Optional) */
	CcThreshold int64 `json:"ccThreshold"`

	/* Host 的防护阈值 (Optional) */
	HostQps int64 `json:"hostQps"`

	/* Host + Url 的防护阈值 (Optional) */
	HostUrlQps int64 `json:"hostUrlQps"`

	/* 每个源 IP 对 Host 的防护阈值 (Optional) */
	IpHostQps int64 `json:"ipHostQps"`

	/* 每个源 IP 对 Host + Url 的防护阈值 (Optional) */
	IpHostUrlQps int64 `json:"ipHostUrlQps"`
}

type CCProtectionRule added in v1.6.0

type CCProtectionRule struct {

	/* CC 防护规则 ID (Optional) */
	Id string `json:"id"`

	/* CC 防护规则对应的网站规则 ID (Optional) */
	WebRuleId string `json:"webRuleId"`

	/* CC 防护规则对应的实例 ID (Optional) */
	InstanceId string `json:"instanceId"`

	/* CC 防护规则名称, 30 字符以内 (Optional) */
	Name string `json:"name"`

	/* CC 防护规则状态: 0: 关闭, 1: 开启 (Optional) */
	Enable int `json:"enable"`

	/* uri, 以 / 开头, 200 字符以内 (Optional) */
	Uri string `json:"uri"`

	/* 匹配 uri 类型, 0: 精确匹配, 1: 前缀匹配 (Optional) */
	MatchType int `json:"matchType"`

	/* 检测周期, 单位为秒, 取值范围[5, 10800] (Optional) */
	DetectPeriod int64 `json:"detectPeriod"`

	/* ip 访问次数, 取值范围[2, 2000] (Optional) */
	SingleIpLimit int64 `json:"singleIpLimit"`

	/* 阻断类型, 1: 封禁并返回自定义页面, 2: 人机交互 (Optional) */
	BlockType int `json:"blockType"`

	/* 阻断持续时间, 单位为秒, 取值范围[10, 86400] (Optional) */
	BlockTime int64 `json:"blockTime"`

	/* 关联的自定义页面id, 阻断类型为封禁时有效, 为空时封禁并返回默认页面 (Optional) */
	PageId string `json:"pageId"`

	/* 关联的自定义页面名称 (Optional) */
	PageName string `json:"pageName"`
}

type CCProtectionRuleSpec added in v1.6.0

type CCProtectionRuleSpec struct {

	/* CC 防护规则名称, 不允许为空, 长度不超过 32 个字符, 支持中文, 大小写字母, 数字及字符'-'、'/'、'.'、'_'  */
	Name string `json:"name"`

	/* uri, 不允许为空, 以 / 开头, 长度不超过 2048 个字符  */
	Uri string `json:"uri"`

	/* 匹配 uri 类型, 0: 精确匹配, 1: 前缀匹配  */
	MatchType int `json:"matchType"`

	/* 检测周期, 单位为秒, 取值范围[5, 10800]  */
	DetectPeriod int64 `json:"detectPeriod"`

	/* ip 访问次数, 取值范围[2, 2000]  */
	SingleIpLimit int64 `json:"singleIpLimit"`

	/* 阻断类型, 1: 封禁并返回自定义页面, 2: 人机交互  */
	BlockType int `json:"blockType"`

	/* 阻断持续时间, 单位为秒, 取值范围[10, 86400]  */
	BlockTime int64 `json:"blockTime"`

	/* 关联的自定义页面id, 阻断类型为封禁时有效, 为空时封禁并返回默认页面 (Optional) */
	PageId *string `json:"pageId"`

	/* 关联的自定义页面名称 (Optional) */
	PageName *string `json:"pageName"`
}

type CcsIpResource added in v1.32.0

type CcsIpResource struct {

	/* 云物理服务器公网 IP 地址 (Optional) */
	Ip string `json:"ip"`

	/* 公网 IP 类型或绑定资源类型. <br>- 0: 未知类型<br>- 1: 弹性公网 IP(IP 为弹性公网 IP, 绑定资源类型未知)<br>- 10: 弹性公网 IP(IP 为弹性公网 IP, 但未绑定资源)<br>- 11: 弹性公网 IP, 绑定了云主机<br>- 12: 弹性公网 IP, 绑定了负载均衡<br>- 13: 弹性公网 IP, 绑定了原生容器实例<br>- 14: 弹性公网 IP, 绑定了原生容器 Pod<br>- 2: 云物理服务器公网 IP<br>- 4: 托管区公网 IP (Optional) */
	ResourceType int `json:"resourceType"`
}

type Cert added in v1.56.0

type Cert struct {

	/* 证书id (Optional) */
	CertId string `json:"certId"`

	/* 证书名称 (Optional) */
	CertName string `json:"certName"`
}

type CertInfo added in v1.6.0

type CertInfo struct {

	/* 通用名称 (Optional) */
	Domain string `json:"domain"`

	/* 证书生效时间 (Optional) */
	From string `json:"from"`

	/* 证书到期时间 (Optional) */
	To string `json:"to"`

	/* 证书组织 (Optional) */
	User string `json:"user"`

	/* 加密算法 (Optional) */
	SigAlgName string `json:"sigAlgName"`

	/* 颁发者 (Optional) */
	Issuer string `json:"issuer"`
}

type CertInfoDescribeSpec added in v1.6.0

type CertInfoDescribeSpec struct {

	/* 域名 (Optional) */
	Domain string `json:"domain"`

	/* 证书内容 (Optional) */
	HttpsCertContent string `json:"httpsCertContent"`
}

type CertInfoModifySpec added in v1.6.0

type CertInfoModifySpec struct {

	/* 证书 Id<br>- 如果传 certId, 请确认已经上传了相应的证书<br>- certId 缺省时网站规则将使用 httpsCertContent, httpsRsaKey 对应的证书 (Optional) */
	CertId *string `json:"certId"`

	/* 证书内容 (Optional) */
	HttpsCertContent *string `json:"httpsCertContent"`

	/* 私钥 (Optional) */
	HttpsRsaKey *string `json:"httpsRsaKey"`
}

type Certificate added in v1.6.0

type Certificate struct {

	/* 证书 Id (Optional) */
	Id string `json:"id"`

	/* 证书名称 (Optional) */
	Name string `json:"name"`

	/* 证书 (Optional) */
	Content string `json:"content"`

	/* 秘钥 (Optional) */
	RsaKey string `json:"rsaKey"`

	/* 绑定域名 (Optional) */
	Domain string `json:"domain"`

	/* 证书生效时间 (Optional) */
	From string `json:"from"`

	/* 证书到期时间 (Optional) */
	To string `json:"to"`

	/* 加密算法 (Optional) */
	SigAlgName string `json:"sigAlgName"`

	/* 颁发者 (Optional) */
	Issuer string `json:"issuer"`

	/* 颁发给 (Optional) */
	Organization string `json:"organization"`

	/* 上传时间 (Optional) */
	UploadTime string `json:"uploadTime"`

	/* 已关联域名 (Optional) */
	AssociatedDomains []string `json:"associatedDomains"`

	/* 推荐域名 (Optional) */
	SanDomains []string `json:"sanDomains"`
}

type CertificateSpec added in v1.6.0

type CertificateSpec struct {

	/* 证书名称 (Optional) */
	Name string `json:"name"`

	/* 证书内容 (Optional) */
	Content string `json:"content"`

	/* 私钥 (Optional) */
	RsaKey string `json:"rsaKey"`
}

type Country added in v1.6.0

type Country struct {

	/* 国家或地区名称 (Optional) */
	Label string `json:"label"`

	/* 国家或地区编码 (Optional) */
	Value string `json:"value"`

	/*  (Optional) */
	Children []Country `json:"children"`
}

type CpsIpResource added in v1.10.0

type CpsIpResource struct {

	/* 云物理服务器公网 IP 地址 (Optional) */
	Ip string `json:"ip"`

	/* 公网 IP 类型或绑定资源类型. <br>- 0: 未知类型<br>- 1: 弹性公网 IP(IP 为弹性公网 IP, 绑定资源类型未知)<br>- 10: 弹性公网 IP(IP 为弹性公网 IP, 但未绑定资源)<br>- 11: 弹性公网 IP, 绑定了云主机<br>- 12: 弹性公网 IP, 绑定了负载均衡<br>- 13: 弹性公网 IP, 绑定了原生容器实例<br>- 14: 弹性公网 IP, 绑定了原生容器 Pod<br>- 2: 云物理服务器公网 IP<br>- 4: 托管区公网 IP (Optional) */
	ResourceType int `json:"resourceType"`
}

type CreateDispatchRuleSpec added in v1.32.0

type CreateDispatchRuleSpec struct {

	/* 规则名称  */
	Name string `json:"name"`

	/* 高防 IP (Optional) */
	ServiceIp *string `json:"serviceIp"`

	/* 云内IP  */
	InnerIps []string `json:"innerIps"`

	/* 触发调度的流量阈值, 单位 Mbps  */
	DispatchThresholdMbps int64 `json:"dispatchThresholdMbps"`

	/* 触发调度的报文阈值, 单位 pps  */
	DispatchThresholdPps int64 `json:"dispatchThresholdPps"`
}

type CreateInstanceSpec added in v1.6.0

type CreateInstanceSpec struct {

	/* 实例 Id, 升级时必传 (Optional) */
	Id *string `json:"id"`

	/* 实例名称, 新购时必传 (Optional) */
	Name *string `json:"name"`

	/* 购买类型. <br>- 1: 新购<br>- 3: 升级  */
	BuyType int `json:"buyType"`

	/* 链路类型. <br>- 3: 电信、联通和移动<br>- 4: BGP 线路  */
	Carrier int `json:"carrier"`

	/* 可防护 ip 类型, 目前仅电信线路支持 IPV6 线路<br>- 0: IPV4,<br>- 1: IPV4/IPV6 (Optional) */
	IpType *int `json:"ipType"`

	/* IP 数量 (Optional) */
	IpCount *int `json:"ipCount"`

	/* 可配的转发端口数量 (Optional) */
	PortCount *int `json:"portCount"`

	/* 可配的网站规则域名数量 (Optional) */
	DomainCount *int `json:"domainCount"`

	/* 保底带宽: 单位 Gbps  */
	Bp int `json:"bp"`

	/* 弹性带宽: 单位 Gbps  */
	Ep int `json:"ep"`

	/* 业务带宽: 单位 Mbps  */
	Bw int `json:"bw"`

	/* 购买时长, 新购高防实例时必传<br>- timeUnit 为 3 时, 可取值 1-9<br>- timeUnit 为 4 时, 可取值 1-3 (Optional) */
	TimeSpan *int `json:"timeSpan"`

	/* 购买时长类型, 新购高防实例时必传<br>- 3: 月<br>- 4: 年 (Optional) */
	TimeUnit *int `json:"timeUnit"`

	/* 支付成功后跳转的页面, 控制台交互模式传该字段 (Optional) */
	ReturnUrl *string `json:"returnUrl"`
}

type CustomPage added in v1.32.0

type CustomPage struct {

	/* 自定义页面Id (Optional) */
	Id string `json:"id"`

	/* 自定义页面名称 (Optional) */
	Name string `json:"name"`

	/* 自定义页面内容 (Optional) */
	Content string `json:"content"`

	/* 更新时间 (Optional) */
	UpdateTime string `json:"updateTime"`

	/* approving: 审批中, refused: 审批不通过, approved: 审批通过 (Optional) */
	Status string `json:"status"`
}

type CustomPageSpec added in v1.32.0

type CustomPageSpec struct {

	/* 自定义页面名称, 创建后不可修改, 添加自定义页面时必传 (Optional) */
	Name *string `json:"name"`

	/* 自定义页面内容, 添加自定义页面时必传  */
	Content string `json:"content"`
}

type DDoSAttackLog added in v1.10.0

type DDoSAttackLog struct {

	/* 攻击流量大小 (Optional) */
	AttackTraffic float64 `json:"attackTraffic"`

	/* 封禁状态,0:未封禁,1:封禁中,2:封禁结束 (Optional) */
	BlackHole int `json:"blackHole"`

	/* 攻击开始时间 (Optional) */
	StartTime string `json:"startTime"`

	/* 攻击结束时间 (Optional) */
	EndTime string `json:"endTime"`

	/* 流量单位, bps、Kbps、Mbps、Gbps (Optional) */
	Unit string `json:"unit"`

	/* 高防实例id (Optional) */
	InstanceId string `json:"instanceId"`

	/* 高防实例名称 (Optional) */
	Name string `json:"name"`
}

type DDoSIpAttackLog added in v1.52.0

type DDoSIpAttackLog struct {

	/* 高防 IP (Optional) */
	ServiceIp string `json:"serviceIp"`

	/* 攻击流量大小 (Optional) */
	AttackTraffic float64 `json:"attackTraffic"`

	/* 封禁状态,0:未封禁,1:封禁中,2:封禁结束 (Optional) */
	BlackHole int `json:"blackHole"`

	/* 攻击开始时间 (Optional) */
	StartTime string `json:"startTime"`

	/* 攻击结束时间 (Optional) */
	EndTime string `json:"endTime"`

	/* 流量单位, bps、Kbps、Mbps、Gbps (Optional) */
	Unit string `json:"unit"`

	/* 高防实例id (Optional) */
	InstanceId string `json:"instanceId"`

	/* 高防实例名称 (Optional) */
	Name string `json:"name"`
}

type DispatchRule added in v1.32.0

type DispatchRule struct {

	/* 规则 Id (Optional) */
	Id string `json:"id"`

	/* 规则名称 (Optional) */
	Name string `json:"name"`

	/* 规则的 CNAME (Optional) */
	Cname string `json:"cname"`

	/* 高防 IP (Optional) */
	ServiceIp string `json:"serviceIp"`

	/* 云内IP (Optional) */
	InnerIps []string `json:"innerIps"`

	/* 触发调度的流量阈值, 单位 Mbps (Optional) */
	DispatchThresholdMbps int64 `json:"dispatchThresholdMbps"`

	/* 触发调度的报文阈值, 单位 pps (Optional) */
	DispatchThresholdPps int64 `json:"dispatchThresholdPps"`

	/* 0: 防御状态, 1: 回源状态 (Optional) */
	Status int `json:"status"`
}

type DispatchedInnerIp added in v1.54.0

type DispatchedInnerIp struct {

	/* 云内IP (Optional) */
	Ip string `json:"ip"`

	/* 配置了该云内IP的调度规则Id (Optional) */
	Ids []string `json:"ids"`
}

type EPBSpec added in v1.6.0

type EPBSpec struct {

	/* 弹性防护带宽 (Optional) */
	EPB int `json:"ePB"`
}

type FailedDomain added in v1.20.0

type FailedDomain struct {

	/* 子域名 (Optional) */
	Domain string `json:"domain"`

	/* 错误原因 (Optional) */
	Message string `json:"message"`
}

type FailedPort added in v1.20.0

type FailedPort struct {

	/* 端口号 (Optional) */
	Port int `json:"port"`

	/* 错误原因 (Optional) */
	Message string `json:"message"`
}

type FailedRule added in v1.32.0

type FailedRule struct {

	/* 规则名称 (Optional) */
	Name string `json:"name"`

	/* 错误原因 (Optional) */
	Message string `json:"message"`
}

type ForwardBlackListRule added in v1.10.0

type ForwardBlackListRule struct {

	/* 是否开启, 0: 关闭, 1: 开启 (Optional) */
	Status int `json:"status"`

	/* 引用的 IP 黑白名单 Id (Optional) */
	IpSetId string `json:"ipSetId"`

	/* 引用的 IP 黑白名单名称 (Optional) */
	IpSetName string `json:"ipSetName"`

	/* 为 IP 或 IP 段的数组 (Optional) */
	Ip []string `json:"ip"`
}

type ForwardProtectionRule added in v1.6.0

type ForwardProtectionRule struct {

	/* 虚假源与空连接, 0: 关闭, 1: 开启 (Optional) */
	SpoofIpEnable int `json:"spoofIpEnable"`

	/* 源新建连接限速, 0: 关闭, 1: 开启 (Optional) */
	SrcNewConnLimitEnable int `json:"srcNewConnLimitEnable"`

	/* 源新建连接速率 (Optional) */
	SrcNewConnLimitValue int64 `json:"srcNewConnLimitValue"`

	/* 源并发连接限速, 0: 关闭, 1: 开启 (Optional) */
	SrcConcurrentConnLimitEnable int `json:"srcConcurrentConnLimitEnable"`

	/* 源并发连接速率 (Optional) */
	SrcConcurrentConnLimitValue int64 `json:"srcConcurrentConnLimitValue"`

	/* 目的新建连接限速, 0: 关闭, 1: 开启 (Optional) */
	DstNewConnLimitEnable int `json:"dstNewConnLimitEnable"`

	/* 目的新建连接速率 (Optional) */
	DstNewConnLimitValue int64 `json:"dstNewConnLimitValue"`

	/* 目的并发连接限速, 0: 关闭, 1: 开启 (Optional) */
	DstConcurrentConnLimitEnable int `json:"dstConcurrentConnLimitEnable"`

	/* 目的并发连接速率 (Optional) */
	DstConcurrentConnLimitValue int64 `json:"dstConcurrentConnLimitValue"`

	/* 报文最小长度 (Optional) */
	DatagramRangeMin int64 `json:"datagramRangeMin"`

	/* 报文最大长度 (Optional) */
	DatagramRangeMax int64 `json:"datagramRangeMax"`

	/* geo 拦截地域列表 (Optional) */
	GeoBlackList []Geo `json:"geoBlackList"`
}

type ForwardProtectionRuleSpec added in v1.6.0

type ForwardProtectionRuleSpec struct {

	/* 虚假源与空连接, 0: 关闭, 1: 开启  */
	SpoofIpEnable int `json:"spoofIpEnable"`

	/* 源新建连接限速, 0: 关闭, 1: 开启  */
	SrcNewConnLimitEnable int `json:"srcNewConnLimitEnable"`

	/* 源新建连接速率  */
	SrcNewConnLimitValue int64 `json:"srcNewConnLimitValue"`

	/* 源并发连接限速, 0: 关闭, 1: 开启  */
	SrcConcurrentConnLimitEnable int `json:"srcConcurrentConnLimitEnable"`

	/* 源并发连接速率  */
	SrcConcurrentConnLimitValue int64 `json:"srcConcurrentConnLimitValue"`

	/* 目的新建连接, 0: 关闭, 1: 开启  */
	DstNewConnLimitEnable int `json:"dstNewConnLimitEnable"`

	/* 目的新建连接速率  */
	DstNewConnLimitValue int64 `json:"dstNewConnLimitValue"`

	/* 目的并发连接, 0: 关闭, 1: 开启  */
	DstConcurrentConnLimitEnable int `json:"dstConcurrentConnLimitEnable"`

	/* 目的并发连接速率  */
	DstConcurrentConnLimitValue int64 `json:"dstConcurrentConnLimitValue"`

	/* 报文最小长度, 取值范围[0, datagramRangeMax)  */
	DatagramRangeMin int64 `json:"datagramRangeMin"`

	/* 报文最大长度, 取值范围(datagramRangeMin, 1518]  */
	DatagramRangeMax int64 `json:"datagramRangeMax"`

	/* geo 拦截地域编码列表. 查询 <a href="http://docs.jdcloud.com/anti-ddos-pro/api/describegeoareas">describeGeoAreas</a> 接口获取可设置的地域编码列表 (Optional) */
	GeoBlackList []string `json:"geoBlackList"`
}

type ForwardRule

type ForwardRule struct {

	/* 规则 Id (Optional) */
	Id string `json:"id"`

	/* 实例 Id (Optional) */
	InstanceId string `json:"instanceId"`

	/* TCP 或 UDP (Optional) */
	Protocol string `json:"protocol"`

	/* 规则的 CNAME (Optional) */
	Cname string `json:"cname"`

	/* 回源类型: ip 或者 domain (Optional) */
	OriginType string `json:"originType"`

	/* 该规则使用中的高防 IP (Optional) */
	ServiceIp string `json:"serviceIp"`

	/* 已配置的高防 IP 列表 (Optional) */
	ServiceIpConfig ServiceIpConfig `json:"serviceIpConfig"`

	/* 端口号 (Optional) */
	Port int `json:"port"`

	/* 转发规则. <br>- wrr: 带权重的轮询<br>- rr:  不带权重的轮询<br>- sh:  源地址hash (Optional) */
	Algorithm string `json:"algorithm"`

	/*  (Optional) */
	OriginAddr []OriginAddrItem `json:"originAddr"`

	/* 备用的回源地址列表 (Optional) */
	OnlineAddr []string `json:"onlineAddr"`

	/* 回源域名 (Optional) */
	OriginDomain string `json:"originDomain"`

	/* 回源端口号 (Optional) */
	OriginPort int `json:"originPort"`

	/* 0: 防御状态<br>1: 回源状态 (Optional) */
	Status int `json:"status"`
}

type ForwardRuleSpec

type ForwardRuleSpec struct {

	/* 协议: TCP 或者 UDP  */
	Protocol string `json:"protocol"`

	/* 高防 IP, serviceIps 为空时生效 (Optional) */
	ServiceIp *string `json:"serviceIp"`

	/* 高防 IP 列表, 不为空时忽略 serviceIp, 传多个时后台会在高防IP封禁后随机切换其他未封禁的IP (Optional) */
	ServiceIps []string `json:"serviceIps"`

	/* 端口号, 取值范围[1, 65535]  */
	Port int `json:"port"`

	/* 转发规则. <br>- wrr: 带权重的轮询<br>- rr:  不带权重的轮询<br>- sh:  源地址hash  */
	Algorithm string `json:"algorithm"`

	/* 回源类型: A 或者 CNAME  */
	OriginType string `json:"originType"`

	/*  (Optional) */
	OriginAddr []OriginAddrItem `json:"originAddr"`

	/* 备用的回源地址列表, 可以配置为一个域名或者多个 ip 地址 (Optional) */
	OnlineAddr []string `json:"onlineAddr"`

	/* 回源域名 (Optional) */
	OriginDomain *string `json:"originDomain"`

	/* 回源端口号, 取值范围[1, 65535]  */
	OriginPort int `json:"originPort"`
}

type ForwardWhiteListRule added in v1.10.0

type ForwardWhiteListRule struct {

	/* 是否开启, 0: 关闭, 1: 开启 (Optional) */
	Status int `json:"status"`

	/* 引用的 IP 黑白名单 Id (Optional) */
	IpSetId string `json:"ipSetId"`

	/* 引用的 IP 黑白名单名称 (Optional) */
	IpSetName string `json:"ipSetName"`

	/* IP 或 IP 段的数组 (Optional) */
	Ip []string `json:"ip"`
}

type Geo added in v1.10.0

type Geo struct {

	/* geo 拦截地域 (Optional) */
	Label string `json:"label"`

	/* geo 拦截地域编码 (Optional) */
	Value string `json:"value"`
}

type GeoRsRoute added in v1.20.0

type GeoRsRoute struct {

	/* 要设置的区域编码, 查询 <a href='http://docs.jdcloud.com/anti-ddos-pro/api/describeWebRuleRSGeoAreas'>describeWebRuleRSGeoAreas</a> 接口获取可设置的地域编码  */
	Geo string `json:"geo"`

	/* 对应区域的回源IP的列表  */
	RsAddr []string `json:"rsAddr"`
}

type Instance

type Instance struct {

	/* 实例 ID (Optional) */
	Id string `json:"id"`

	/* 实例名称 (Optional) */
	Name string `json:"name"`

	/* 链路类型. <br>- 1: 电信<br>- 3: 电信、联通和移动<br>- 4: BGP 线路 (Optional) */
	Carrier int `json:"carrier"`

	/* 可防护 IP 类型, 目前仅电信线路支持 IPV6 线路. <br>- 0: IPV4. <br>- 1: IPV4/IPV6 (Optional) */
	IpType int `json:"ipType"`

	/* IP 数量 (Optional) */
	IpCount int `json:"ipCount"`

	/* 可配的转发端口数量 (Optional) */
	PortCount int `json:"portCount"`

	/* 可配的网站规则域名数量 (Optional) */
	DomainCount int `json:"domainCount"`

	/* 触发弹性带宽的次数 (Optional) */
	ElasticTriggerCount int `json:"elasticTriggerCount"`

	/* 超峰次数 (Optional) */
	AbovePeakCount int `json:"abovePeakCount"`

	/* 保底带宽 (Optional) */
	InBitslimit int `json:"inBitslimit"`

	/* 弹性带宽 (Optional) */
	ResilientBitslimit int `json:"resilientBitslimit"`

	/* 业务带宽大小 (Optional) */
	BusinessBitslimit int `json:"businessBitslimit"`

	/* CC 阈值大小 (Optional) */
	CcThreshold int `json:"ccThreshold"`

	/* CC 防护峰值, 单位: QPS (Optional) */
	CcPeakQPS int `json:"ccPeakQPS"`

	/* 非网站类规则数 (Optional) */
	RuleCount int `json:"ruleCount"`

	/* 网站类规则数 (Optional) */
	WebRuleCount int `json:"webRuleCount"`

	/* 防护调度规则数 (Optional) */
	DispatchRuleCount int `json:"dispatchRuleCount"`

	/* 计费状态. <br>- PAID: 已支付<br>- ARREARS: 欠费<br>- EXPIRED: 过期 (Optional) */
	ChargeStatus string `json:"chargeStatus"`

	/* 安全状态. <br>- SAFE: 安全<br>- CLEANING: 清洗中<br>- BLOCKING: 封禁中 (Optional) */
	SecurityStatus string `json:"securityStatus"`

	/* 实例的创建的时间 (Optional) */
	CreateTime string `json:"createTime"`

	/* 实例的过期时间 (Optional) */
	ExpireTime string `json:"expireTime"`

	/* 资源 ID, 升级和续费时使用 (Optional) */
	ResourceId string `json:"resourceId"`

	/* CC 防护观察者模式. <br>- 0: 关闭 <br>- 1: 开启 (Optional) */
	CcObserveMode int `json:"ccObserveMode"`

	/* CC 防护模式. <br>- 0: 正常 <br>- 1: 紧急 <br>- 2: 宽松 <br>- 3: 自定义 (Optional) */
	CcProtectMode int `json:"ccProtectMode"`

	/* CC 开关状态. <br>- 0: 关闭 <br>- 1: 开启 (Optional) */
	CcProtectStatus int `json:"ccProtectStatus"`

	/* CC 防护模式为自定义时的限速大小 (Optional) */
	CcSpeedLimit int `json:"ccSpeedLimit"`

	/* CC 防护模式为自定义时的限速周期 (Optional) */
	CcSpeedPeriod int `json:"ccSpeedPeriod"`

	/* IP 黑名单列表 (Optional) */
	IpBlackList []string `json:"ipBlackList"`

	/* IP 黑名单状态. <br>- 0: 关闭 <br>- 1: 开启 (Optional) */
	IpBlackStatus int `json:"ipBlackStatus"`

	/* IP 白名单列表 (Optional) */
	IpWhiteList []string `json:"ipWhiteList"`

	/* IP 白名单状态. <br>- 0: 关闭<br>- 1: 开启 (Optional) */
	IpWhiteStatus int `json:"ipWhiteStatus"`

	/* url白名单列表 (Optional) */
	UrlWhitelist []string `json:"urlWhitelist"`

	/* url白名单状态. <br>- 0: 关闭<br>- 1: 开启 (Optional) */
	UrlWhitelistStatus int `json:"urlWhitelistStatus"`

	/* ccProtectMode为自定义模式时, 每个Host的防护阈值 (Optional) */
	HostQps int `json:"hostQps"`

	/* ccProtectMode为自定义模式时, 每个Host+URI的防护阈值 (Optional) */
	HostUrlQps int `json:"hostUrlQps"`

	/* ccProtectMode为自定义模式时, 每个源IP对Host的防护阈值 (Optional) */
	IpHostQps int `json:"ipHostQps"`

	/* ccProtectMode为自定义模式时, 每个源IP对Host+URI的防护阈值 (Optional) */
	IpHostUrlQps int `json:"ipHostUrlQps"`

	/* 关联的自定义页面id (Optional) */
	PageId string `json:"pageId"`

	/* 关联的自定义页面名称 (Optional) */
	PageName string `json:"pageName"`

	/* 是否开启自定义页面, 关闭时透传状态码.  <br>- 0: 关闭<br>- 1: 开启 (Optional) */
	PageStatus int `json:"pageStatus"`

	/* 每条网站规则可配的http/https端口数 (Optional) */
	WebRulePortLimit int `json:"webRulePortLimit"`

	/* Tag信息 (Optional) */
	Tags []Tag `json:"tags"`
}

type InstanceAcl added in v1.20.0

type InstanceAcl struct {

	/* 黑名单引用的IP黑白名单库列表 (Optional) */
	BlackListIds []IpSet `json:"blackListIds"`

	/* 白名单引用的IP黑白名单库列表 (Optional) */
	WhiteListIds []IpSet `json:"whiteListIds"`

	/* geo 拦截地域列表 (Optional) */
	GeoBlack []Geo `json:"geoBlack"`

	/* 上一次修改是否下发成功 (Optional) */
	Success bool `json:"success"`

	/* 上一次修改下发失败的情况下,是否可以回滚到上一次修改之前下发成功的配置 (Optional) */
	CanRecover bool `json:"canRecover"`
}

type InstanceAclSpec added in v1.20.0

type InstanceAclSpec struct {

	/* 黑名单引用的 IP 黑白名单 ID 列表 (Optional) */
	BlackListIds []string `json:"blackListIds"`

	/* 白名单引用的 IP 黑白名单 ID 列表 (Optional) */
	WhiteListIds []string `json:"whiteListIds"`

	/* geo 拦截地域编码列表. 查询 <a href="http://docs.jdcloud.com/anti-ddos-pro/api/describegeoareas">describeGeoAreas</a> 接口获取可设置的地域编码列表 (Optional) */
	GeoBlack []string `json:"geoBlack"`
}

type InstanceBillingId added in v1.46.0

type InstanceBillingId struct {

	/* 高防实例 Id (Optional) */
	ResourceId string `json:"resourceId"`

	/* 在计费侧对应的包年包月类型的资源Id (Optional) */
	BillingIdBP string `json:"billingIdBP"`

	/* 在计费侧对应的按用量后付费类型的资源Id (Optional) */
	BillingIdEP string `json:"billingIdEP"`
}

type InstanceIdName added in v1.6.0

type InstanceIdName struct {

	/* 实例id (Optional) */
	Id string `json:"id"`

	/* 实例名称 (Optional) */
	Name string `json:"name"`
}

type InstanceIdVo added in v1.56.0

type InstanceIdVo struct {

	/* 高防实例计费资源ID (Optional) */
	ResourceId string `json:"resourceId"`

	/* 高防实例ID (Optional) */
	InstanceId string `json:"instanceId"`
}

type InstanceName added in v1.46.0

type InstanceName struct {

	/* 高防实例 Id (Optional) */
	ResourceId string `json:"resourceId"`

	/* 高防实例名称 (Optional) */
	Name string `json:"name"`
}

type InstanceTagEnable added in v1.46.0

type InstanceTagEnable struct {

	/* 高防实例 Id (Optional) */
	ResourceId string `json:"resourceId"`

	/* 是否可以打标签 (Optional) */
	TagEnable bool `json:"tagEnable"`
}

type IpBwListSpec added in v1.6.0

type IpBwListSpec struct {

	/* IP 或 IP 段列表  */
	IpList []string `json:"ipList"`

	/* false 时强制写入, true 时有重复则不写入  */
	TryFlag bool `json:"tryFlag"`
}

type IpSet added in v1.10.0

type IpSet struct {

	/* IP 黑白名单 Id (Optional) */
	Id string `json:"id"`

	/* IP 黑白名单的名称 (Optional) */
	Name string `json:"name"`
}

type IpSetSpec added in v1.10.0

type IpSetSpec struct {

	/* IP 黑白名单名称  */
	Name string `json:"name"`

	/* IP 或 IP 段的数组  */
	Ip []string `json:"ip"`
}

type JsPage added in v1.46.0

type JsPage struct {

	/* 允许插入JS指纹的页面 ID (Optional) */
	Id string `json:"id"`

	/* 允许插入JS指纹的页面 URI (Optional) */
	Uri string `json:"uri"`

	/* 页面添加时间 (Optional) */
	CreateTime string `json:"createTime"`

	/* 页面更新时间 (Optional) */
	UpdateTime string `json:"updateTime"`
}

type JsPageSpec added in v1.46.0

type JsPageSpec struct {

	/* 允许插入JS指纹的页面 URI (Optional) */
	Uri *string `json:"uri"`
}

type JsPagesSpec added in v1.46.0

type JsPagesSpec struct {

	/* 允许插入JS指纹的页面 URI 列表 (Optional) */
	Uris []string `json:"uris"`
}

type ModifyBlackListRuleOfForwardRuleSpec added in v1.10.0

type ModifyBlackListRuleOfForwardRuleSpec struct {

	/* 待引用的 IP 黑白名单 Id  */
	IpSetId string `json:"ipSetId"`
}

type ModifyDispatchRuleSpec added in v1.32.0

type ModifyDispatchRuleSpec struct {

	/* 规则名称  */
	Name string `json:"name"`

	/* 高防 IP (Optional) */
	ServiceIp *string `json:"serviceIp"`

	/* 云内IP  */
	InnerIps []string `json:"innerIps"`

	/* 触发调度的流量阈值, 单位 Mbps  */
	DispatchThresholdMbps int64 `json:"dispatchThresholdMbps"`

	/* 触发调度的报文阈值, 单位 pps  */
	DispatchThresholdPps int64 `json:"dispatchThresholdPps"`
}

type ModifyInstanceAclGEOSpec added in v1.56.0

type ModifyInstanceAclGEOSpec struct {

	/* geo 拦截地域编码列表. 查询 <a href="http://docs.jdcloud.com/anti-ddos-pro/api/describegeoareas">describeGeoAreas</a> 接口获取可设置的地域编码列表 (Optional) */
	GeoBlack []string `json:"geoBlack"`
}

type ModifyInstanceEPBSpec added in v1.6.0

type ModifyInstanceEPBSpec struct {

	/* 弹性带宽: 单位 Gbps  */
	Ep int `json:"ep"`
}

type ModifyWhiteListRuleOfForwardRuleSpec added in v1.10.0

type ModifyWhiteListRuleOfForwardRuleSpec struct {

	/* 待引用的 IP 黑白名单 Id  */
	IpSetId string `json:"ipSetId"`
}

type OriginAddrItem added in v1.0.3

type OriginAddrItem struct {

	/* 回源ip (Optional) */
	Ip *string `json:"ip"`

	/* 权重 (Optional) */
	Weight *int `json:"weight"`

	/* 是否为京东云内公网ip (Optional) */
	InJdCloud *bool `json:"inJdCloud"`
}

type PriceSpec added in v1.6.0

type PriceSpec struct {

	/* 操作类型 1: 新购高防实例, 3: 升级高防实例  */
	BuyType int `json:"buyType"`

	/* 计费类型 1: 按配置 2: 按用量 3: 包年包月  */
	BillingType int `json:"billingType"`

	/* 链路类型, 1: 电信, 2: 电信、联通, 3: 电信、联通和移动  */
	Carrier int `json:"carrier"`

	/* 业务带宽: 100, 150, 200, 250, ..., 2000, 单位: M  */
	Bw int `json:"bw"`

	/* 保底带宽: 0, 10, 20, 30, 40, 50, 60, 80, 100, 单位: Gbps  */
	Bp int `json:"bp"`

	/* 弹性带宽: 0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 120, 150, 200, 单位: Gbps  */
	Ep int `json:"ep"`

	/* 实例 Id, 升级高防实例查询价格时必传 (Optional) */
	Id string `json:"id"`

	/* 购买防护包时长, 新购高防实例时必传
	- timeUnit 为 3 时, 可取值 1-9
	- timeUnit 为 4 时, 可取值 1-3
	 (Optional) */
	TimeSpan int `json:"timeSpan"`

	/* 购买时长类型, 新购高防实例时必传
	- 3: 月
	- 4: 年 (Optional) */
	TimeUnit int `json:"timeUnit"`
}

type ProtectionOutline added in v1.6.0

type ProtectionOutline struct {

	/* 实例数量 (Optional) */
	InstancesCount int `json:"instancesCount"`

	/* 已防护实例数量 (Optional) */
	ProtectedCount int `json:"protectedCount"`

	/* 已防护天数 (Optional) */
	ProtectedDay int `json:"protectedDay"`

	/* 7 日攻击次数 (Optional) */
	WeekAttackCount int `json:"weekAttackCount"`

	/* 7 日攻击流量峰值 (Optional) */
	WeekAttackPeak float64 `json:"weekAttackPeak"`

	/* 7 日攻击流量单位 (Optional) */
	WeekAttackUnit string `json:"weekAttackUnit"`

	/* 30 日攻击次数 (Optional) */
	MonthAttackCount int `json:"monthAttackCount"`

	/* 30 日攻击流量峰值 (Optional) */
	MonthAttackPeak float64 `json:"monthAttackPeak"`

	/* 30 日攻击流量单位 (Optional) */
	MonthAttackUnit string `json:"monthAttackUnit"`
}

type ProtectionStatistics added in v1.6.0

type ProtectionStatistics struct {

	/* 实例数量 (Optional) */
	InstancesCount int `json:"instancesCount"`

	/* 已防护实例数量 (Optional) */
	ProtectedCount int `json:"protectedCount"`

	/* 已防护天数 (Optional) */
	ProtectedDay int `json:"protectedDay"`
}

type RenameInstanceSpec added in v1.6.0

type RenameInstanceSpec struct {

	/* 实例名称  */
	Name string `json:"name"`
}

type ServiceIp added in v1.20.0

type ServiceIp struct {

	/* 高防IP (Optional) */
	ServiceIp string `json:"serviceIp"`

	/* 安全状态. <br>- SAFE: 安全<br>- CLEANING: 清洗中<br>- BLOCKING: 封禁中 (Optional) */
	SecurityStatus string `json:"securityStatus"`
}

type ServiceIpConfig added in v1.56.0

type ServiceIpConfig struct {

	/* 已配置的高防IP列表 (Optional) */
	ServiceIps []ServiceIpConfigItem `json:"serviceIps"`
}

type ServiceIpConfigItem added in v1.56.0

type ServiceIpConfigItem struct {

	/* 高防IP (Optional) */
	ServiceIp string `json:"serviceIp"`

	/* 安全状态. <br>- SAFE: 安全<br>- CLEANING: 清洗中<br>- BLOCKING: 封禁中 (Optional) */
	SecurityStatus string `json:"securityStatus"`

	/* 使用状态, 1: 使用中, 0: 备用候选 (Optional) */
	UseStatus int `json:"useStatus"`
}

type Status added in v1.6.0

type Status struct {

	/* 请求结果, 0 表示成功, 非 0 表示失败 (Optional) */
	Retcode int `json:"retcode"`

	/* 请求错误码 (Optional) */
	Code int `json:"code"`

	/* 请求错误消息 (Optional) */
	Msg string `json:"msg"`
}

type Tag added in v1.52.0

type Tag struct {

	/* Tag键  */
	Key string `json:"key"`

	/* Tag值  */
	Value string `json:"value"`
}

type VpcIpResource added in v1.6.0

type VpcIpResource struct {

	/* 云内 IP 地址 (Optional) */
	Ip string `json:"ip"`

	/* 是否绑定 (Optional) */
	Binded bool `json:"binded"`

	/* 公网 IP 类型或绑定资源类型. <br>- 0: 未知类型<br>- 1: 弹性公网 IP(IP 为弹性公网 IP, 绑定资源类型未知)<br>- 10: 弹性公网 IP(IP 为弹性公网 IP, 但未绑定资源)<br>- 11: 弹性公网 IP, 绑定了云主机<br>- 12: 弹性公网 IP, 绑定了负载均衡<br>- 13: 弹性公网 IP, 绑定了原生容器实例<br>- 14: 弹性公网 IP, 绑定了原生容器 Pod<br>- 2: 云物理服务器公网 IP<br>- 4: 托管区公网 IP (Optional) */
	ResourceType int `json:"resourceType"`
}

type WebBlackListRule added in v1.10.0

type WebBlackListRule struct {

	/* 黑名单规则 Id (Optional) */
	Id string `json:"id"`

	/* 黑名单规则名称 (Optional) */
	Name string `json:"name"`

	/* 匹配模式:<br>- 0: uri<br>- 1: ip<br>- 2: cookie<br>- 3: geo<br>- 4: header (Optional) */
	Mode int `json:"mode"`

	/* 匹配 key. <br>- mode 为 cookie 时, 为 cookie 的 name<br>- mode 为 header 时, 为 header 的 key (Optional) */
	Key string `json:"key"`

	/* 匹配 value. <br>- mode 为 uri 时, 为要匹配的 uri<br>- mode 为 ip 时, 为引用的 ip 黑白名单 Id<br>- mode 为 cookie 时, 为 cookie 的 value<br>- mode 为 header 时, 为 header 的 value (Optional) */
	Value string `json:"value"`

	/* 匹配规则, mode 为 uri, cookie 和 header 时有效. 包含以下匹配规则: <br>- 0: 完全匹配<br>- 1: 前缀匹配<br>- 2: 包含<br>- 3: 正则匹配<br>- 4: 后缀匹配 (Optional) */
	Pattern int `json:"pattern"`

	/* 命中后处理动作. <br>- 0: 封禁并返回自定义页面<br>- 1: 跳转<br>- 2: 验证码 (Optional) */
	Action int `json:"action"`

	/* 命中后处理值, 命中后处理动作为跳转时有效, 表示跳转路径 (Optional) */
	ActionValue string `json:"actionValue"`

	/* 规则状态. <br>- 0: 关闭<br>- 1: 开启 (Optional) */
	Status int `json:"status"`

	/* geo 黑名单地域列表, mode 不为 geo 或未设置时此字段为空 (Optional) */
	GeoList []Geo `json:"geoList"`

	/* 关联的自定义页面id, 命中后处理动作为封禁并返回自定义页面时有效, 为空时表示默认页面 (Optional) */
	PageId string `json:"pageId"`

	/* 关联的自定义页面名称, 命中后处理动作为封禁并返回自定义页面时有效 (Optional) */
	PageName string `json:"pageName"`
}

type WebBlackListRuleSpec added in v1.10.0

type WebBlackListRuleSpec struct {

	/* 黑名单规则名称  */
	Name string `json:"name"`

	/* 模式:<br>- 0: uri<br>- 1: ip<br>- 2: cookie<br>- 3: geo<br>- 4: header  */
	Mode int `json:"mode"`

	/* 匹配 key, mode 为 cookie 和 header 时必传. <br>- mode 为 cookie 时, 传 cookie 的 name<br>- mode 为 header 时, 传 header 的 key (Optional) */
	Key *string `json:"key"`

	/* 匹配 value. <br>- mode 为 uri 时, 传要匹配的 uri<br>- mode 为 ip 时, 传引用的 ip 黑白名单 Id<br>- mode 为 cookie 时, 传 cookie 的 value<br>- mode 为 geo 时, 传 geo 区域编码以 ',' 分隔的字符串. 查询 <a href='http://docs.jdcloud.com/anti-ddos-pro/api/describewebruleblacklistgeoareas'>describeWebRuleBlackListGeoAreas</a> 接口获取可设置的地域编码列表<br>- mode 为 header 时, 传 header 的 value  */
	Value string `json:"value"`

	/* 匹配规则, mode 为 uri, cookie 和 header 时必传. 支持以下匹配规则: <br>- 0: 完全匹配<br>- 1: 前缀匹配<br>- 2: 包含<br>- 3: 正则匹配<br>- 4: 后缀匹配 (Optional) */
	Pattern *int `json:"pattern"`

	/* 命中后处理动作. <br>- 0: 封禁并返回自定义页面<br>- 1: 跳转<br>- 2: 验证码  */
	Action int `json:"action"`

	/* 命中后处理值, 命中后处理动作为跳转时有效, 表示跳转路径 (Optional) */
	ActionValue *string `json:"actionValue"`

	/* 规则状态. <br>- 0: 关闭<br>- 1: 开启  */
	Status int `json:"status"`

	/* 关联的自定义页面id, 命中后处理动作为封禁并返回自定义页面时有效, 为空时表示默认页面 (Optional) */
	PageId *string `json:"pageId"`
}

type WebRule

type WebRule struct {

	/* 规则 Id (Optional) */
	Id string `json:"id"`

	/* 实例 Id (Optional) */
	InstanceId string `json:"instanceId"`

	/* 子域名 (Optional) */
	Domain string `json:"domain"`

	/* 规则的 CNAME (Optional) */
	Cname string `json:"cname"`

	/* CNAME 解析状态, 0: 解析异常, 1: 解析正常 (Optional) */
	CnameStatus int `json:"cnameStatus"`

	/* 该规则使用中的高防 IP (Optional) */
	ServiceIp string `json:"serviceIp"`

	/* 已配置的高防 IP 列表 (Optional) */
	ServiceIpConfig ServiceIpConfig `json:"serviceIpConfig"`

	/*  (Optional) */
	Protocol WebRuleProtocol `json:"protocol"`

	/* 是否为自定义端口号, 0: 为默认, 1: 为自定义 (Optional) */
	CustomPortStatus int `json:"customPortStatus"`

	/* HTTP 协议的端口号, 如 80,81 (Optional) */
	Port []int `json:"port"`

	/* HTTPS 协议的端口号, 如 443,8443 (Optional) */
	HttpsPort []int `json:"httpsPort"`

	/* 是否开启 HTTP 回源, 0: 为不开启, 1: 为开启, 当勾选 HTTPS 时可以配置该属性 (Optional) */
	HttpOrigin int `json:"httpOrigin"`

	/* 0: 防御状态, 1: 回源状态 (Optional) */
	Status int `json:"status"`

	/* 回源类型: A 或者 CNAME (Optional) */
	OriginType string `json:"originType"`

	/* 回源域名, originType 为 A 时返回该字段 (Optional) */
	OriginAddr []OriginAddrItem `json:"originAddr"`

	/* 回源域名, originType 为 CNAME 时返回该字段 (Optional) */
	OriginDomain string `json:"originDomain"`

	/* 备用的回源地址列表, 为一个域名或者多个 IP 地址 (Optional) */
	OnlineAddr []string `json:"onlineAddr"`

	/* 证书状态. <br>- 0: 异常<br>- 1: 正常<br>- 2: 证书未上传 (Optional) */
	HttpCertStatus int `json:"httpCertStatus"`

	/* 证书 Id, (废弃, 绑定证书信息通过 certs 字段查看) (Optional) */
	CertId string `json:"certId"`

	/* 证书名称, (废弃, 绑定证书信息通过 certs 字段查看) (Optional) */
	CertName string `json:"certName"`

	/* 证书内容, (废弃, 绑定证书信息通过 certs 字段查看) (Optional) */
	HttpsCertContent string `json:"httpsCertContent"`

	/* 证书私钥, (废弃, 绑定证书信息通过 certs 字段查看) (Optional) */
	HttpsRsaKey string `json:"httpsRsaKey"`

	/* 网站规则绑定证书信息 (Optional) */
	BindCerts []Cert `json:"bindCerts"`

	/* 是否开启 HTTPS 强制跳转, 当 protocol 为 HTTP_HTTPS 时可以配置该属性<br>- 0: 不强跳<br>- 1: 开启强跳 (Optional) */
	ForceJump int `json:"forceJump"`

	/* 转发规则. <br>- wrr: 带权重的轮询<br>- rr:  不带权重的轮询<br>- sh:  源地址hash (Optional) */
	Algorithm string `json:"algorithm"`

	/* CC 状态, 0: CC 关闭, 1: CC 开启 (Optional) */
	CcStatus int `json:"ccStatus"`

	/* webSocket 状态, 0: 关闭, 1: 开启 (Optional) */
	WebSocketStatus int `json:"webSocketStatus"`

	/* 黑名单状态, 0: 关闭, 1: 开启 (Optional) */
	BlackListEnable int `json:"blackListEnable"`

	/* 白名单状态, 0: 关闭, 1: 开启 (Optional) */
	WhiteListEnable int `json:"whiteListEnable"`

	/* 按区域分流回源配置 (Optional) */
	GeoRsRoute []GeoRsRoute `json:"geoRsRoute"`

	/* 是否开启回源长连接, protocol 选项开启 https 时生效, 可取值<br>- on: 开启<br>- off: 关闭 (Optional) */
	EnableKeepalive string `json:"enableKeepalive"`

	/* http 版本, protocol 选项开启 https 时生效, 可取值 http1 或 http2 (Optional) */
	HttpVersion string `json:"httpVersion"`

	/* SSL协议类型, protocol 选项开启 https 时生效, 可取值SSLv2,SSLv3,TLSv1.0,TLSv1.1,TLSv1.2 (Optional) */
	SslProtocols []string `json:"sslProtocols"`

	/* 加密套件等级, protocol 选项开启 https 时生效, 可取值<br>- low: 低级<br>- middle: 中级<br>- high:高级<br>- custom:自定义 (Optional) */
	SuiteLevel string `json:"suiteLevel"`

	/* 自定义加密套件等级, suiteLevel 为 custom 是有效 (Optional) */
	UserSuiteLevel []string `json:"userSuiteLevel"`

	/* 是否允许在 response 中插入 JS, 0: 关闭, 1: 开启 (Optional) */
	JsFingerprintEnable int `json:"jsFingerprintEnable"`

	/* JS 指纹生效范围, 0: 所有页面, 1: 已配置的自定义页面 (Optional) */
	JsFingerprintScope int `json:"jsFingerprintScope"`

	/* CC自定义规则总开关, 0: 关闭, 1: 开启 (Optional) */
	CcCustomStatus int `json:"ccCustomStatus"`

	/* 健康检查开关, 0: 关闭, 1: 开启 (Optional) */
	EnableHealthCheck int `json:"enableHealthCheck"`

	/* 回源连接超时时长, 单位 秒 (Optional) */
	ProxyConnectTimeout int `json:"proxyConnectTimeout"`

	/* 请求头支持下划线, 0: 关闭, 1: 开启 (Optional) */
	EnableUnderscores int `json:"enableUnderscores"`
}

type WebRuleProtocol added in v1.6.0

type WebRuleProtocol struct {

	/* http 协议  */
	Http bool `json:"http"`

	/* https 协议  */
	Https bool `json:"https"`
}

type WebRuleSpec

type WebRuleSpec struct {

	/* 高防 IP, serviceIps 为空时生效 (Optional) */
	ServiceIp *string `json:"serviceIp"`

	/* 高防 IP 列表, 不为空时忽略 serviceIp, 传多个时后台会在高防IP封禁后随机切换其他未封禁的IP (Optional) */
	ServiceIps []string `json:"serviceIps"`

	/* 子域名  */
	Domain string `json:"domain"`

	/* 协议: http, https 至少一个为 true  */
	Protocol *WebRuleProtocol `json:"protocol"`

	/* HTTP 协议的端口号, 如80, 81; 如果 protocol.http 为 true, 至少配置一个端口 (Optional) */
	Port []int `json:"port"`

	/* HTTPS 协议的端口号, 如443, 8443; 如果 protocol.https 为 true, 至少配置一个端口 (Optional) */
	HttpsPort []int `json:"httpsPort"`

	/* 回源类型:A 或者 CNAME  */
	OriginType string `json:"originType"`

	/* originType 为 A 时, 需要设置该字段 (Optional) */
	OriginAddr []OriginAddrItem `json:"originAddr"`

	/* 备用的回源地址列表, 可以配置为一个域名或者多个 ip 地址 (Optional) */
	OnlineAddr []string `json:"onlineAddr"`

	/* 回源域名, originType 为 CNAME 时需要指定该字段 (Optional) */
	OriginDomain *string `json:"originDomain"`

	/* 转发规则. <br>- wrr: 带权重的轮询<br>- rr:  不带权重的轮询<br>- sh:  源地址hash  */
	Algorithm string `json:"algorithm"`

	/* 是否开启 HTTPS 强制跳转, protocol.http 和 protocol.https 都为 true 时此参数生效. <br>- 0: 不开启强制跳转. <br>- 1: 开启强制跳转 (Optional) */
	ForceJump *int `json:"forceJump"`

	/* 是否为自定义端口号. 0: 默认<br>- 1: 自定义 (Optional) */
	CustomPortStatus *int `json:"customPortStatus"`

	/* 是否开启 HTTP 回源, protocol.https 为 true 时此参数生效. <br>- 0: 不开启. <br>- 1: 开启 (Optional) */
	HttpOrigin *int `json:"httpOrigin"`

	/* 是否开启 WebSocket.<br>- 0: 不开启<br>- 1: 开启  */
	WebSocketStatus int `json:"webSocketStatus"`

	/* 按区域分流回源配置 (Optional) */
	GeoRsRoute []GeoRsRoute `json:"geoRsRoute"`

	/* 是否开启回源长连接, protocol 选项开启 https 时生效, 可取值<br>- on: 开启<br>- off: 关闭 (Optional) */
	EnableKeepalive *string `json:"enableKeepalive"`

	/* http 版本, protocol 选项开启 https 时生效, 可取值 http1 或 http2 (Optional) */
	HttpVersion *string `json:"httpVersion"`

	/* SSL协议类型, protocol 选项开启 https 时生效, 可取值SSLv2,SSLv3,TLSv1.0,TLSv1.1,TLSv1.2 (Optional) */
	SslProtocols []string `json:"sslProtocols"`

	/* 加密套件等级, protocol 选项开启 https 时生效, 可取值<br>- low: 低级<br>- middle: 中级<br>- high:高级<br>- custom:自定义 (Optional) */
	SuiteLevel *string `json:"suiteLevel"`

	/* 自定义加密套件等级, suiteLevel 为 custom 是有效 (Optional) */
	UserSuiteLevel []string `json:"userSuiteLevel"`

	/* 健康检查开关, 0: 关闭, 1: 开启 (Optional) */
	EnableHealthCheck *int `json:"enableHealthCheck"`

	/* 回源连接超时时长, 单位 秒 (Optional) */
	ProxyConnectTimeout *int `json:"proxyConnectTimeout"`

	/* 请求头支持下划线, 0: 关闭, 1: 开启 (Optional) */
	EnableUnderscores *int `json:"enableUnderscores"`
}

type WebWhiteListRule added in v1.10.0

type WebWhiteListRule struct {

	/* 白名单规则 Id (Optional) */
	Id string `json:"id"`

	/* 白名单规则名称 (Optional) */
	Name string `json:"name"`

	/* 匹配模式:<br>- 0: uri<br>- 1: ip<br>- 2: cookie<br>- 3: geo<br>- 4: header (Optional) */
	Mode int `json:"mode"`

	/* 匹配 key. <br>- mode 为 cookie 时, 为 cookie 的 name<br>- mode 为 header 时, 为 header 的 key (Optional) */
	Key string `json:"key"`

	/* 匹配 value. <br>- mode 为 uri 时, 为要匹配的 uri<br>- mode 为 ip 时, 为引用的 ip 黑白名单 Id<br>- mode 为 cookie 时, 为 cookie 的 value<br>- mode 为 header 时, 为 header 的 value (Optional) */
	Value string `json:"value"`

	/* 匹配规则, mode 为 uri, cookie 和 header 时有效. 包含以下匹配规则: <br>- 0: 完全匹配<br>- 1: 前缀匹配<br>- 2: 包含<br>- 3: 正则匹配<br>- 4: 后缀匹配 (Optional) */
	Pattern int `json:"pattern"`

	/* 命中后处理动作. <br>- 0: 放行<br>- 1: CC 防护 (Optional) */
	Action int `json:"action"`

	/* 规则状态. <br>- 0: 关闭<br>- 1: 开启 (Optional) */
	Status int `json:"status"`

	/* geo 白名单地域列表 (Optional) */
	GeoList []Geo `json:"geoList"`
}

type WebWhiteListRuleSpec added in v1.10.0

type WebWhiteListRuleSpec struct {

	/* 白名单规则名称  */
	Name string `json:"name"`

	/* 模式:<br>- 0: uri<br>- 1: ip<br>- 2: cookie<br>- 3: geo<br>- 4: header  */
	Mode int `json:"mode"`

	/* 匹配 key, mode 为 cookie 和 header 时必传. <br>- mode 为 cookie 时, 传 cookie 的 name<br>- mode 为 header 时, 传 header 的 key (Optional) */
	Key *string `json:"key"`

	/* 匹配 value. <br>- mode 为 uri 时, 传要匹配的 uri<br>- mode 为 ip 时, 传引用的 ip 黑白名单 Id<br>- mode 为 cookie 时, 传 cookie 的 value<br>- mode 为 geo 时, 传 geo 区域编码以 ',' 分隔的字符串. 查询 <a href='http://docs.jdcloud.com/anti-ddos-pro/api/describewebrulewhitelistgeoareas'>describeWebRuleWhiteListGeoAreas</a> 接口获取可设置的地域编码列表<br>- mode 为 header 时, 传 header 的 value  */
	Value string `json:"value"`

	/* 匹配规则, mode 为 uri, cookie 和 header 时必传. 支持以下匹配规则: <br>- 0: 完全匹配<br>- 1: 前缀匹配<br>- 2: 包含<br>- 3: 正则匹配<br>- 4: 后缀匹配 (Optional) */
	Pattern *int `json:"pattern"`

	/* 命中后处理动作. <br>- 0: 放行<br>- 1: CC 防护  */
	Action int `json:"action"`

	/* 规则状态. <br>- 0: 关闭<br>- 1: 开启  */
	Status int `json:"status"`
}

type WhiteIpSet added in v1.56.0

type WhiteIpSet struct {

	/* IP 白名单 Id (Optional) */
	Id string `json:"id"`

	/* IP 白名单的名称 (Optional) */
	Name string `json:"name"`

	/* IP 或 IP 段的数组 (Optional) */
	Ip []string `json:"ip"`

	/* 是否打开 (Optional) */
	Enable bool `json:"enable"`
}

type WhiteIpSetSpec added in v1.56.0

type WhiteIpSetSpec struct {

	/* IP 白名单名称  */
	Name string `json:"name"`

	/* IP 或 IP 段的数组  */
	Ip []string `json:"ip"`
}

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL