新建负载均衡器

CreateLoadBalancer 接口用于新建负载均衡(ELB)实例。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=CreateLoadBalancer>
    请求参数>
    AUTHDATA 

请求参数

参数名
类型
说明
可选
示例
备注
Name string ELB的名称,以字母开头,仅包含字母、数字或中划线的3-40个字符。 必须    
AllocationId string 指定与ELB绑定的浮动IP的AllocationId 可选    
Bandwidth int 指定ELB外网服务的带宽值 可选    

返回参数

参数名
类型
说明
示例
备注
loadBalancerId string ELB的实例ID    
allocationId string 所绑定浮动IP的ID    
name string ELB的自定义名称    
status string ELB当前状态    
bandwidth string ELB的带宽限制    

返回示例(JSON)

{
  "CreateLoadBalancerResponse": {
    "LoadBalancer": {
      "status""init",
      "name""test2",
      "loadBalancerId""c95dfdfa-801e-4bde-9e57-4e90952b965a"
    }
  }
}

删除负载均衡器

DeleteLoadBalancer 接口用于删除指定的负载均衡实例。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=DeleteLoadBalancer>
    请求参数>
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
LoadBalancerId string 指定ELB的实例ID 必选    
 

返回参数

参数名
类型
说明
示例
备注
return bool      

返回示例(JSON)

{
    "DeleteLoadBalancerResponse"
        {
            "return"true
        }
}

获取负载均衡器列表

DescribeLoadBalancers 接口用于获取指定或全部负载均衡(ELB)实例信息列表。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=DescribeLoadBalancers>
    请求参数>
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
LoadBalancerId.n string 指定ELB的实例ID,n从1开始 可选    
Limit integer 本次请求返回的最多数量 可选    
Offset integer 本次请求返回的偏移量 可选    

返回参数

参数名
类型
说明
示例
备注
loadBalancerId string ELB的实例ID    
allocationId string 所绑定浮动IP的ID    
name string ELB的自定义名称    
status string ELB当前状态    
bandwidth string ELB的带宽限制    

返回示例(JSON)

{
  "DescribeLoadBalancersResponse": {
    "LoadBalancerSet": {
      "LoadBalancer": [
        {
          "status""running",
          "bandwidth"10,
          "loadBalancerId""6bb09022-40b9-4f59-8080-c0fc595354a1",
          "allocationId""c0970ecb-f779-4348-9e54-1362fcc44848",
          "name""l1"
        },
        {
          "status""init",
          "bandwidth"10,
          "name""l2",
          "loadBalancerId""4937c398-70d0-4e47-aa3e-68b6668e1e77"
        }
      ]
    }
  }
}

配置负载均衡器

ModifyLoadBalancerAttributes 接口用于配置负载均衡(ELB)实例信息。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=ModifyLoadBalancerAttributes>
    请求参数>
    AUTHDATA  

请求参数

参数名
类型
说明
可选值
示例
备注
LoadBalancerId string 指定ELB的实例ID 必须    
Name string 变更自定义名称 可选    
Bandwidth integer 变更ELB带宽 可选    
AllocationId string 变更ELB绑定浮动IP的ID(或者IP) 可选    

返回参数

参数名
类型
说明
示例
备注
loadBalancerId string ELB的实例ID    
allocationId string 所绑定浮动IP的ID    
name string ELB的自定义名称    
status string ELB当前状态    
bandwidth string ELB的带宽限制    

返回示例(JSON)

{
  "ModifyLoadBalancerAttributesResponse": {
    "LoadBalancer": {
      "status""running",
      "bandwidth"200,
      "loadBalancerId""6bb09022-40b9-4f59-8080-c0fc595354a1",
      "allocationId""c0970ecb-f779-4348-9e54-1362fcc44848",
      "name""t2"
    }
  }
}

新建监听转发策略

CreateLoadBalancerListener 接口用于新增监听转发策略。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=CreateLoadBalancerListener>
    请求参数>
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
Alg string 有效值为wrr(加权轮询)、rr(轮询)。转发调度策略 必须    
Protocol string 有效值TCP、HTTP、HTTPS。转发协议 必须    
FrontendPort integer 监听转发规则的对外服务端口 必须    
BackendPort integer 监听转发规则到后端服务器池的端口 必须    
EnableSessionSticky boolean 是否打开会话保持 必须    
Name string 自定义名称 必须    
LoadBalancerId string ELB实例的ID 必须    
CheckInterval integer 默认5。健康检查时间间隔 可选    
CheckRise integer 连续健康检查成功多少次后,认为后端服务可用 可选    
CheckFall integer 连续健康检查失败多少次后,认为后端服务不可用 可选    
CheckTimeout integer 默认3。健康检查超时时间 可选    
Domain string 转发规则对应的域名 可选    
Location string 转发规则对应的URL location 可选    
CookieName string 指定七层会话保持的cookie名称 可选    
CheckUrl string 健康检查URL 可选    
SessionMode string 会话保持模式 可选    
SessionTimeout integer 会话保持超时时间 可选    
CertificateId string Https类型转发对应的证书ID 可选    

返回参数

参数名
类型
说明
示例
备注
listenerId string 转发监听策略的ID    
name string 转发监听策略的名称    
loadBalancerId string ELB的实例ID    
frontendPort integer 监听端口    
backendPort integer 后端转发端口    
alg string 转发调度策略    
protocol string 转发协议    
enableSessionSticky boolean 是否打开回话保持    
sessionMode string 会话保持模式    
sessionTimeout integer 会话保持超时时间    
checkFall integer 健康检查失败次数阈值    
checkRise integer 健康检查成功次数阈值    
checkTimeout integer 健康检查超时时间    
checkInterval integer 健康检查时间间隔    
cookieName string 指定会话保持cookie名称    
location string 转发规则对应的URL    

返回示例(JSON)


 {
  "CreateLoadBalancerListenerResponse": {
    "Listener": {
      "enableSessionSticky"1,
      "checkFall"3,
      "protocol""TCP",
      "checkTimeout"3,
      "checkInterval"5,
      "alg""rr",
      "backendPort"8080,
      "listenerId""eeb18d70-d22a-40ea-8936-8dc510c605fa",
      "cookieName""SRVID",
      "sessionTimeout"600,
      "location""\/",
      "loadBalancerId""6bb09022-40b9-4f59-8080-c0fc595354a1",
      "frontendPort"8091,
      "checkRise"3,
      "sessionMode""insert",
      "name""lC"
    }
  }
}

配置监听转发策略

ConfigLoadBalancerListener 接口用于配置指定的监听转发策略。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=ConfigLoadBalancerListener>
    请求参数>
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
ListenerId string 转发调度策略的ID 必须    
Alg string 有效值为wrr(加权轮询)、rr(轮询)。转发调度策略 可选    
Protocol string 有效值TCP、HTTP、HTTPS。转发协议 可选    
FrontendPort integer 监听转发规则的对外服务端口 可选    
BackendPort integer 监听转发规则到后端服务器池的端口 可选    
EnableSessionSticky boolean 是否打开会话保持 可选    
Name string 自定义名称 可选    
CheckInterval integer 默认5。健康检查时间间隔 可选    
CheckRise integer 连续健康检查成功多少次后,认为后端服务可用 可选    
CheckFall integer 连续健康检查失败多少次后,认为后端服务不可用 可选    
CheckTimeout integer 默认3。健康检查超时时间 可选    
Domain string 转发规则对应的域名 可选    
Location string 转发规则对应的URL location 可选    
CookieName string 指定七层会话保持的cookie名称 可选    
CheckUrl string 健康检查URL 可选    
SessionMode string 会话保持模式 可选    
SessionTimeout integer 会话保持超时时间 可选    
CertificateId string Https类型转发对应的证书ID 可选    

返回参数

参数名
类型
说明
示例
备注
listenerId string 转发监听策略的ID    
name string 转发监听策略的名称    
loadBalancerId string ELB的实例ID    
frontendPort integer 监听端口    
backendPort integer 后端转发端口    
alg string 转发调度策略    
protocol string 转发协议    
enableSessionSticky boolean 是否打开回话保持    
sessionMode string 会话保持模式    
sessionTimeout integer 会话保持超时时间    
checkFall integer 健康检查失败次数阈值    
checkRise integer 健康检查成功次数阈值    
checkTimeout integer 健康检查超时时间    
checkInterval integer 健康检查时间间隔    
cookieName string 指定会话保持cookie名称    
location string 转发规则对应的URL    

返回示例(JSON)

{
  "ConfigLoadBalancerListenerResponse": {
    "Listener": {
      "enableSessionSticky"true,
      "checkFall"3,
      "protocol""TCP",
      "checkTimeout"3,
      "checkInterval"5,
      "alg""rr",
      "backendPort"8080,
      "listenerId""7bc312d1-01ea-4693-b10c-b6cf018c1e30",
      "cookieName""SRVID",
      "sessionTimeout"600,
      "location""\/",
      "loadBalancerId""6bb09022-40b9-4f59-8080-c0fc595354a1",
      "frontendPort"8080,
      "checkRise"3,
      "sessionMode""insert",
      "name""change"
    }
  }
}

获取监听转发策略列表

DescribeLoadBalancerListeners 接口用于获取指定或全部监听转发策略列表。
 

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=DescribeLoadBalancerListeners>
    请求参数>
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
ListenerId.n string 指定Listener的ID,n从1开始 可选    
Limit integer 本次请求返回的最多数量 可选    
Offset integer 本次请求返回的偏移量 可选    

返回参数

参数名
类型
说明
示例
备注
listenerId string 转发监听策略的ID    
name string 转发监听策略的名称    
loadBalancerId string ELB的实例ID    
frontendPort integer 监听端口    
backendPort integer 后端转发端口    
alg string 转发调度策略    
protocol string 转发协议    
enableSessionSticky boolean 是否打开回话保持    
sessionMode string 会话保持模式    
sessionTimeout integer 会话保持超时时间    
checkFall integer 健康检查失败次数阈值    
checkRise integer 健康检查成功次数阈值    
checkTimeout integer 健康检查超时时间    
checkInterval integer 健康检查时间间隔    
cookieName string 指定会话保持cookie名称    
location string 转发规则对应的URL    

返回示例(JSON)

{
  "DescribeLoadBalancerListenersResponse": {
    "ListenerSet": {
      "Listener": [
        {
          "enableSessionSticky"true,
          "checkFall"3,
          "protocol""TCP",
          "checkTimeout"3,
          "checkInterval"5,
          "alg""rr",
          "backendPort"8080,
          "listenerId""7bc312d1-01ea-4693-b10c-b6cf018c1e30",
          "cookieName""SRVID",
          "sessionTimeout"600,
          "location""\/",
          "loadBalancerId""6bb09022-40b9-4f59-8080-c0fc595354a1",
          "frontendPort"8080,
          "checkRise"3,
          "sessionMode""insert",
          "name""lA"
        },
        {
          "enableSessionSticky"true,
          "checkFall"3,
          "protocol""TCP",
          "checkTimeout"3,
          "checkInterval"5,
          "alg""rr",
          "backendPort"8080,
          "listenerId""2710ffa6-1942-4438-9cda-dded3e26ae41",
          "cookieName""SRVID",
          "sessionTimeout"600,
          "location""\/",
          "loadBalancerId""6bb09022-40b9-4f59-8080-c0fc595354a1",
          "frontendPort"80,
          "checkRise"3,
          "sessionMode""insert",
          "name""listenerA"
        }
      ]
    }
  }
}

删除监听转发策略

DeleteLoadBalancerListener 接口用于删除指定的监听转发策略。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=DeleteLoadBalancerListener>
    请求参数>
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
ListenerId string 监听转发策略的ID 必选    

返回参数

参数名
类型
说明
示例
备注
return bool      

返回示例(JSON)

{
    "DeleteLoadBalancerListenerResponse":
        {
            "return"true
        }
}

注册转发后端

RegisterBackendWithListener 接口用于给 Listener 添加后端转发。
 

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=RegisterBackendWithListener>
    请求参数>
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
ListenerId string 添加到的Listener ID 必须    
ServerId string 待添加的Server ID 必须    
Name string Server的自定义名称 必须    
Weight integer 变更转发权重 可选    
Port integer 变更转发端口 可选    
 

返回参数

参数名
类型
说明
示例
备注
backendId string backend的ID    
name string backend的名称    
weight integer 转发权重    
ip string backend的IP地址    
listenerId string 对应的listener ID    
serverId string 对应的serverId    

返回示例(JSON)

{
   "RegisterBackendWithListenerResponse": {
     "Backend": {
       "name""lC-dev-1",
       "weight"100,
       "ip""10.0.233.6",
       "listenerId""eeb18d70-d22a-40ea-8936-8dc510c605fa",
       "backendId""fd63f97a-c430-4900-bcaa-8ef8e2acd202",
       "serverId""886d7b8b-23e0-484e-ae54-f17c6becd1b4"
     }
   }
 }

获取转发后端列表

DescribeListenerBackends 接口用于获取一个Listener对应的一组或全部后端转发。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=CreateLoadBalancer>
    请求参数>
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
ListenerId string Listener ID 必须    
BackendId.n string 指定与Listener绑定的Backend ID 可选    
Limit integer 本次请求返回的最多数量 可选    
Offset integer 本次请求返回的偏移量 可选    

返回参数

参数名
类型
说明
示例
备注
backendId string backend的ID    
name string backend的名称    
weight integer 转发权重    
ip string backend的IP地址    
listenerId string 对应的listener ID    
serverId string 对应的serverId    

返回示例(JSON)

{
   "DescribeListenerBackendsResponse": {
     "BackendSet": {
       "Backend": [
         {
           "name""lC-dev-2",
           "weight"1,
           "ip""10.0.233.7",
           "listenerId""eeb18d70-d22a-40ea-8936-8dc510c605fa",
           "backendId""4187bb20-6d8e-4ce6-b09b-c3900f93c351",
           "serverId""886d7b8b-23e0-484e-ae54-f17c6be4d1b4"
         }
       ]
     }
   }
 }

配置转发后端

ConfigListenerBackend 接口用于给Listener添加后端转发。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=ConfigListenerBackend>
    请求参数>
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
BackendId string 待配置的Backend ID 必须    
Weight integer 变更转发权重 可选    
Port integer 变更转发端口 可选    
ListenerId string 变化Backend关联的Listener 可选    

返回参数

参数名
类型
说明
示例
备注
backendId string backend的ID    
name string backend的名称    
weight integer 转发权重    
ip string backend的IP地址    
listenerId string 对应的listener ID    
serverId string 对应的serverId    

返回示例(JSON)

{
  "ConfigListenerBackendResponse": {
    "Backend": {
      "name""lC-dev-2",
      "weight""20",
      "ip""10.0.233.7",
      "listenerId""eeb18d70-d22a-40ea-8936-8dc510c605fa",
      "backendId""4187bb20-6d8e-4ce6-b09b-c3900f93c351",
      "serverId""886d7b8b-23e0-484e-ae54-f17c6be4d1b4"
    }
  }
}

删除转发后端

DeregisterBackendWithListener 接口用于删除指定的后端。

请求 URL

https://mosapi.meituan.com/mcs/v1?
    Action=DeregisterBackendWithListener>
    请求参数>
    AUTHDATA

请求参数

参数名
类型
说明
可选值
示例
备注
BackendId string 后端的ID 必选    

返回参数

参数名
类型
说明
示例
备注
return bool      

返回示例(JSON)

{
    "DeregisterBackendWithListenerResponse"
        {
            "return"true
        }
}