CreateDefenseResource - 创建防护对象_Web应用防火墙(WAF)-阿里云帮助中心

创建防护对象。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-waf:CreateDefenseResource

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Resource	string	否	防护对象名称。说明只有混合云服务化的防护对象支持自定义防护对象名称。	abctest.com
Product	string	是	云产品名称。取值： alb：表示 ALB 产品。 ecs：表示 ECS 产品。 clb4：表示 CLB 产品 4 层接入。 clb7：表示 CLB 产品 7 层接入。 nlb：表示 NLB 产品。 waf：表示 WAF 产品。	ecs
ResourceGroup	string	否	防护对象加入防护组的名称，可选。	testGroup
ResourceOrigin	string	是	防护对象来源。只支持取值： custom：用户自定义。	custom
Pattern	string	是	防护对象的防护形式。取值： domain：表示以域名方式防护。 multi_service：表示以混合云服务化的方式防护。	domain
Detail	string	是	防护对象的具体参数信息，以一系列参数构造的 JSON 格式转化成字符串。说明根据所指定的云产品（Product）和防护形式（Pattern）不同，具体涉及的参数有所不同。详细信息，请参见防护对象 Detail 参数描述。	{\"domain\": \"zhhclb4test096-05111.test.com\"}
XffStatus	integer	否	防护对象是否开启 xff 代理。取值： 0：未开启（默认）。 1：开启。	0
CustomHeaders	array	否	指定 Header 字段列表。说明 XffStatus = 1 时，取指定 Header 字段中的第一个 IP 作为客户端源 IP，避免 XFF 伪造，输入多个 Header 时按顺序依次尝试取源 IP，如果第一个取不到则取第二个，依次类推，如果所有指定 Header 都取不到，则取 X-Forwarded-For 中第一个 IP。XffStatus = 1 时，表示从第一个获取。
	string	否	指定的 Header 字段。	x-forwarded-for
Description	string	否	防护对象描述信息。	test
InstanceId	string	是	WAF 实例的 ID。说明您可以调用 DescribeInstance 查询当前 WAF 实例的 ID。	waf_v3prepaid_public_cn-4xl*******
OwnerUserId	string	否	多账号场景时，防护对象所属的账号 ID。默认防护对象属于 WAF 管理员账号。	123221XXX
Tag	array	否	标签列表，最多包含 20 个子项。
	object	否	资源标签列表，最多包含 20 个子项。
Key	string	否	标签键。	demoTagKey
Value	string	否	标签值。	TagValue1
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfm***q
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou

防护对象 Detail 参数描述

ALB 域名接入（Product 取值为 alb，Pattern 取值为 domain）

将已接入 WAF 的 ALB 实例中的某个域名添加为防护对象。

参数描述

名称	类型	是否必选	示例值	描述
instanceId	String	必选	alb-cj3w3********1x	已接入 WAF 的 ALB 实例 ID。
domain	String	必选	alb.test.com	要接入 WAF 防护的域名。

示例

{
    "domain": "alb.test.com",
    "instanceId": "alb-cj3w3********1x"
}

ECS 域名接入（Product 取值为 ecs，Pattern 取值为 domain）

将已接入 WAF 的 ECS 实例中的某个域名添加为防护对象。

参数描述

名称	类型	是否必选	示例值	描述
domain	String	必选	ecs.test.com	要接入 WAF 防护的域名。

示例

{
    "domain": "ecs.test.com"
}

CLB 域名接入（Product 取值为 clb4 或 clb7，Pattern 取值为 domain）

将已接入 WAF 的 CLB 实例中的某个域名添加为防护对象。

参数描述

名称	类型	是否必选	示例值	描述
domain	String	必选	clb.test.com	要接入 WAF 防护的域名。

示例

{
    "domain": "clb.test.com"
}

NLB 域名接入（Product 取值为 nlb，Pattern 取值为 domain）

将已接入 WAF 的 CLB 实例中的某个域名添加为防护对象。

参数描述

名称	类型	是否必选	示例值	描述
domain	String	必选	nlb.test.com	要接入 WAF 防护的域名。

示例

{
    "domain": "nlb.test.com"
}

WAF 混合云服务化接入（Product 取值为 waf，Pattern 取值为 multi_service）

将 WAF 混合云服务化接入集群的某个域名路径创建防护对象。

参数描述

名称	类型	是否必选	示例值	描述
domain	String	必选	a.test.com	要接入 WAF 防护的域名或 IP。
url	String	必选	/abc	URL 路径

示例

{
    "domain": "a.test.com",
    "url": "/abc"
}

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	1738C613-D054-5191-888B-DC0CF4C3A4A0
Resource	string	创建的防护对象名称。	cdX.XXX-call.cn-alb

示例

正常返回示例

JSON格式

{
  "RequestId": "1738C613-D054-5191-888B-DC0CF4C3A4A0",
  "Resource": "cdX.XXX-call.cn-alb"
}

错误码

HTTP status code	错误码	错误信息	描述
400	Waf.Pullin.ResourceExsit	Access resource already exists, resource:%s.	接入资源已存在，已存在的资源：%s。

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

变更历史

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