DescribeDefenseResource - 查询单个防护对象_Web应用防火墙(WAF)-阿里云帮助中心

查询单个防护对象。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-waf:DescribeDefenseResource

get

*DefenseResource

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/{#Resource}

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例 ID。说明您可以通过调用 DescribeInstance 接口查看当前 WAF 实例 ID。	waf_v3prepaid_public_cn-4xl****i60i
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfm***q
Resource	string	是	要查询的防护对象名称。您可以设置该参数，精确查询已接入 WAF 的防护对象。	example.aliyundoc.com-waf
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	请求返回结构体。
RequestId	string	请求 ID。	439AADF2-368C-5E98-B14E-3086****0573
Resource	object	防护对象信息。
GmtCreate	integer	防护对象创建时间，单位：毫秒。	1607493144000
GmtModified	integer	防护对象修改时间，单位：毫秒。	1691720010000
Product	string	云产品名称。	alb
Resource	string	防护对象名称。	alb-rencs***
ResourceGroup	string	防护对象加入的防护对象组的名称。	example_resource_group
Detail	object	防护对象的具体描述信息，Map 中不同的键值对表示防护对象不同的属性。	{ "product": "waf", "domain": "demo.aliyundoc****.com" }
Pattern	string	防护对象的防护形式。	domain
XffStatus	integer	WAF 前是否开启七层代理（高防/CDN 等）。取值： 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
ResourceOrigin	string	防护对象来源。取值： custom：表示从接入管理创建的防护对象。 access：表示用户自定义创建的防护对象。	custom
Description	string	描述信息。	This is Description
ResourceManagerResourceGroupId	string	阿里云资源组 ID。	rg-acfmoiy****p2oq
AcwCookieStatus	integer	跟踪 cookie 开关状态。 0：表示关闭。 1：表示开启。	0
AcwSecureStatus	integer	跟踪 cookie 的 secure 属性状态。 0：表示关闭。 1：表示开启。	0
AcwV3SecureStatus	integer	滑块 cookie 的 secure 属性状态。 0：表示关闭。 1：表示开启。	0
OwnerUserId	string	防护对象归属 UID。	170457******9107
ResponseHeaders	array	响应头参数。
	object	响应头参数
Key	string	指定的自定义响应头的键。	Header-Key
Value	string	指定的自定义响应头的值。	Header-Value

示例

正常返回示例

JSON格式

{
  "RequestId": "439AADF2-368C-5E98-B14E-3086****0573",
  "Resource": {
    "GmtCreate": 1607493144000,
    "GmtModified": 1691720010000,
    "Product": "alb",
    "Resource": "alb-rencs***\n",
    "ResourceGroup": "example_resource_group",
    "Detail": {
      "product": "waf",
      "domain": "demo.aliyundoc****.com"
    },
    "Pattern": "domain",
    "XffStatus": 0,
    "CustomHeaders": [
      "x-forwarded-for"
    ],
    "ResourceOrigin": "custom",
    "Description": "This is Description",
    "ResourceManagerResourceGroupId": "rg-acfmoiy****p2oq",
    "AcwCookieStatus": 0,
    "AcwSecureStatus": 0,
    "AcwV3SecureStatus": 0,
    "OwnerUserId": "170457******9107",
    "ResponseHeaders": [
      {
        "Key": "Header-Key\n",
        "Value": "Header-Value\n"
      }
    ]
  }
}

错误码

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

变更历史

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