全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

创建监听器

最近更新时间:2024-12-30 21:05:56

接口描述

您可以通过该接口创建监听器。

请求头

参数名称 类型 是否必须 描述
X-Version String 版本号,取值:2020-08-01
X-Action String 操作接口名,取值:CreateListener

请求参数

参数名称 类型 是否必须 示例值 描述
NamespaceID String default-UID 命名空间ID
LoadBalanceId String 3a87cc31-efe6-487c-b28b-11bec3571e7d 负载均衡器ID
ListenerName String kenc_listener 监听器名称:2-128个英文或中文字符,必须以大小字母或中文开头,可以包含 “_” “.” “-” 和数字,如不填写默认为 kenc_listener
ListenerProtocol String TCP (大小写无关) 监听器前端协议:TCP/UDP/GQUIC
ListenerPort Integer 80 监听端口范围:1~65535
Scheduler String 加权轮询 调度算法中GQUIC只支持一致性HASH(mh),其余协议只支持加权轮询(wrr)
Session Object 会话保持
HealthCheck Object 健康检查
Services Array 后端服务实例

Session

参数名称 类型 是否必须 示例值 描述
Switch Integer 1 是否开启会话保持:1(开启)、0(关闭)。默认关闭
PersistenceTimeout Integer 3600 会话保持的超时时间:1~86400s,默认3600s

HealthCheck

参数名称 类型 是否必须 示例值 描述
Switch Integer 1 是否开启健康检查:1(开启)、0(关闭)。默认开启
Interval Integer 5 健康检查时间间隔:连续进行两次健康检查之间的时间间隔,可选值1-600
Timeout Integer 4 健康检查超时时间:健康检查请求的返回等待时间,超过此时间将会被判定为一次失败的检查,可选值1-600
UnhealthyThreshold Integer 4 不健康阈值:健康检查连续失败多少次后,会将后端服务器屏蔽,可选值1-10

Services

参数名称 类型 是否必须 示例值 描述
ServiceType String vm 后端服务类型:目前只支持边缘云主机
ServiceId String i-bb47a9330268aafc4384b96f07080f25-yancct01 后端实例ID
ServicePort Integer 88 端口范围:1~65535
Weight Integer 28 权重范围:1-100

返回参数

参数名称 类型 示例值 描述
RequestID String 3a87cc31-efe6-487c-b28b-11bec3571e7d 请求ID
Code String Success 状态码,有InvalidParameter,Forbidden InternalError,Success四种状态
ListenerId String 3a87cc31-efe6-487c-b28b-11bec3571e7d 监听器ID

请求示例

入参示例

curl --request POST \
--url 'https://kenc.api.ksyun.com' \
--header 'X-Action: CreateListener' \
--header 'X-Version: 2020-08-01' \
--header 'X-Amz-Date: 20200826T092325Z' \
--header 'Authorization: AWS4-HMAC-SHA256 Credential=AKLTDOTh-1tDQjSosbliA0SRHQ/20200826/beijing-6/kenc/aws4_request, SignedHeaders=host;x-amz-date;x-ksc-account-id, Signature=xxxxxxxxxx' \
--data '{
"NamespaceId":"default-2000099925",
"LoadBalanceId":"43e2dda4-89c5-4d32-b4a4-055f7c304f45",
"ListenerName":"kenc_listener",
"ListenerProtocol":"TCP",
"ListenerPort":8080,
"Scheduler":"wrr",
"Session":{"Switch":1,"PersistenceTimeout":3600},
"HealthCheck":{"Switch":1,"Timeout":4,"Interval":5,"UnhealthyThreshold":4},
"Services":[{"ServiceId":"i-7471e84c21ae4a883d826f3c6af78aae-yuxct01","ServiceType":"vm","ServicePort":80,"Weight":20}]}'

成功示例

{
    "Code":"Success",
    "ListenerId":"7fba8be4-32c7-4f08-bcfe-27d050e591bc",
    "RequestId":"1654fd38-fafb-402b-ad7e-d946d4ca20fb"
}

失败示例

{  
    "RequestId": "22a9015d-fd66-45a7-b82e-8e01d39ad94e",
    "Code": "InvalidParameter",
    "Message": "Invalid param NamespaceId."
}

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈