云主机

  • 云主机服务 > API 文档 > BGP高防 >四层规则管理 >获取四层规则列表

    获取四层规则列表

    最近更新时间:2020-12-29 20:02:21

    请求路径

    GET /v1/security/bgpip/resource/:resource_id/level4rule_v2

    请求参数

    名称 类型 位置 必须 描述
    X-Qiniu-Regionid string header 地域 id, 取值:shanghai (上海或大陆通用地域), guangzhou (广州)
    resource_id string path 高防实例 id
    page int query 查询页码, 默认为 1
    size int query 分页大小,默认为 20

    返回值

    名称 类型 是否必须
    描述
    data []Level4RuleDetail 四层规则信息列表
    page int 查询页码
    size int 分页大小
    total int 四层规则总数
    request_id string 请求记录 id

    Level4RuleDetail 详情

    名称 类型 是否必须
    描述
    rule_id string 规则 id
    rule_name string 规则名称
    protocol string 转发协议类型,取值:TCP, UDP
    virtual_port int 转发端口
    source_port int 源站端口
    source_type int 回源类型,取值:1(域名回源),2(IP回源)
    source_list [ ] L4RuleSource 回源列表
    keep_time int 会话保持时间,单位:秒
    keep_enable int 会话保持开关,取值:0(会话保持关闭),1(会话保持开启)
    health_check HealthCheckInfo 健康检查信息

    HealthCheckInfo 详情

    名称 类型 是否必须
    描述
    rule_id string 四层规则 id
    enable int 是否开启,1表示开启;0表示关闭
    timeout int 响应超时时间,单位:秒
    interval int 检测间隔时间,单位:秒,必须要大于响应超时时间
    kick_num int 不健康阈值,单位:次
    alive_num int 健康阈值,单位:次
    err_msg string 健康检查错误信息

    示例

    正常返回示例

    {
        "data": [
            {
                "rule_name": "",
                "rule_id": "rule1",
                "protocol": "TCP",
                "virtual_port": 9147,
                "source_port": 9147,
                "source_type": 2,
                "keep_time": 0,
                "keep_enable": 0,
                "source_list": [
                    {
                        "source": "1.2.3.4",
                        "weight": 1
                    }
                ],
                "health_check": {
                    "rule_id": "rule1",
                    "enable": 0,
                    "interval": 15,
                    "kick_num": 5,
                    "alive_num": 5,
                    "timeout": 6,
                    "err_msg": ""
                }
            }
        ],
        "page": 1,
        "size": 20,
        "total": 1,
        "request_id": "04F0F334-AC1"
    }
    
    以上内容是否对您有帮助?
  • Qvm free helper
    Close