文档

DescribeDefenseResources - 分页查询防护对象

更新时间:

分页查询防护对象。

调试

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

授权信息

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

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

请求参数

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

WAF 实例 ID。

说明 您可以通过调用 DescribeInstance 接口查看当前 WAF 实例 ID。
waf_cdnsdf3****
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfm***q
PageNumberinteger

分页查询时,返回第几页数据。默认值为 1,表示返回第 1 页数据。

1
PageSizeinteger

分页查询时,每页包含多少条结果。默认值为 10,表示每页包含 10 条结果。

10
RegionIdstring

WAF 实例所属地域。取值:

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

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

cn-hangzhou
Querystring

查询条件,JSON 格式的字符串。

说明 根据不同的查询条件,查询到的防护对象结果不同。详细信息,请参见Query 参数描述
{\"product\":\"waf\"}
Tagobject []

资源标签列表,最多包含 20 个子项。

Keystring

标签键。

Tagkey1
Valuestring

标签值。

TagValue1

Query 参数描述

参数描述
名称类型是否必选示例值描述
productString可选waf资产类型,取值:
- waf:表示通过 Cname 或其他方式接入 WAF。
- alb:表示通过 ALB 接入。
- clb:表示通过 CLB 接入。
- ecs:表示通过 ECS 接入。
- mse:表示通过 MSE 接入。
- fc:表示通过 FC 接入。
resourceLikeString可选example.aliyundoc.c要查询的防护对象名称。您可以设置该参数,模糊查询已接入 WAF 的防护对象。
resourceString可选example.aliyundoc.com-waf要查询的防护对象名称。您可以设置该参数,精确查询已接入 WAF 的防护对象。
resourceInString可选example1.aliyundoc.com,example2.aliyundoc.com要查询的多个防护对象。您可以设置该参数,查询多个已接入 WAF 的防护对象。多个防护对象之间使用英文逗号(,)分隔。
instanceIdString可选alb-nifa24****要查询的防护对象的实例 ID。您可以设置该参数,精确查询已接入 WAF 的防护对象的实例 ID。
domainString可选example.aliyundoc.com要查询的防护对象的域名。您可以设置该参数,精确查询已接入 WAF 的防护对象的域名。
resourceGroupString可选group1要查询的防护对象组。
inGroupBoolean可选true防护对象是否已加入该防护对象组。
ownerUserIdString可选135********23要查询防护对象的资产归属账号。您可以设置该参数,精确查询多账号场景中归属某一账号的 WAF 防护对象。
orderByString可选resource设置防护对象排序方式。取值:
- resource : 表示按防护对象名称排序。
- gmtModified : 表示按修改时间排序。
descBoolean可选true设置排序顺序。取值:
- false : 表示正序显示。
- true : 表示倒序显示。
示例
{
    "product ": "waf",
    "resource": "example.aliyundoc.com-waf",
    "domain": "example.aliyundoc.com",
    "resourceLike ": "example.aliyundoc.c",
    "InstaneId": "waf_cn****",
    "resourceIn": "example1.aliyundoc.com,example2.aliyundoc.com",
    "ownerUserId": "135**********41"
}

返回参数

名称类型描述示例值
object

请求返回结构体。

RequestIdstring

请求 ID。

618F2626-DB27-5187-8C6C-4E61A491****
Resourcesobject []

防护对象列表。

GmtCreatelong

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

1652149203187
GmtModifiedlong

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

1665633032000
Productstring

云产品名称。

alb
Resourcestring

防护对象名称。

alb-rencs***
ResourceGroupstring

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

test
ResourceOriginstring

防护对象来源。

custom
Descriptionstring

描述信息。

test
Detailobject

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

Patternstring

防护对象的防护形式。

domain
XffStatusinteger

防护对象是否开启 xff 代理。

1
CustomHeadersarray

自定义 xff 头用来取真实的客户端源 IP,当 xff=1 且该字段为空时表示取 xff 头中第一个 IP 作为客户端源 IP。

string

自定义头字段信息。

afbfbajf
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfm***q
AcwCookieStatusinteger

跟踪 cookie 开关状态。

  • 0:表示关闭。

  • 1:表示开启。

1
AcwSecureStatusinteger

跟踪 cookie 的 secure 属性状态。

  • 0:表示关闭。

  • 1:表示开启。

0
AcwV3SecureStatusinteger

滑块 cookie 的 secure 属性状态。

  • 0:表示关闭。

  • 1:表示开启。

0
OwnerUserIdstring

多账号统一管理场景中防护对象资产归属账号。

135*********46
TotalCountlong

返回结果的总数。

73

示例

正常返回示例

JSON格式

{
  "RequestId": "618F2626-DB27-5187-8C6C-4E61A491****",
  "Resources": [
    {
      "GmtCreate": 1652149203187,
      "GmtModified": 1665633032000,
      "Product": "alb",
      "Resource": "alb-rencs***",
      "ResourceGroup": "test",
      "ResourceOrigin": "custom",
      "Description": "test",
      "Detail": {
        "test": "test",
        "test2": 1
      },
      "Pattern": "domain",
      "XffStatus": 1,
      "CustomHeaders": [
        "afbfbajf"
      ],
      "ResourceManagerResourceGroupId": "rg-acfm***q",
      "AcwCookieStatus": 1,
      "AcwSecureStatus": 0,
      "AcwV3SecureStatus": 0,
      "OwnerUserId": "135*********46"
    }
  ],
  "TotalCount": 73
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-03-21OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-08-24OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)