查询网站业务转发规则的配置。
接口说明
本接口用于分页查询您已创建的网站业务转发规则的配置,例如,转发协议类型、源站服务器地址、HTTPS 配置、IP 黑名单配置等。
调用本接口前,您必须已经调用 CreateWebRule 创建了网站业务转发规则。
QPS 限制
本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-ddoscoo:DescribeWebRules | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ResourceGroupId | string | 否 | DDoS 高防实例在资源管理服务中所属的资源组 ID。 不设置该参数表示默认资源组。 | rg-acfm2pz25js**** |
Domain | string | 否 | 要查询的网站域名。 说明
域名必须已经配置过网站业务转发规则。您可以调用 DescribeDomains 查询所有已经配置过网站业务转发规则的域名。
| example.com |
Cname | string | 否 | 要查询的 CNAME 地址。 | kzmk7b8tt351****.aliyunddos1014**** |
QueryDomainPattern | string | 否 | 查询匹配模式。取值:
| exact |
PageNumber | integer | 否 | 分页查询时,设置当前页面的页码。默认值为 1。 | 1 |
PageSize | integer | 否 | 分页查询时,设置每页包含转发规则的数量。取值范围:1~10。 | 10 |
InstanceIds | array | 否 | 要查询的 DDoS 高防实例的 ID 列表。 | |
string | 否 | 要查询的 DDoS 高防实例的 ID。N 的最大值:200,即最多可配置 200 个 DDoS 高防实例,实例 ID 之间用半角逗号(,)隔开。 说明
您可以调用 DescribeInstanceIds 查询所有 DDoS 高防实例的 ID。
| ddoscoo-cn-i7m27nf3**** |
调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍,请参见公共参数。
调用 API 的请求格式,请参见本文示例中的请求示例。
返回参数
示例
正常返回示例
JSON
格式
{
"TotalCount": 1,
"RequestId": "0F5B72DD-96F4-423A-B12B-A5151DD746B8",
"WebRules": [
{
"Domain": "example.com",
"Http2HttpsEnable": true,
"SslProtocols": "tls1.1",
"PunishReason": 1,
"CcTemplate": "default",
"CcEnabled": true,
"SslCiphers": "default",
"Ssl13Enabled": false,
"CcRuleEnabled": false,
"OcspEnabled": false,
"PunishStatus": true,
"ProxyEnabled": true,
"CertName": "testcert",
"PolicyMode": "ip_hash",
"Cname": "kzmk7b8tt351****.aliyunddos1014****",
"Http2Enable": true,
"Https2HttpEnable": true,
"ProxyTypes": [
{
"ProxyType": "https",
"ProxyPorts": [
"443"
]
}
],
"RealServers": [
{
"RsType": 0,
"RealServer": "192.0.XX.XX"
}
],
"WhiteList": [
"192.168.XX.XX"
],
"BlackList": [
"192.0.XX.XX"
],
"CustomCiphers": [
"ECDHE-ECDSA-AES128-GCM-SHA256"
],
"GmCert": {
"CertId": "725****",
"GmEnable": 1,
"GmOnly": 1
},
"CertRegion": "cn-hangzhou",
"UserCertName": "test"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-08-30 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-07-18 | OpenAPI 返回结构发生变更 | 查看变更详情 |