全部产品
Search
文档中心

Web 应用防火墙:DescribeApisecProtectionGroups - 查询API安全防护对象组的生效列表

更新时间:Nov 15, 2024

查询API安全防护对象组的生效列表。

调试

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

授权信息

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

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

请求参数

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

WAF 实例所属地域。取值:

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

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

cn-hangzhou
InstanceIdstring

WAF 实例的 ID。

说明 您可以调用 DescribeInstance 查询当前 WAF 实例的 ID。
waf_elasticity-cn-0xldbqt****
ResourceGroupstring

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

group1
PageNumberlong

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

1
PageSizelong

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

10
ApisecStatusinteger

API 安全检测开关。

1
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfm***q

返回参数

名称类型描述示例值
object

请求结果。

TotalCountlong

防护对象组的总数。

8
RequestIdstring

请求 ID。

D7861F61-5B61-46CE-A47C-6B19****5EB0
Dataarray<object>

防护对象组的列表。

dataobject

防护对象组的信息。

ApisecStatuslong

API 安全总开关。

1
ReportStatuslong

合规审查开关。

0
ResourceGroupstring

防护对象组的名称。

group1
TraceStatuslong

溯源审计开关。

0

示例

正常返回示例

JSON格式

{
  "TotalCount": 8,
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19****5EB0",
  "Data": [
    {
      "ApisecStatus": 1,
      "ReportStatus": 0,
      "ResourceGroup": "group1",
      "TraceStatus": 0
    }
  ]
}

错误码

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