监听接口

1. 创建监听器

POST https://open.cn-east-1.163yun.com/nlb?Action=CreateLBListener&Version=2017-12-05

示例

请求:
POST https://open.cn-east-1.163yun.com/nlb?Action=CreateLBListener&Version=2017-12-05

HEADER:
    Content-type: application/json
    

BODY:
    {
        "InstanceId": "01dfd813-3bf3-4199-ba97-39f59ab8e64c",
        "Name": "l1",
        "ListenPort": 8088,
        "Protocol": "http",
        "Balance": "leastconn",
        "ForwardPort": 1
        "Clusters": [
            {
                "ServerName": "1.com",
                "CertId":"f271a811-d277-4d23-822e-9b9e71bf05a1"(https时必选)
                "Path": "/1",
                "ClusterPort": 80,
                "TargetGroupId": "05315b9a-9e32-4634-9fb8-6df6d9fca49e",
                "Policy": {
                    "Mode": "insert",
                    "Expire": 30000
                }
            }
        ]
    }
响应:
    无

参数说明

  • http body
参数参数描述必选类型范围默认值说明
InstanceId实例IDuuidV4-创建监听之前需要先创建实例,instanceId是CreateLoadBalancer接口返回
Name监听名字string长度不超过64
ListenPort监听端口numbertcp:2-65535、http:80,1025-65535、https:443,1025-65535-
Protocol监听类型stringtcp/http/https/tls-
Clusters后端集群array of json-Protocol 为tcp或者tls时,数组长度必需等于1
Clusters->ServerName域名string长度不大于512*支持多个serverName, 以空格分隔,普通域名由字母数字以及.组成, 通配符域名*.在最前面和.*在最后面;支持pcrl正则表达式,优先级为普通域名> 通配符 > 正则表达式,类型相同时,长度最长先匹配; 整体优先级serverName > path
Clusters->Path路径string不超过128/支持多个url,每个url以空格分隔,普通url的格式为:满足以‘/’开头,并且由数字和字母开头的;支持pcre规则的正则表达式;匹配优先级为普通字符串>正则表达式 类型相同时,长度优先
Clusters->CertId证书IDstring-https时候必选
Clusters->TargetGroupId目标组IDstring-由CrateTargetGroup接口返回
Clusters->ClusterPort集群端口number-tcp/tls:2-65535、http:80,1025-65535、https:443,1025-65535
Clusters->Policy会话保持策略json--
Clusters->Policy->Mode模式stringinsert/rewrite
Clusters->Policy->CookieNamecookie 名字string长度不超过1000空字串rewrite必选,insert没有使用,由数字字母以及"-"和"_"组成
Clusters->Policy->Expire失效时间number0-86400单位秒,默认30000
Monitor健康检查规则string--
Monitor->period周期number5000-300000单位毫秒,默认值5000
Monitor->timeout超时时间number2000-60000单位毫秒,默认值2000
Monitor->rise正常状态所需次数number2-10默认值2
Monitor->fall异常状态所需次数number2-10默认值3
Monitor->protocol协议stringhttp/tcp目前仅支持两种
Monitor->url健康检查路径string以/开头,数字和字母结尾,默认为/最长为127
Monitor->port健康检查端口number1-65535-
Monitor->rstatus状态码string限制为’2xx’, ‘3xx’, ‘4xx’, 以“,”分隔-
TraceVipvip 跟踪number0/10在HTTP HEARDER中带NLB-VIP头部,VALUE为Address,配合apm监控, 1代表打开选项
Balance负载均衡策略stringroundrobin/leastconnroundrobin 加权轮询(默认值);leastconn 加权最少连接数
Gzip压缩number0/10代表关闭(默认值);1代表打开gip功能
ForwardPort转发X-Forwarded-Port头部number0/10代表关闭(默认值);1代表打开该功能
CipherSuiteId加密套件Idstring-https://www.163yun.com/help/documents/101493766532288512
Timeouttcp超时时间number单位秒,10-3600,默认900s

结果说明

返回码

  • 200 修改成功
  • 400 参数错误
  • 403 权限错误
  • 404 目标不存在
  • 500 内部错误

2. 修改监听器

POST https://open.cn-east-1.163yun.com/nlb?Action=UpdateLBListener&Version=2017-12-05

示例

请求:
POST https://open.cn-east-1.163yun.com/nlb?Action=UpdateLBListener&Version=2017-12-05

HEADER:
    Content-type: application/json
    

BODY:
    {
        "InstanceId": "01dfd813-3bf3-4199-ba97-39f59ab8e64c",
        "ListenerId": "aa15e86b-0239-48b7-85b5-e67b7470fbe6",
        "Balance": "leastconn",
        "ForwardPort": 0,
        "Clusters": [
            {
                "ServerName": "1.com",
                "CertId":"f271a811-d277-4d23-822e-9b9e71bf05a1"(https时必选)
                "Path": "/1",
                "ClusterPort": 80,
                "TargetGroupId": "05315b9a-9e32-4634-9fb8-6df6d9fca49e",
                "Policy": {
                    "Mode": "insert",
                    "Expire": 30000
                }
            }
        ]
    }
响应:
    无

参数说明

  • http body
参数参数描述必选类型范围默认值说明
InstanceId实例IDuuidV4-创建监听之前需要先创建实例,instanceId是CreateLoadBalancer接口返回
Name监听名字string长度不超过64
Clusters后端集群array of json-Protocol 为tcp或者tls时,数组长度必需等于1
Clusters->ServerName域名string长度不大于512*支持多个serverName, 以空格分隔,普通域名由字母数字以及.组成, 通配符域名*.在最前面和.*在最后面;支持pcrl正则表达式,优先级为普通域名> 通配符 > 正则表达式,类型相同时,长度最长先匹配; 整体优先级serverName > path
Clusters->Path路径string不超过128/支持多个url,每个url以空格分隔,普通url的格式为:满足以‘/’开头,并且由数字和字母开头的;支持pcre规则的正则表达式;匹配优先级为普通字符串>正则表达式 类型相同时,长度优先
Clusters->CertId证书IDstring-https时候必选
Clusters->TargetGroupId目标组IDstring-由CrateTargetGroup接口返回
Clusters->ClusterPort集群端口number-tcp/tls:2-65535、http:80,1025-65535、https:443,1025-65535
Clusters->Policy会话保持策略json--
Clusters->Policy->Mode模式stringinsert/rewrite
Clusters->Policy->CookieNamecookie 名字string长度不超过1000空字串rewrite必选,insert没有使用,由数字字母以及"-"和"_"组成
Clusters->Policy->Expire失效时间number0-86400单位秒,默认30000
Monitor健康检查规则string--
Monitor->period周期number5000-300000单位毫秒,默认值5000
Monitor->timeout超时时间number2000-60000单位毫秒,默认值2000
Monitor->rise正常状态所需次数number2-10默认值2
Monitor->fall异常状态所需次数number2-10默认值3
Monitor->protocol协议stringhttp/tcp目前仅支持两种
Monitor->url健康检查路径string以/开头,数字和字母结尾,默认为/最长为127
Monitor->port健康检查端口number1-65535-
Monitor->rstatus状态码string限制为’2xx’, ‘3xx’, ‘4xx’, 以“,”分隔-
TraceVipvip 跟踪number0/10在HTTP HEARDER中带NLB-VIP头部,VALUE为Address,配合apm监控, 1代表打开选项
Balance负载均衡策略stringroundrobin/leastconnroundrobin 加权轮询(默认值);leastconn 加权最少连接数
Gzip压缩number0/10代表关闭(默认值);1代表打开gip功能
ForwardPort转发X-Forwarded-Port头部number0/10代表关闭(默认值);1代表打开该功能
CipherSuiteId加密套件Idstring-https://www.163yun.com/help/documents/101493766532288512
Timeouttcp超时时间number单位秒,10-3600,默认900s

结果说明

返回码

  • 204 修改成功
  • 400 参数错误
  • 403 权限错误
  • 404 目标不存在
  • 500 内部错误

3. 删除监听器

GET https://open.cn-east-1.163yun.com/nlb?Action=DeleteLBListener&InstanceId=&ListenerId=&Version=2017-12-05

示例

请求:
GET https://open.cn-east-1.163yun.com/nlb?Action=DeleteLBListener&InstanceId=&ListenerId=&Version=2017-12-05

HEADER:
    Content-type: application/json
    

响应:
    无

参数说明

  • 消息体
参数参数描述是否必选类型范围
InstanceId实例IDuuidV4
ListenrId监听器IduuidV4

结果说明

返回码

  • 204 修改成功
  • 400 参数错误
  • 403 权限错误
  • 500 内部错误