全部产品
Search

搜索本产品

    DDoS 防护：DescribeL7RsPolicy - 查询网站业务转发规则的回源策略

    文档中心

    DDoS 防护：DescribeL7RsPolicy - 查询网站业务转发规则的回源策略

    更新时间：Oct 23, 2024

    查询网站业务转发规则的回源策略。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    ResourceGroupIdstring否

    DDoS 高防实例在资源管理服务中所属的资源组 ID。默认为空，即属于默认资源组。

    关于资源组的更多信息，请参见创建资源组。

    		rg-acfm2pz25js****
    Domainstring是

    要查询的网站业务的域名。

    说明 域名必须已经配置过网站业务转发规则。您可以调用 DescribeDomains 查询所有已经配置过网站业务转发规则的域名。
    		example.com
    RealServersarray否

    要查询的源站服务器地址列表。N 的最大值：200，即最多可配置 200 个源站服务器地址。

    string否

    要查询的源站服务器地址列表。N 的最大值：200，即最多可配置 200 个源站服务器地址，服务器地址之间用半角逗号（,）隔开。

    		1.***.***.1

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

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

    返回参数

    名称类型描述示例值
    object
    ProxyModestring

    回源负载均衡算法。取值：

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

    回源重试开关。取值：

    • 1：打开。
    • 0：关闭。
    		1
    RsAttrRwTimeoutMaxlong

    当前用户读/写连接超时时间上限值。

    		300
    RequestIdstring

    本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

    		9E7F6B2C-03F2-462F-9076-B782CF0DD502
    Attributesarray<object>

    回源参数信息。

    AttributeItemobject
    RsTypeinteger

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

    • 0：表示源站服务器的 IP 地址。
    • 1：表示源站服务器的域名地址。
    		0
    RealServerstring

    源站服务器地址。

    		1.***.***.1
    Attributeobject

    回源参数。

    Weightinteger

    服务器的权重。仅在使用轮询算法（ProxyMode 为 rr）和 IP Hash 算法（ProxyMode 为ip_hash）时生效。

    权重取值范围：1~100，默认值为 100。权重越高的服务器分配到的请求越多。

    		100
    ConnectTimeoutinteger

    新建连接超时时间。 值范围 1~10 秒，默认值为 5。

    		5
    FailTimeoutinteger

    失效时间，单位秒，当源站失败超过 MaxFails 时，则将该源站地址设置为 down，时效为 FailTimeout 时间，最终取值取 ConnectTimeout 和 FailTimeout 的最大值。 值范围 1~3600 秒，默认值为 10。

    		10
    MaxFailsinteger

    最大失败次数，健康检查相关。 值范围 1~10 秒，默认值为 3。

    		3
    Modestring

    主备属性标志。取值：

    • active：主。
    • backup：备。
    		active
    ReadTimeoutinteger

    读连接超时时间。 取值范围 10~300 秒，默认值为 120。

    		120
    SendTimeoutinteger

    写连接超时时间。 取值范围 10~300 秒，默认值为 120。

    		120

    示例

    正常返回示例

    JSON格式

    {
  "ProxyMode": "rr",
  "UpstreamRetry": 1,
  "RsAttrRwTimeoutMax": 300,
  "RequestId": "9E7F6B2C-03F2-462F-9076-B782CF0DD502",
  "Attributes": [
    {
      "RsType": 0,
      "RealServer": "1.***.***.1",
      "Attribute": {
        "Weight": 100,
        "ConnectTimeout": 5,
        "FailTimeout": 10,
        "MaxFails": 3,
        "Mode": "active",
        "ReadTimeout": 120,
        "SendTimeout": 120
      }
    }
  ]
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-09-18OpenAPI 返回结构发生变更查看变更详情
    2024-05-09OpenAPI 返回结构发生变更查看变更详情