分页查询防护对象。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
WAF 实例 ID。 说明
您可以通过调用 DescribeInstance 接口查看当前 WAF 实例 ID。 |
waf_cdnsdf3**** |
| PageNumber |
integer |
否 |
分页查询时，返回第几页数据。默认值为 1，表示返回第 1 页数据。 |
1 |
| PageSize |
integer |
否 |
分页查询时，每页包含多少条结果。默认值为 10，表示每页包含 10 条结果。 |
10 |
| Query |
string |
否 |
查询条件，JSON 格式的字符串。 说明
根据不同的查询条件，查询到的防护对象结果不同。详细信息，请参见Query 参数描述。 |
{\"product\":\"waf\"} |
| Tag |
array<object> |
否 |
资源标签列表，最多包含 20 个子项。 |
|
|
object |
否 |
资源标签，由标签建和标签值组成。 |
||
| Value |
string |
否 |
标签值。 |
TagValue1 |
| Key |
string |
否 |
标签键。 |
Tagkey1 |
| ResourceManagerResourceGroupId |
string |
否 |
阿里云资源组 ID。 |
rg-acfm***q |
| RegionId |
string |
否 |
WAF 实例所属地域。取值：
|
cn-hangzhou |
Query 参数详解
参数描述
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
| product | String | 可选 | waf | 资产类型，取值： - waf：表示通过 Cname 或其他方式接入 WAF。 - alb：表示通过 ALB 接入。 - clb：表示通过 CLB 接入。 - ecs：表示通过 ECS 接入。 - mse：表示通过 MSE 接入。 - fc：表示通过 FC 接入。 |
| resourceLike | String | 可选 | example.aliyundoc.c | 要查询的防护对象名称。您可以设置该参数，模糊查询已接入 WAF 的防护对象。 |
| resource | String | 可选 | example.aliyundoc.com-waf | 要查询的防护对象名称。您可以设置该参数，精确查询已接入 WAF 的防护对象。 |
| resourceIn | String | 可选 | example1.aliyundoc.com,example2.aliyundoc.com | 要查询的多个防护对象。您可以设置该参数，查询多个已接入 WAF 的防护对象。多个防护对象之间使用英文逗号（,）分隔。 |
| instanceId | String | 可选 | alb-nifa24**** | 要查询的防护对象的实例 ID。您可以设置该参数，精确查询已接入 WAF 的防护对象的实例 ID。 |
| domain | String | 可选 | example.aliyundoc.com | 要查询的防护对象的域名。您可以设置该参数，精确查询已接入 WAF 的防护对象的域名。 |
| resourceGroup | String | 可选 | group1 | 要查询的防护对象组。 |
| inGroup | Boolean | 可选 | true | 防护对象是否已加入该防护对象组。 |
| ownerUserId | String | 可选 | 135********23 | 要查询防护对象的资产归属账号。您可以设置该参数，精确查询多账号场景中归属某一账号的 WAF 防护对象。 |
| orderBy | String | 可选 | resource | 设置防护对象排序方式。取值： - resource : 表示按防护对象名称排序。 - gmtModified : 表示按修改时间排序。 |
| desc | Boolean | 可选 | 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 |
请求返回结构体。 |
||
| TotalCount |
integer |
返回结果的总数。 |
73 |
| RequestId |
string |
请求 ID。 |
618F2626-DB27-5187-8C6C-4E61A491**** |
| Resources |
array<object> |
防护对象列表。 |
|
|
array<object> |
防护对象信息。 |
||
| Pattern |
string |
防护对象的防护形式。 |
domain |
| Description |
string |
描述信息。 |
test |
| XffStatus |
integer |
防护对象是否开启 xff 代理。 |
1 |
| GmtModified |
integer |
防护对象修改时间，单位：毫秒。 |
1665633032000 |
| Resource |
string |
防护对象名称。 |
alb-rencs*** |
| AcwV3SecureStatus |
integer |
滑块 cookie 的 secure 属性状态。
|
0 |
| Product |
string |
云产品名称。 |
alb |
| AcwCookieStatus |
integer |
跟踪 cookie 开关状态。
|
1 |
| AcwSecureStatus |
integer |
跟踪 cookie 的 secure 属性状态。
|
0 |
| ResourceManagerResourceGroupId |
string |
阿里云资源组 ID。 |
rg-acfm***q |
| GmtCreate |
integer |
防护对象创建时间，单位：毫秒。 |
1652149203187 |
| OwnerUserId |
string |
多账号统一管理场景中防护对象资产归属账号。 |
135*********46 |
| ResourceOrigin |
string |
防护对象来源。 |
custom |
| ResourceGroup |
string |
防护对象加入防护组的名称。 |
test |
| Detail |
object |
防护对象的具体描述信息，Map 中不同的键值对表示防护对象不同的属性。 |
{"domain":"eou.eleme.cn","uri":"/"} |
| CustomHeaders |
array |
自定义 xff 头用来取真实的客户端源 IP，当 xff=1 且该字段为空时表示取 xff 头中第一个 IP 作为客户端源 IP。 |
|
|
string |
自定义头字段信息。 |
afbfbajf |
|
| ResponseHeaders |
array<object> |
响应头参数 |
|
|
object |
响应头参数 |
||
| Key |
string |
指定的自定义响应头的键。 |
Header-Key |
| Value |
string |
指定的自定义响应头的值。 |
Header-Value |
示例
正常返回示例
JSON格式
{
"TotalCount": 73,
"RequestId": "618F2626-DB27-5187-8C6C-4E61A491****",
"Resources": [
{
"Pattern": "domain",
"Description": "test",
"XffStatus": 1,
"GmtModified": 1665633032000,
"Resource": "alb-rencs***",
"AcwV3SecureStatus": 0,
"Product": "alb",
"AcwCookieStatus": 1,
"AcwSecureStatus": 0,
"ResourceManagerResourceGroupId": "rg-acfm***q",
"GmtCreate": 1652149203187,
"OwnerUserId": "135*********46",
"ResourceOrigin": "custom",
"ResourceGroup": "test",
"Detail": {
"domain": "eou.eleme.cn",
"uri": "/"
},
"CustomHeaders": [
"afbfbajf"
],
"ResponseHeaders": [
{
"Key": "Header-Key",
"Value": "Header-Value"
}
]
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。