DescribeDomainBasicConfigs_Web 应用防火墙_API文档-阿里云OpenAPI开发者门户

接口说明

本接口用于分页查询已接入 WAF 防护的网站域名的基本配置（以下简称域名配置），例如，域名配置的状态、默认防护模块（包括规则防护引擎、CC 安全防护、自定义防护策略）的状态和模式等。请注意，为确保系统稳定性，对单用户 QPS 限制为 50 次/秒。超过限制，API 调用将会被限流，这可能影响您的业务，请合理调用。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

yundun-waf:DescribeDomainBasicConfigs	Get	全部资源 *	无	无

请求参数

字段名称	字段详情
InstanceIdstring	WAF 实例的 ID。展开详情示例值:waf-cn-tl32ast****参考取值来源: DescribeInstanceInfo
DomainKeystring	设置域名关键字，查询包含指定关键字的域名配置。展开详情示例值:aliyundoc
AccessTypestring	设置域名接入模式，查询使用指定方式接入 WAF 防护的域名配置。取值：展开详情示例值:waf-cloud-dns
CloudNativeProductIdinteger<int32>	设置源站类型，查询在透明接入方式下通过指定源站类型接入 WAF 防护的域名配置。取值：展开详情示例值:0
PageNumberinteger<int32>	分页查询时，设置当前页面的页码。默认值为 1。示例值:1
PageSizeinteger<int32>	分页查询时，设置每页包含域名配置的数量。默认值为 10。示例值:10
ResourceGroupIdstring	网站域名在资源管理服务中所属的资源组 ID。展开详情示例值:rg-acfm2pz25js****
RegionIdstring	WAF 实例所属地域。取值：展开详情示例值:cn-hangzhou

请求说明

调用 API 时，除了本文中该 API 的请求参数，还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍，请参见公共参数。

调用 API 的请求格式，请参见本文示例中的请求示例。

返回参数

字段名称	字段详情
TotalCountinteger<int32>	查询到的域名配置的总数量。示例值:1
RequestIdstring	本次请求的 ID。示例值:D7861F61-5B61-46CE-A47C-6B19160D5EB0
DomainConfigsarray<object>	域名配置详情列表。

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

403	Forbbiden	User not authorized to operate on the specified resource.	诊断
500	InternalError	The request processing has failed due to some unknown error.	诊断

变更历史

暂无变更历史