CreateCloudResource - 云产品接入WAF_Web应用防火墙(WAF)-阿里云帮助中心

云产品接入WAF，当前只支持ECS和CLB。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-waf:CreateCloudResource

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例的 ID。说明您可以调用 DescribeInstance 查询当前 WAF 实例的 ID。	waf_v3prepaid_public_cn-***
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfm***q
Listen	object	是	配置监听信息。
TLSVersion	string	否	要添加的 TLS 版本。仅 HttpsPorts 取值不为空（表示域名使用 HTTPS 协议）时，使用该参数。取值： tlsv1 tlsv1.1 tlsv1.2	tlsv1
EnableTLSv3	boolean	否	是否支持 TLS1.3 版本。仅 HttpsPorts 取值不为空（表示域名使用 HTTPS 协议）时，使用该参数。取值： true：表示支持 TLS1.3 版本。 false：表示不支持 TLS1.3 版本。	true
CipherSuite	integer	否	要添加的加密套件类型。仅 HttpsPorts 取值不为空（表示域名使用 HTTPS 协议）时，使用该参数。取值： 1：表示添加全部加密套件。 2：表示添加强加密套件。仅 TLSVersion 取值为tlsv1.2时，可选择该取值。 99：表示添加自定义加密套件。	1
CustomCiphers	array	否	要添加的具体自定义加密套件。仅 CipherSuite 配置为 99 时，使用该参数。
	string	否	要添加的具体自定义加密套件。仅 CipherSuite 配置为 99 时，使用该参数。	ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384
ResourceProduct	string	是	云产品类型。取值： clb4：表示四层 CLB 产品。 clb7：表示七层 CLB 产品。 ecs：表示 ECS 产品。 nlb：表示 NLB 产品。	clb4
ResourceInstanceId	string	是	云产品实例的 ID。	lb-bp1*****
Port	integer	是	接入 WAF 的云产品端口。	80
Protocol	string	是	协议类型。取值： http：表示 HTTP 协议。 https：表示 HTTPS 协议。	http
Certificates	array	否	证书 ID 列表。
	object	否	证书信息。
CertificateId	string	否	要添加的证书的 ID。说明您可以调用 DescribeResourceInstanceCerts 查询云产品实例关联的所有 SSL 证书的 ID。	123-cn-hangzhou
AppliedType	string	否	HTTPS 协议的证书类型。取值： default：表示默认证书。 extension：表示拓展证书。	default
Http2Enabled	boolean	否	是否开启 HTTP2。仅 HttpsPorts 取值不为空（表示域名使用 HTTPS 协议）时，使用该参数。取值： true：表示开启 HTTP2。 false（默认）：表示不开启 HTTP2。	true
Redirect	object	否	配置转发信息。
RequestHeaders	array	否	该参数值的格式为[*{"k":"key","v":"value"}]。其中，key表示所指定的自定义请求头部字段，value*表示为该字段设定的值。说明如果请求中已存在该自定义头部字段，系统将用所设定的流量标记值覆盖请求中该自定义字段的值。
	object	否	该参数值的格式为[*{"k":"key","v":"value"}]。其中，key表示所指定的自定义请求头部字段，value*表示为该字段设定的值。
Key	string	否	指定的自定义请求头部字段。	key1
Value	string	否	自定义请求头部字段设定的值。	value1
XffHeaderMode	integer	否	WAF 获取客户端真实 IP 的方式。取值： 0：表示客户端访问流量到 WAF 前没有经过其他七层代理转发。 1：表示 WAF 读取请求头中 X-Forwarded-For（XFF）字段的第一个值作为客户端 IP。 2：表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP。	1
XffHeaders	array	否	设置用于获取客户端 IP 的自定义字段列表，使用["header1","header2",……]格式表示。说明仅在 XffHeaderMode 取值为 2（表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP）时，需要设置该参数。
	string	否	设置用于获取客户端 IP 的自定义字段列表，使用["header1","header2",……]格式表示。说明仅在 XffHeaderMode 取值为 2（表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP）时，需要设置该参数。	header1
ReadTimeout	integer	否	读超时时长，单位：秒。取值范围：1~3600。	1
WriteTimeout	integer	否	写超时时长，单位：秒。取值范围：1~3600。	1
Keepalive	boolean	否	是否保持长连接。取值： true（默认）：表示保持长连接。 false：表示不保持长连接。	true
KeepaliveRequests	integer	否	复用长连接的请求个数。取值范围：60~1000，单位：个。说明开启长连接后，复用多少个长连接。	1000
KeepaliveTimeout	integer	否	空闲长连接超时时间，取值范围：10~3600，默认 3600，单位：秒。说明复用的长连接空闲多久后释放。	3600
XffProto	boolean	否	X-Forward-For-Proto 传递 WAF 的协议。取值： true（默认）：表示传递 WAF 的协议。 false：表示不传递 WAF 的协议。	true
Tag	array<object>	否	标签列表，最多包含 20 个子项
	object	否
Key	string	否	标签键	TagKey1
Value	string	否	标签值	TagValue1
RegionId	string	是	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
OwnerUserId	string	否	当前资源归属 UID	123

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	66A98669-ER12-WE34-23PO-301469*****E
CloudResourceId	string	接入的资源 ID，由 WAF 自动生成。	lb-***

示例

正常返回示例

JSON格式

{
  "RequestId": "66A98669-ER12-WE34-23PO-301469*****E",
  "CloudResourceId": "lb-***"
}

错误码

HTTP status code	错误码	错误信息	描述
400	Waf.Pullin.CertNotExist	Certificate does not exist in SSL Certificate Center, certificate type:%s, certificate ID:%s.	证书在SSL证书中心不存在，证书类型：%s，证书ID：%s。
400	Waf.Pullin.CertExpired	Certificate expired, certificate ID:%s .

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。