文档首页/ Web应用防火墙 WAF/ API参考/ API/ 云模式防护网站管理/ 更新云模式防护域名的配置
更新时间：2025-08-19 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新云模式防护域名的配置

功能介绍

更新云模式防护域名配置，在没有填入源站信息server的原始数据的情况下，则新的源站信息server会覆盖源站信息，而不是新增源站。此外，请求体可只传需要更新的部分。

调用方法

请参见如何调用API。

URI

PATCH /v1/{project_id}/waf/instance/{instance_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，对应控制台用户名->我的凭证->项目列表->项目ID。

约束限制：

不涉及

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及

instance_id

是

String

参数解释：

域名id，您可以通过调用查询云模式防护域名列表（ListHost）获取域名id

约束限制：

不涉及

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释：

您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息，请传参all_granted_eps。

约束限制：

不涉及

取值范围：

  • 0：代表default企业项目

  • all_granted_eps：代表所有企业项目

  • 其它企业项目ID：长度为36个字符

默认取值：

0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

Content-Type

是

String

参数解释：

内容类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

application/json;charset=utf8
表4 请求Body参数

参数

是否必选

参数类型

描述

proxy

否

Boolean

参数解释：

防护域名是否使用代理

约束限制：

不涉及

取值范围：

  • false：不使用代理

  • true：使用代理

默认取值：

不涉及

certificateid

否

String

参数解释：

证书id，通过查询证书列表接口（ListCertificates）接口获取证书id

  • 对外协议为HTTP时不需要填写

  • 对外协议HTTPS时为必填参数

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

certificatename

否

String

参数解释：

证书名

  • 对外协议为HTTP时不需要填写

  • 对外协议HTTPS时为必填参数

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

server

否

Array of CloudWafServer objects

防护域名的源站服务器配置信息

tls

否

String

参数解释：

配置的最低TLS版本（TLS v1.0/TLS v1.1/TLS v1.2）,默认为TLS v1.0版本，对于低于最低TLS版本的请求，将无法正常访问网站

约束限制：

不涉及

取值范围：

  • TLS v1.0

  • TLS v1.1

  • TLS v1.2

默认取值：

不涉及

cipher

否

String

参数解释：

加密套件（cipher_1，cipher_2，cipher_3，cipher_4，cipher_5，cipher_6，cipher_default）

约束限制：

不涉及

取值范围：

  • cipher_1： 加密算法为ECDHE-ECDSA-AES256-GCM-SHA384:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!DES:!MD5:!PSK:!RC4:!kRSA:!SRP:!3DES:!DSS:!EXP:!CAMELLIA:@STRENGTH

  • cipher_2：加密算法为EECDH+AESGCM:EDH+AESGCM

  • cipher_3：加密算法为ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH

  • cipher_4：加密算法为ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!EDH

  • cipher_5：加密算法为AES128-SHA:AES256-SHA:AES128-SHA256:AES256-SHA256:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!EXPORT:!DES:!MD5:!PSK:!RC4:!DHE:@STRENGTH

  • cipher_6：加密算法为ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256

  • cipher_default：加密算法为ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM

默认取值：

不涉及

http2_enable

否

Boolean

参数解释：

是否支持http2

约束限制：

不涉及

取值范围：

  • true：表示支持http2

  • false：表示不支持http2

默认取值：

不涉及

ipv6_enable

否

Boolean

参数解释：

是否开启IPv6防护，仅专业版和企业版支持IPv6防护

约束限制：

不涉及

取值范围：

  • true：开启IPv6防护

  • false：关闭IPV6防护

默认取值：

不涉及

web_tag

否

String

参数解释：

网站名称，对应WAF控制台域名详情中的网站名称

约束限制：

不涉及

取值范围：

0到128个字符

默认取值：

不涉及

exclusive_ip

否

Boolean

参数解释：

是否使用用户独享的引擎公网ip，该参数为预留参数，用于后续功能扩展，用户可忽略

约束限制：

不涉及

取值范围：

  • true：使用独享ip

  • false：不使用独享ip

默认取值：

不涉及

paid_type

否

String

参数解释：

套餐付费模式，默认值为prePaid

约束限制：

不涉及

取值范围：

  • prePaid：包周期款模式

  • postPaid：按需模式

默认取值：

不涉及

block_page

否

BlockPage object

告警页面配置

traffic_mark

否

TrafficMark object

流量标识

flag

否

Flag object

特殊标识，用于前端使用

extend

否

Map<String,String>

参数解释：

扩展字段，用于保存防护域名的一些配置信息

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

circuit_breaker

否

CircuitBreaker object

熔断配置

timeout_config

否

TimeoutConfig object

超时配置

forward_header_map

否

Map<String,String>

参数解释：

字段转发配置，WAF会将添加的字段插到header中，转给源站；Key不能跟nginx原生字段重复。Value支持的值包括:

  • $time_local

  • $request_id

  • $connection_requests

  • $tenant_id

  • $project_id

  • $remote_addr

  • $remote_port

  • $scheme

  • $request_method

  • $http_host

  • $origin_uri

  • $request_length

  • $ssl_server_name

  • $ssl_protocol

  • $ssl_curves

  • $ssl_session_reused

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表5 CloudWafServer

参数

是否必选

参数类型

描述

front_protocol

是

String

参数解释：

客户端请求访问防护域名源站服务器的协议

约束限制：

不涉及

取值范围：

  • HTTP

  • HTTPS

默认取值：

不涉及

back_protocol

是

String

参数解释：

WAF转发客户端请求到防护域名源站服务器的协议

约束限制：

不涉及

取值范围：

  • HTTP

  • HTTPS

默认取值：

不涉及

weight

否

Integer

参数解释：

源站权重，负载均衡算法将按该权重将请求分配给源站

约束限制：

不涉及

取值范围：

默认值是1，云模式的冗余字段

默认取值：

不涉及

address

是

String

参数解释：

客户端访问的源站服务器的IP地址

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

port

是

Integer

参数解释：

WAF转发客户端请求到源站服务的业务端口

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

type

是

String

参数解释：

源站地址为ipv4或ipv6

约束限制：

不涉及

取值范围：

  • ipv4

  • ipv6

默认取值：

不涉及
表6 BlockPage

参数

是否必选

参数类型

描述

template

是

String

参数解释：

模板名称，默认页面请输入default，自定义告警页面时请输入custom，重定向请输入redirect

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

custom_page

否

CustomPage object

自定义告警页面

redirect_url

否

String

参数解释：

“重定向”页面URL

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表7 CustomPage

参数

是否必选

参数类型

描述

status_code

是

String

参数解释：

返回状态码

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

content_type

是

String

参数解释：

“自定义”告警页面内容类型，可选择text/html、text/xml和application/json三种类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

content

是

String

参数解释：

根据选择的“页面类型”配置对应的页面内容，具体示例可以参考“Web应用防火墙 WAF”用户手册

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表8 TrafficMark

参数

是否必选

参数类型

描述

sip

否

Array of strings

参数解释：

IP标记，客户端最原始的IP地址的HTTP请求头字段

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

cookie

否

String

参数解释：

Session标记，用于Cookie恶意请求的攻击惩罚功能。在选择Cookie拦截的攻击惩罚功能前，必须配置该标识

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

params

否

String

参数解释：

User标记，用于Params恶意请求的攻击惩罚功能。在选择Params拦截的攻击惩罚功能前，必须配置该标识。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表9 Flag

参数

是否必选

参数类型

描述

pci_3ds

否

String

参数解释：

是否开启pci_3ds合规认证

约束限制：

不涉及

取值范围：

  • true：开启

  • false：不开启

默认取值：

不涉及

pci_dss

否

String

参数解释：

是否开启pci_dss合规认证

约束限制：

不涉及

取值范围：

  • true：开启

  • false：不开启

默认取值：

不涉及

cname

否

String

参数解释：

old：代表域名使用的老的cname，new：代表域名使用新的cname

约束限制：

不涉及

取值范围：

  • old：域名使用的老的cname

  • new：域名使用新的cname

默认取值：

不涉及

is_dual_az

否

String

参数解释：

是否支持双AZ模式

约束限制：

不涉及

取值范围：

  • true：支持

  • false：不支持

默认取值：

不涉及

ipv6

否

String

参数解释：

域名是否开启ipv6

约束限制：

不涉及

取值范围：

  • true：支持

  • false：不支持

默认取值：

不涉及
表10 CircuitBreaker

参数

是否必选

参数类型

描述

switch

否

Boolean

参数解释：

熔断开关，是否开启连接保护

约束限制：

不涉及

取值范围：

  • true：开启连接保护

  • false: 关闭连接保护

默认取值：

不涉及

dead_num

否

Integer

参数解释：

502/504数量阈值，每30s累加的502/504数量阈值

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

dead_ratio

否

Number

参数解释：

502/504数量占比(%)，总请求数量中502/504数量占比达到所设定值，并且与数量阈值同时满足时触发宕机保护

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

block_time

否

Integer

参数解释：

初次触发宕机的保护时间，即WAF将停止转发用户请求的时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

superposition_num

否

Integer

参数解释：

连续触发时，保护时间延长最大倍数，叠加周期为3600s。例如，“初次保护时间”设置为180s，“连续触发叠加系数”设置为3。

约束限制：

不涉及

取值范围：

  • 当触发次数为2（即小于3）时，保护时间为360s。

  • 当次数大于等于3时，保护时间为540s。

  • 当累计保护时间超过1小时（3600s），叠加次数会从头计数。

默认取值：

不涉及

suspend_num

否

Integer

参数解释：

读等待URL请求数量阈值，读等待URL请求数量到达设定值即触发连接保护

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

sus_block_time

否

Integer

参数解释：

读等待URL请求数量超过阈值后的熔断时间，达到数量阈值所触发的保护时间，即WAF将停止转发用户请求的时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表11 TimeoutConfig

参数

是否必选

参数类型

描述

connect_timeout

否

Integer

参数解释：

WAF连接源站超时配置

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

send_timeout

否

Integer

参数解释：

WAF发送请求到源站超时配置

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

read_timeout

否

Integer

参数解释：

WAF接收源站响应超时配置

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表12 响应Body参数

参数

参数类型

描述

id

String

参数解释：

域名id

取值范围：

不涉及

hostname

String

参数解释：

创建的云模式防护域名

取值范围：

不涉及

policyid

String

参数解释：

防护策略id

取值范围：

不涉及

domainid

String

参数解释：

账号ID,对应控制台用户名->我的凭证->账号ID

取值范围：

不涉及

projectid

String

参数解释：

项目ID，对应控制台用户名->我的凭证->项目列表->项目ID

取值范围：

不涉及

enterprise_project_id

String

参数解释：

企业项目ID，对应控制台用户名->企业->项目管理->点击项目名称->ID

取值范围：

不涉及

protocol

String

参数解释：

后端包含的协议类型：HTTPS、HTTP、HTTP&HTTPS

取值范围：

不涉及

server

Array of CloudWafServer objects

防护域名的源站服务器配置信息

proxy

Boolean

参数解释：

防护域名是否使用代理

取值范围：

  • false：不使用代理

  • true：使用代理

protect_status

Integer

参数解释：

域名防护状态

取值范围：

  • -1：bypass，该域名的请求直接到达其后端服务器，不再经过WAF

  • 0：暂停防护，WAF只转发该域名的请求，不做攻击检测

  • 1：开启防护，WAF根据您配置的策略进行攻击检测

access_status

Integer

参数解释：

域名接入状态

取值范围：

  • 0：表示未接入

  • 1：表示已接入

access_code

String

参数解释：

cname前缀，cname后缀为.vip1.huaweicloudwaf.com

取值范围：

不涉及

locked

Integer

参数解释：

预留参数，用于后期设计冻结域名，解锁域名功能，目前暂不支持

取值范围：

不涉及

timestamp

Long

参数解释：

创建防护域名的时间戳（毫秒）

取值范围：

不涉及

certificateid

String

参数解释：

https证书id

取值范围：

不涉及

certificatename

String

参数解释：

证书名称

取值范围：

只能由中文、字母、数字、中划线、下划线和英文句点组成，且不能超过256个字符长度

tls

String

参数解释：

配置的最低TLS版本（TLS v1.0/TLS v1.1/TLS v1.2）,默认为TLS v1.0版本，对于低于最低TLS版本的请求，将无法正常访问网站

取值范围：

  • TLS v1.0

  • TLS v1.1

  • TLS v1.2

cipher

String

参数解释：

加密套件（cipher_1，cipher_2，cipher_3，cipher_4，cipher_5，cipher_6，cipher_default）

取值范围：

  • cipher_1：加密算法为ECDHE-ECDSA-AES256-GCM-SHA384:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!DES:!MD5:!PSK:!RC4:!kRSA:!SRP:!3DES:!DSS:!EXP:!CAMELLIA:@STRENGTH

  • cipher_2：加密算法为EECDH+AESGCM:EDH+AESGCM

  • cipher_3：加密算法为ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH

  • cipher_4：加密算法为ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!EDH

  • cipher_5：加密算法为AES128-SHA:AES256-SHA:AES128-SHA256:AES256-SHA256:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!EXPORT:!DES:!MD5:!PSK:!RC4:!DHE:@STRENGTH

  • cipher_6：加密算法为ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256

  • cipher_default：加密算法为ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM

block_page

BlockPage object

告警页面配置

extend

Map<String,String>

参数解释：

扩展字段，用于存放Web基础防护中一些开关配置等信息

取值范围：

不涉及

web_tag

String

网站名称，对应WAF控制台域名详情中的网站名称

traffic_mark

TrafficMark object

流量标识

circuit_breaker

CircuitBreaker object

熔断配置

lb_algorithm

String

参数解释：

LB负载均衡，仅专业版和企业版支持配置负载均衡算法

  • 源IP Hash：将某个IP的请求定向到同一个服务器

  • 加权轮询：所有请求将按权重轮流分配给源站服务器

  • Session Hash：将某个Session标识的请求定向到同一个源站服务器，请确保在域名添加完毕后配置攻击惩罚的流量标识，否则Session Hash配置不生效

取值范围：

  • ip_hash

  • round_robin

  • session_hash

timeout_config

TimeoutConfig object

超时配置

flag

Flag object

特殊标识，用于前端使用

description

String

参数解释：

网站备注

取值范围：

不涉及

http2_enable

Boolean

参数解释：

是否支持http2

取值范围：

  • true：表示支持http2

  • false：表示不支持http2

exclusive_ip

Boolean

参数解释：

是否使用用户独享的引擎公网ip，该参数为预留参数，用于后续功能扩展，用户可忽略

取值范围：

  • true：使用独享ip

  • false：不使用独享ip

access_progress

Array of Access_progress objects

参数解释：

接入进度，仅用于新版console(前端)使用

取值范围：

不涉及

forward_header_map

Map<String,String>

参数解释：

字段转发配置，WAF会将添加的字段插到header中，转给源站；Key不能跟nginx原生字段重复。Value支持的值包括:

  • $time_local

  • $request_id

  • $connection_requests

  • $tenant_id

  • $project_id

  • $remote_addr

  • $remote_port

  • $scheme

  • $request_method

  • $http_host

  • $origin_uri

  • $request_length

  • $ssl_server_name

  • $ssl_protocol

  • $ssl_curves

  • $ssl_session_reused

取值范围：

不涉及
表13 CloudWafServer

参数

参数类型

描述

front_protocol

String

参数解释：

客户端请求访问防护域名源站服务器的协议

约束限制：

不涉及

取值范围：

  • HTTP

  • HTTPS

默认取值：

不涉及

back_protocol

String

参数解释：

WAF转发客户端请求到防护域名源站服务器的协议

约束限制：

不涉及

取值范围：

  • HTTP

  • HTTPS

默认取值：

不涉及

weight

Integer

参数解释：

源站权重，负载均衡算法将按该权重将请求分配给源站

约束限制：

不涉及

取值范围：

默认值是1，云模式的冗余字段

默认取值：

不涉及

address

String

参数解释：

客户端访问的源站服务器的IP地址

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

port

Integer

参数解释：

WAF转发客户端请求到源站服务的业务端口

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

type

String

参数解释：

源站地址为ipv4或ipv6

约束限制：

不涉及

取值范围：

  • ipv4

  • ipv6

默认取值：

不涉及
表14 BlockPage

参数

参数类型

描述

template

String

参数解释：

模板名称，默认页面请输入default，自定义告警页面时请输入custom，重定向请输入redirect

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

custom_page

CustomPage object

自定义告警页面

redirect_url

String

参数解释：

“重定向”页面URL

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表15 CustomPage

参数

参数类型

描述

status_code

String

参数解释：

返回状态码

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

content_type

String

参数解释：

“自定义”告警页面内容类型，可选择text/html、text/xml和application/json三种类型

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

content

String

参数解释：

根据选择的“页面类型”配置对应的页面内容，具体示例可以参考“Web应用防火墙 WAF”用户手册

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表16 TrafficMark

参数

参数类型

描述

sip

Array of strings

参数解释：

IP标记，客户端最原始的IP地址的HTTP请求头字段

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

cookie

String

参数解释：

Session标记，用于Cookie恶意请求的攻击惩罚功能。在选择Cookie拦截的攻击惩罚功能前，必须配置该标识

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

params

String

参数解释：

User标记，用于Params恶意请求的攻击惩罚功能。在选择Params拦截的攻击惩罚功能前，必须配置该标识。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表17 CircuitBreaker

参数

参数类型

描述

switch

Boolean

参数解释：

熔断开关，是否开启连接保护

约束限制：

不涉及

取值范围：

  • true：开启连接保护

  • false: 关闭连接保护

默认取值：

不涉及

dead_num

Integer

参数解释：

502/504数量阈值，每30s累加的502/504数量阈值

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

dead_ratio

Number

参数解释：

502/504数量占比(%)，总请求数量中502/504数量占比达到所设定值，并且与数量阈值同时满足时触发宕机保护

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

block_time

Integer

参数解释：

初次触发宕机的保护时间，即WAF将停止转发用户请求的时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

superposition_num

Integer

参数解释：

连续触发时，保护时间延长最大倍数，叠加周期为3600s。例如，“初次保护时间”设置为180s，“连续触发叠加系数”设置为3。

约束限制：

不涉及

取值范围：

  • 当触发次数为2（即小于3）时，保护时间为360s。

  • 当次数大于等于3时，保护时间为540s。

  • 当累计保护时间超过1小时（3600s），叠加次数会从头计数。

默认取值：

不涉及

suspend_num

Integer

参数解释：

读等待URL请求数量阈值，读等待URL请求数量到达设定值即触发连接保护

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

sus_block_time

Integer

参数解释：

读等待URL请求数量超过阈值后的熔断时间，达到数量阈值所触发的保护时间，即WAF将停止转发用户请求的时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表18 TimeoutConfig

参数

参数类型

描述

connect_timeout

Integer

参数解释：

WAF连接源站超时配置

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

send_timeout

Integer

参数解释：

WAF发送请求到源站超时配置

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

read_timeout

Integer

参数解释：

WAF接收源站响应超时配置

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表19 Flag

参数

参数类型

描述

pci_3ds

String

参数解释：

是否开启pci_3ds合规认证

约束限制：

不涉及

取值范围：

  • true：开启

  • false：不开启

默认取值：

不涉及

pci_dss

String

参数解释：

是否开启pci_dss合规认证

约束限制：

不涉及

取值范围：

  • true：开启

  • false：不开启

默认取值：

不涉及

cname

String

参数解释：

old：代表域名使用的老的cname，new：代表域名使用新的cname

约束限制：

不涉及

取值范围：

  • old：域名使用的老的cname

  • new：域名使用新的cname

默认取值：

不涉及

is_dual_az

String

参数解释：

是否支持双AZ模式

约束限制：

不涉及

取值范围：

  • true：支持

  • false：不支持

默认取值：

不涉及

ipv6

String

参数解释：

域名是否开启ipv6

约束限制：

不涉及

取值范围：

  • true：支持

  • false：不支持

默认取值：

不涉及
表20 Access_progress

参数

参数类型

描述

step

Integer

参数解释：

步骤

取值范围：

  • 1: 指回源IP加白

  • 2: 指本地验证

  • 3：指修改DNS解析

status

Integer

参数解释：

状态

取值范围：

  • 0：未完成这个步骤

  • 1：已完成这个状态

状态码：400

表21 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表22 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码：401

表23 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表24 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码：500

表25 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因，用户可以自行调用 STS 服务的decode-authorization-message接口进行解码，可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合，IAM5鉴权错误时才会返回此字段。
表26 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

更新项目id为project_id，域名id是instance_id的域名下的两个源站服务器，第一个源站服务器的IP地址是x.x.x.x，端口号是80，源站地址是ipv4的，源站权重是1，客户端请求访问防护域名源站服务器的协议和WAF转发客户端请求到防护域名源站服务器的协议都是HTTP协议；第二个源站服务器的IP地址是x.x.x.x，端口号是80，源站地址是ipv4的，客户端请求访问防护域名源站服务器的协议和WAF转发客户端请求到防护域名源站服务器的协议都是HTTP协议；域名关闭了ipv6防护。

PATCH https://{Endpoint}/v1/{project_id}/waf/instance/{instance_id}?enterprise_project_id=0

{
  "server" : [ {
    "address" : "x.x.x.x",
    "port" : "80",
    "type" : "ipv4",
    "weight" : 1,
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP"
  }, {
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP",
    "type" : "ipv4",
    "address" : "x.x.x.x",
    "port" : "80"
  } ],
  "ipv6_enable" : false
}

响应示例

状态码：200

OK

{
  "id" : "e91ad96e379b4bea84f8fcda3d153370",
  "hostname" : "www.demo.com",
  "protocol" : "HTTP",
  "server" : [ {
    "address" : "x.x.x.x",
    "port" : 80,
    "type" : "ipv4",
    "weight" : 1,
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP"
  }, {
    "address" : "1.1.1.4",
    "port" : 80,
    "type" : "ipv4",
    "weight" : 1,
    "front_protocol" : "HTTP",
    "back_protocol" : "HTTP"
  } ],
  "proxy" : false,
  "locked" : 0,
  "timestamp" : 1650423573577,
  "flag" : {
    "pci_3ds" : "false",
    "pci_dss" : "false",
    "ipv6" : "false",
    "cname" : "new",
    "is_dual_az" : "true"
  },
  "description" : "",
  "policyid" : "f385eceedf7c4c34a4d1def19eafbe85",
  "domainid" : "d4ecb00b031941ce9171b7bc3386883f",
  "projectid" : "0456cf04d6f64725ab02ed5bd2efdfa4",
  "enterprise_project_id" : "0",
  "protect_status" : 1,
  "access_status" : 0,
  "access_code" : "4f5372610cdc44f7970759fcca138c81",
  "block_page" : {
    "template" : "default"
  },
  "web_tag" : "we",
  "exclusive_ip" : false,
  "http2_enable" : false
}

SDK代码示例

SDK代码示例如下。

更新项目id为project_id，域名id是instance_id的域名下的两个源站服务器，第一个源站服务器的IP地址是x.x.x.x，端口号是80，源站地址是ipv4的，源站权重是1，客户端请求访问防护域名源站服务器的协议和WAF转发客户端请求到防护域名源站服务器的协议都是HTTP协议；第二个源站服务器的IP地址是x.x.x.x，端口号是80，源站地址是ipv4的，客户端请求访问防护域名源站服务器的协议和WAF转发客户端请求到防护域名源站服务器的协议都是HTTP协议；域名关闭了ipv6防护。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateHostSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateHostRequest request = new UpdateHostRequest();
        request.withInstanceId("{instance_id}");
        UpdateHostRequestBody body = new UpdateHostRequestBody();
        List<CloudWafServer> listbodyServer = new ArrayList<>();
        listbodyServer.add(
            new CloudWafServer()
                .withFrontProtocol(CloudWafServer.FrontProtocolEnum.fromValue("HTTP"))
                .withBackProtocol(CloudWafServer.BackProtocolEnum.fromValue("HTTP"))
                .withWeight(1)
                .withAddress("x.x.x.x")
                .withPort(80)
                .withType(CloudWafServer.TypeEnum.fromValue("ipv4"))
        );
        listbodyServer.add(
            new CloudWafServer()
                .withFrontProtocol(CloudWafServer.FrontProtocolEnum.fromValue("HTTP"))
                .withBackProtocol(CloudWafServer.BackProtocolEnum.fromValue("HTTP"))
                .withAddress("x.x.x.x")
                .withPort(80)
                .withType(CloudWafServer.TypeEnum.fromValue("ipv4"))
        );
        body.withIpv6Enable(false);
        body.withServer(listbodyServer);
        request.withBody(body);
        try {
            UpdateHostResponse response = client.updateHost(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

更新项目id为project_id，域名id是instance_id的域名下的两个源站服务器，第一个源站服务器的IP地址是x.x.x.x，端口号是80，源站地址是ipv4的，源站权重是1，客户端请求访问防护域名源站服务器的协议和WAF转发客户端请求到防护域名源站服务器的协议都是HTTP协议；第二个源站服务器的IP地址是x.x.x.x，端口号是80，源站地址是ipv4的，客户端请求访问防护域名源站服务器的协议和WAF转发客户端请求到防护域名源站服务器的协议都是HTTP协议；域名关闭了ipv6防护。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateHostRequest()
        request.instance_id = "{instance_id}"
        listServerbody = [
            CloudWafServer(
                front_protocol="HTTP",
                back_protocol="HTTP",
                weight=1,
                address="x.x.x.x",
                port=80,
                type="ipv4"
            ),
            CloudWafServer(
                front_protocol="HTTP",
                back_protocol="HTTP",
                address="x.x.x.x",
                port=80,
                type="ipv4"
            )
        ]
        request.body = UpdateHostRequestBody(
            ipv6_enable=False,
            server=listServerbody
        )
        response = client.update_host(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

更新项目id为project_id，域名id是instance_id的域名下的两个源站服务器，第一个源站服务器的IP地址是x.x.x.x，端口号是80，源站地址是ipv4的，源站权重是1，客户端请求访问防护域名源站服务器的协议和WAF转发客户端请求到防护域名源站服务器的协议都是HTTP协议；第二个源站服务器的IP地址是x.x.x.x，端口号是80，源站地址是ipv4的，客户端请求访问防护域名源站服务器的协议和WAF转发客户端请求到防护域名源站服务器的协议都是HTTP协议；域名关闭了ipv6防护。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := waf.NewWafClient(
        waf.WafClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateHostRequest{}
	request.InstanceId = "{instance_id}"
	weightServer:= int32(1)
	var listServerbody = []model.CloudWafServer{
        {
            FrontProtocol: model.GetCloudWafServerFrontProtocolEnum().HTTP,
            BackProtocol: model.GetCloudWafServerBackProtocolEnum().HTTP,
            Weight: &weightServer,
            Address: "x.x.x.x",
            Port: int32(80),
            Type: model.GetCloudWafServerTypeEnum().IPV4,
        },
        {
            FrontProtocol: model.GetCloudWafServerFrontProtocolEnum().HTTP,
            BackProtocol: model.GetCloudWafServerBackProtocolEnum().HTTP,
            Address: "x.x.x.x",
            Port: int32(80),
            Type: model.GetCloudWafServerTypeEnum().IPV4,
        },
    }
	ipv6EnableUpdateHostRequestBody:= false
	request.Body = &model.UpdateHostRequestBody{
		Ipv6Enable: &ipv6EnableUpdateHostRequestBody,
		Server: &listServerbody,
	}
	response, err := client.UpdateHost(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码。

父主题： 云模式防护网站管理

相关文档