查询网站业务转发规则的配置。
接口说明
本接口用于查询分页您已创建的网站业务转发规则的详细配置,例如,网站域名、协议配置、HTTPS 配置、CC 安全防护配置。
本接口支持与 Terraform 工具对接。关于 Terraform 的更多信息,请参见什么是 Terraform。
QPS 限制
本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
yundun-ddoscoo:DescribeDomainResource |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Domain |
string |
否 |
要查询的网站域名。 |
www.example.com |
| QueryDomainPattern |
string |
否 |
查询匹配模式。取值:
|
fuzzy |
| PageNumber |
integer |
否 |
分页查询时,设置当前页面的页码。默认值为 1。 |
1 |
| PageSize |
integer |
否 |
分页查询时,设置每页包含转发规则的数量。 |
10 |
| InstanceIds |
array |
否 |
要查询的 DDoS 高防实例的 ID 列表。 |
|
|
string |
否 |
要查询的 DDoS 高防实例的 ID。 说明
您可以调用 DescribeInstanceIds 查询所有 DDoS 高防实例的 ID。 |
ddoscoo-cn-mp91j1ao**** |
调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍,请参见公共参数。
调用 API 的请求格式,请参见本文示例中的请求示例。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| TotalCount |
integer |
查询到的网站业务转发规则的总数量。 |
1 |
| RequestId |
string |
本次请求的 ID。 |
39499F01-19D9-4EA4-A0E9-C6014BA5CDBE |
| WebRules |
array<object> |
网站业务转发规则的配置。 |
|
|
array<object> |
|||
| Domain |
string |
网站业务的域名。 |
www.example.com |
| Http2HttpsEnable |
boolean |
是否开启了 HTTPS 强制跳转。取值:
|
false |
| SslProtocols |
string |
TLS 协议版本。取值:
|
tls1.0 |
| PunishReason |
integer |
域名受到违规处罚的原因。取值:
如果同时包含原因 1 和 2,该参数返回 2。 |
1 |
| CcTemplate |
string |
频率控制防护(CC 防护)的模式。取值:
|
default |
| HttpsExt |
string |
HTTPS 高级设置,仅在网站协议类型支持 HTTPS(ProxyType 包含 https)时生效。使用 JSON 结构体转化的字符串格式表示,JSON 结构体包含以下字段:
|
{"Https2http":0,"Http2":0,"Http2https":0} |
| CcEnabled |
boolean |
是否开启了频率控制防护(CC 防护)。取值:
|
true |
| SslCiphers |
string |
加密套件的类型。取值:
|
default |
| CcRuleEnabled |
boolean |
是否开启了自定义频率控制防护(CC 防护)。取值:
|
true |
| Ssl13Enabled |
boolean |
是否开启了 TLS 1.3 协议支持。取值:
|
false |
| RsType |
integer |
源站服务器的地址类型。取值:
|
0 |
| PunishStatus |
boolean |
域名是否受到违规处罚。取值:
|
false |
| ProxyEnabled |
boolean |
DDoS 高防是否对该网站业务的流量进行转发。取值:
|
true |
| CertName |
string |
域名使用的 SSL 证书的名称。 |
49944XX.pem |
| PolicyMode |
string |
回源负载算法的类型。取值:
|
ip_hash |
| Cname |
string |
域名对应的 DDoS 高防 CNAME 地址。 |
0ekb69x3j9wvXXXX.aliyunddosXXXX.com |
| OcspEnabled |
boolean |
是否启用了 OCSP(Online Certificate Status Protocol)功能。取值:
|
false |
| Http2Enable |
boolean |
是否开启了 HTTP 2.0。取值:
|
false |
| Https2HttpEnable |
boolean |
是否开启了 HTTP 回源功能。取值:
|
false |
| ProxyTypes |
array<object> |
网站的协议及端口配置。 |
|
|
object |
|||
| ProxyType |
string |
网站对外服务使用的协议类型。取值:
|
http |
| ProxyPorts |
array |
网站对外服务使用的端口列表。 |
|
|
string |
网站对外服务使用的端口。 |
80 |
|
| InstanceIds |
array |
域名关联的 DDoS 高防实例的 ID 列表。 |
|
|
string |
域名关联的 DDoS 高防实例的 ID。 |
ddoscoo-cn-st21zbyq**** |
|
| CustomCiphers |
array |
自定义加密套件列表。 |
|
|
string |
非 1.3 版本的自定义加密套件。 说明
请至少选择一个非 1.3 版本的加密套件
|
ECDHE-RSA-AES256-SHA384 |
|
| WhiteList |
array |
针对当前域名的白名单 IP 列表。 |
|
|
string |
针对当前域名的白名单 IP。 说明
仅在您已经为该域名配置了**IP 白名单(针对域名)**时返回该结果。您可以调用 ConfigWebIpSet 为网站域名配置 IP 黑白名单。 |
3.XX.XX.3 |
|
| BlackList |
array |
针对当前域名的黑名单 IP 列表。 |
|
|
string |
针对当前域名的黑名单 IP。 说明
仅在您已经为该域名配置了 IP 黑名单(针对域名) 时返回该结果。您可以调用 ConfigWebIpSet 为网站域名配置 IP 黑白名单。 |
2.XX.XX.2 |
|
| RealServers |
array |
源站服务器地址列表。 |
|
|
string |
源站服务器地址。 |
1.XX.XX.1 |
示例
正常返回示例
JSON格式
{
"TotalCount": 1,
"RequestId": "39499F01-19D9-4EA4-A0E9-C6014BA5CDBE",
"WebRules": [
{
"Domain": "www.example.com",
"Http2HttpsEnable": false,
"SslProtocols": "tls1.0",
"PunishReason": 1,
"CcTemplate": "default",
"HttpsExt": "{\"Https2http\":0,\"Http2\":0,\"Http2https\":0}",
"CcEnabled": true,
"SslCiphers": "default",
"CcRuleEnabled": true,
"Ssl13Enabled": false,
"RsType": 0,
"PunishStatus": false,
"ProxyEnabled": true,
"CertName": "49944XX.pem",
"PolicyMode": "ip_hash",
"Cname": "0ekb69x3j9wvXXXX.aliyunddosXXXX.com",
"OcspEnabled": false,
"Http2Enable": false,
"Https2HttpEnable": false,
"ProxyTypes": [
{
"ProxyType": "http",
"ProxyPorts": [
"80"
]
}
],
"InstanceIds": [
"ddoscoo-cn-st21zbyq****"
],
"CustomCiphers": [
"ECDHE-RSA-AES256-SHA384"
],
"WhiteList": [
"3.XX.XX.3"
],
"BlackList": [
"2.XX.XX.2"
],
"RealServers": [
"1.XX.XX.1"
]
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。