文档

DescribeDefenseResource - 查询单个防护对象

更新时间:

查询单个防护对象。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-waf:DescribeDefenseResourceRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

WAF 实例 ID。

说明 您可以通过调用 DescribeInstance 接口查看当前 WAF 实例 ID。
waf_v3prepaid_public_cn-4xl****i60i
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfm***q
Resourcestring

要查询的防护对象名称。您可以设置该参数,精确查询已接入 WAF 的防护对象。

example.aliyundoc.com-waf
RegionIdstring

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。

  • ap-southeast-1:表示非中国内地。

cn-hangzhou

返回参数

名称类型描述示例值
object

请求返回结构体。

RequestIdstring

请求 ID。

439AADF2-368C-5E98-B14E-3086****0573
Resourceobject

防护对象信息。

GmtCreatelong

防护对象创建时间,单位:毫秒。

1607493144000
GmtModifiedlong

防护对象修改时间,单位:毫秒。

1691720010000
Productstring

云产品名称。

alb
Resourcestring

防护对象名称。

alb-rencs***
ResourceGroupstring

防护对象加入的防护对象组的名称。

example_resource_group
Detailobject

防护对象的具体描述信息,Map 中不同的键值对表示防护对象不同的属性。

{ "product": "waf", "domain": "demo.aliyundoc****.com" }
Patternstring

防护对象的防护形式。

domain
XffStatusinteger

WAF 前是否开启七层代理(高防/CDN 等)。取值:

  • 0:未开启。

  • 1:开启。

0
CustomHeadersarray

指定 Header 字段列表。

说明 XffStatus = 1 时,取指定 Header 字段中的第一个 IP 作为客户端源 IP,避免 XFF 伪造,输入多个 Header 时按顺序依次尝试取源 IP,如果第一个取不到则取第二个,依次类推,如果所有指定 Header 都取不到,则取 X-Forwarded-For 中第一个 IP。XffStatus = 1 时,表示从第一个获取。
string

指定的 Header 字段。

x-forwarded-for
ResourceOriginstring

防护对象来源。取值:

  • custom:表示从接入管理创建的防护对象。

  • access:表示用户自定义创建的防护对象。

custom
Descriptionstring

描述信息。

This is Description
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfmoiy****p2oq
AcwCookieStatusinteger

跟踪 cookie 开关状态。

  • 0:表示关闭。

  • 1:表示开启。

0
AcwSecureStatusinteger

跟踪 cookie 的 secure 属性状态。

  • 0:表示关闭。

  • 1:表示开启。

0
AcwV3SecureStatusinteger

滑块 cookie 的 secure 属性状态。

  • 0:表示关闭。

  • 1:表示开启。

0
OwnerUserIdstring

防护对象归属 UID。

170457******9107

示例

正常返回示例

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"
  }
}

错误码

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

  • 本页导读
文档反馈