首页 DDoS 防护 DDoS高防(新BGP&国际) 开发参考 API参考 API目录 其他 DescribeDomainResource - 查询网站业务转发规则的配置

DescribeDomainResource - 查询网站业务转发规则的配置

更新时间: 2023-07-06 11:31:45

查询网站业务转发规则的配置。

接口说明

本接口用于查询分页您已创建的网站业务转发规则的详细配置,例如,网站域名、协议配置、HTTPS配置、CC安全防护配置。

本接口支持与Terraform工具对接。关于Terraform的更多信息,请参见什么是Terraform

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。

调试

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

调试

授权信息

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

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

请求参数

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

要查询的网站域名。

www.example.com
QueryDomainPatternstring

查询匹配模式。取值:

  • fuzzy(默认):表示模糊查询。
  • exact:表示精确查询。
fuzzy
PageNumberinteger

分页查询时,设置当前页面的页码。默认值为1

1
PageSizeinteger

分页查询时,设置每页包含转发规则的数量。

10
InstanceIdsarray

要查询的DDoS高防实例的ID列表。

string

要查询的DDoS高防实例的ID。

说明您可以调用DescribeInstanceIds查询所有DDoS高防实例的ID。
ddoscoo-cn-mp91j1ao****

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

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

返回参数

名称类型描述示例值
object
TotalCountlong

查询到的网站业务转发规则的总数量。

1
RequestIdstring

本次请求的ID。

39499F01-19D9-4EA4-A0E9-C6014BA5CDBE
WebRulesobject []

网站业务转发规则的配置。

Domainstring

网站业务的域名。

www.example.com
Http2HttpsEnableboolean

是否开启了HTTPS强制跳转。取值:

  • true:表示已开启。
  • false:表示未开启。
false
SslProtocolsstring

TLS协议版本。取值:

  • tls1.0:表示TLS 1.0及以上版本。
  • tls1.1:表示TLS 1.1及以上版本。
  • tls1.2:表示TLS 1.2及以上版本。
tls1.0
PunishReasoninteger

域名受到违规处罚的原因。取值:

  • 1:表示域名未履行ICP备案。
  • 2:表示域名经营的业务不符合监管要求。

如果同时包含原因12,该参数返回2

1
CcTemplatestring

频率控制防护(CC防护)的模式。取值:

  • default:表示正常模式。
  • gf_under_attack:表示攻击紧急模式。
  • gf_sos_verify:表示严格模式。
  • gf_sos_enhance:表示超级严格模式。
default
HttpsExtstring

HTTPS高级设置,仅在网站协议类型支持HTTPS(ProxyType包含https)时生效。使用JSON结构体转化的字符串格式表示,JSON结构体包含以下字段:

  • Http2https:Integer类型 | 是否开启了HTTPS的强制跳转功能,取值:0(表示未开启) | 1(表示已开启)。
  • Https2http:Integer类型 | 是否开启了HTTP回源功能,取值:0(表示未开启) | 1(表示已开启)。
  • Http2:Integer类型 | 是否开启了HTTP 2.0协议支持,取值:0(表示未开启) | 1(表示已开启)。
{"Https2http":0,"Http2":0,"Http2https":0}
CcEnabledboolean

是否开启了频率控制防护(CC防护)。取值:

  • true:表示已开启。
  • false:表示未开启。
true
SslCiphersstring

加密套件的类型。取值:

  • default:表示自定义加密套件。
  • all:表示全部加密套件。
  • strong:表示强加密套件。
default
CcRuleEnabledboolean

是否开启了自定义频率控制防护(CC防护)。取值:

  • true:表示已开启。
  • false:表示未开启。
true
Ssl13Enabledboolean

是否开启了TLS 1.3协议支持。取值:

  • true:表示已开启。
  • false:表示未开启。
false
RsTypeinteger

源站服务器的地址类型。取值:

  • 0:表示使用IP地址格式。
  • 1:表示使用域名格式。
0
PunishStatusboolean

域名是否受到违规处罚。取值:

  • true:表示已受到违规处罚。您可以通过PunishReason查看受到违规处罚的具体原因。
  • false:表示未受到违规处罚。
false
ProxyEnabledboolean

DDoS高防是否对该网站业务的流量进行转发。取值:

  • true:表示进行流量转发。
  • false:表示已停止流量转发。
true
CertNamestring

域名使用的SSL证书的名称。

49944XX.pem
PolicyModestring

回源负载算法的类型。取值:

  • ip_hash:表示IP Hash算法。该算法根据请求来源IP进行HASH映射,将同一个IP的所有请求定向到一个源站服务器。
  • rr:表示轮转算法。该算法将所有请求轮流分配给不同源站服务器。
  • least_time:表示Least Time算法。该算法通过智能DNS解析能力,保证业务流量从接入防护节点到转发回源站服务器整个链路的时延最短。
ip_hash
Cnamestring

域名对应的DDoS高防CNAME地址。

0ekb69x3j9wvXXXX.aliyunddosXXXX.com
OcspEnabledboolean

是否启用了OCSP(Online Certificate Status Protocol)功能。取值:

  • true:表示已开启。
  • false:表示未开启。
false
Http2Enableboolean

是否开启了HTTP 2.0。取值:

  • true:表示已开启。
  • false:表示未开启。
false
Https2HttpEnableboolean

是否开启了HTTP回源功能。取值:

  • true:表示已开启。
  • false:表示未开启。
false
ProxyTypesobject []

网站的协议及端口配置。

ProxyTypestring

网站对外服务使用的协议类型。取值:

  • http:表示HTTP协议。
  • https:表示HTTPS协议。
  • websocket:表示WebSocket协议。
  • websockets:表示WebSockets协议。
http
ProxyPortsarray

网站对外服务使用的端口列表。

string

网站对外服务使用的端口。

80
InstanceIdsarray

域名关联的DDoS高防实例的ID列表。

string

域名关联的DDoS高防实例的ID。

ddoscoo-cn-st21zbyq****
CustomCiphersarray

自定义加密套件列表。

string

自定义加密套件。

ECDHE-RSA-AES256-SHA384
WhiteListarray

针对当前域名的白名单IP列表。

string

针对当前域名的白名单IP。

说明仅在您已经为该域名配置了**IP白名单(针对域名)**时返回该结果。您可以调用ConfigWebIpSet为网站域名配置IP黑白名单。
3.XX.XX.3
BlackListarray

针对当前域名的黑名单IP列表。

string

针对当前域名的黑名单IP。

说明仅在您已经为该域名配置了**IP黑名单(针对域名)**时返回该结果。您可以调用ConfigWebIpSet为网站域名配置IP黑白名单。
2.XX.XX.2
RealServersarray

源站服务器地址列表。

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"
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-06-30OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
阿里云首页 DDoS 防护 相关技术圈