Skip to Content
负载均衡 ULB ALBcreate_listener_json

创建应用型负载均衡监听器 - CreateListener

简介

创建一个应用型负载均衡的监听器

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称，当前 API 为 CreateListenerYes
PublicKeystring用户公钥，可从 控制台  获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名，参见 签名算法Yes

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口Yes
LoadBalancerIdstring应用型负载均衡实例IDYes
Namestring监听器的名称。限定字符长度：[1-255]； 限定特殊字符，仅支持：“-”，“_”，“.”； 默认值：listenerNo
Remarkstring监听器的备注信息。限定字符长度：[0-255]No
ListenerPortint监听器的监听端口。应用型限定取值：[1-65535]； 默认值：80No
ListenerProtocolstring监听协议。应用型限定取值： HTTP、HTTPS； 默认值：HTTPNo
Certificatesarray[string]（应用型专用）服务器默认证书ID。仅HTTPS监听支持，HTTPS协议时必填； 暂时只支持最大长度为1No
SecurityPolicyIdstring（应用型专用）安全策略组ID。仅HTTPS监听支持绑定； 默认值：‘Default’，表示绑定原生策略No
IdleTimeoutint连接空闲超时时间。单位：秒； 应用型限定取值：[1-86400]；默认值：60No
Schedulerstring负载均衡算法。应用型限定取值：Roundrobin -> 轮询;Source -> 源地址； WeightRoundrobin -> 加权轮询; Leastconn -> 最小连接数；Backup ->主备模式。
默认值：“Roundrobin”		No
StickinessConfigStickinessConfig会话保持相关配置。具体结构见下方 StickinessConfigNo
HealthCheckConfigHealthCheckConfigSet健康检查相关配置。具体结构见下方 HealthCheckConfigSetNo
CompressionEnabledbool（应用型专用）是否开启数据压缩功能。目前只支持使用gzip对特定文件类型进行压缩； 默认值为：falseNo
HTTP2Enabledbool（应用型专用）是否开启HTTP/2特性。仅HTTPS监听支持开启； 默认值为：falseNo
RedirectEnabledbool（应用型专用）是否开启HTTP重定向到HTTPS。仅HTTP监听支持开启； 默认值为：falseNo
RedirectPortint（应用型专用）重定向端口。限定取值：[1-65535]； 默认值：443No

数据模型

StickinessConfig

字段名类型描述信息必填
Enabledbool是否开启会话保持功能。应用型负载均衡实例基于Cookie实现； 默认值为：falseNo
Typestring（应用型专用）Cookie处理方式。限定枚举值： ServerInsert -> 自动生成KEY；UserDefined -> 用户自定义KEY； 默认值： ServerInsert。No
CookieNamestring（应用型专用）自定义Cookie。当Type取值”UserDefined”时有效且需必填； 限定字符长度：[1-255]No

HealthCheckConfigSet

字段名类型描述信息必填
Enabledbool是否开启健康检查功能。暂时不支持关闭。 默认值为：trueNo
Typestring健康检查方式。应用型限定取值： Port -> 端口检查；HTTP -> HTTP检查； 默认值：PortNo
Domainstring（应用型专用）HTTP检查域名。 当Type为HTTP时，此字段有意义，代表HTTP检查域名No
Pathstring（应用型专用）HTTP检查路径。当Type为HTTP时，此字段有意义，代表HTTP检查路径No

响应字段

字段名类型描述信息必填
RetCodeint返回状态码，为 0 则为成功返回，非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息，当 RetCode 非 0 时提供详细的描述信息No
ListenerIdstring监听器的IDNo

示例

请求示例

curl 'https://api.tnqacloud.com' \
--header 'Content-Type: application/json' \
--data '{
    "Action": "CreateListener",
    "Region": "cn-bj2",
    "ProjectId": "org-XXXXX",
    "LoadBalancerId": "alb-XXXXX",
    "Name":    "ListenerName",
    "Remark": "ListenerRemark",
    "ListenerPort": 443,
    "ListenerProtocol": "HTTPS",
    "Certificates": ["ssl-XXXXX"],
    "SecurityPolicyId":"security-tls12s",
    "IdleTimeout": 30,
    "Scheduler": "Roundrobin",
    "StickinessConfig": {
        "Enabled": true,
        "Type": "UserDefined",
        "CookieName": "userDefine_cookieName"
    },
    "HealthCheckConfig": {
        "Enabled": true,
        "Type": "Port"
    },
    "CompressionEnabled": true,
    "HTTP2Enabled": true
}'

响应示例

{
  "Action": "CreateListenerResponse",
  "RetCode": 0,
  "ListenerId": "als-XXXXX"
}
add_targets_jsoncreate_rule_json