接口描述
您可以通过该接口创建监听器。
请求头
参数名称 |
类型 |
是否必须 |
描述 |
X-Version |
String |
是 |
版本号,取值:2020-08-01 |
X-Action |
String |
是 |
操作接口名,取值:CreateListener |
请求参数
参数名称 |
类型 |
是否必须 |
示例值 |
描述 |
NamespaceID |
String |
是 |
default-UID |
命名空间ID |
LoadBalanceId |
String |
是 |
3a87cc31-efe6-487c-b28b-11bec3571e7d |
负载均衡器ID |
ListenerId |
String |
是 |
3a87cc31-efe6-487c-b28b-11bec3571e7d |
监听器ID |
返回参数
参数名称 |
类型 |
示例值 |
描述 |
RequestID |
String |
3a87cc31-efe6-487c-b28b-11bec3571e7d |
请求ID |
Code |
String |
Success |
状态码,有InvalidParameter,Forbidden InternalError,Success四种状态 |
Listeners |
Array |
|
监听器信息 |
Listeners
参数名称 |
类型 |
示例值 |
描述 |
ListenerId |
String |
3a87cc31-efe6-487c-b28b-11bec3571e7d |
监听器ID |
ListenerName |
String |
kenc_listener |
监听器名称 |
ListenerProtocol |
String |
TCP |
监听器前端协议 |
ListenerPort |
Integer |
80 |
监听端口 |
Scheduler |
String |
加权轮询 |
调度算法 |
Session |
Object |
|
会话保持 |
HealthCheck |
Object |
|
健康检查 |
Services |
Array |
|
后端服务实例 |
Session
参数名称 |
类型 |
示例值 |
描述 |
Switch |
Integer |
1 |
会话保持开启的状态 |
PersistenceTimeout |
Integer |
3600 |
会话保持设置的超时时间 |
HealthCheck
参数名称 |
类型 |
示例值 |
描述 |
Switch |
Integer |
1 |
健康检查的开启状态 |
Interval |
Integer |
5 |
健康检查的时间间隔 |
Timeout |
Integer |
4 |
健康检查超时时间 |
UnhealthyThreshold |
Integer |
4 |
不健康阈值 |
Services
参数名称 |
类型 |
示例值 |
描述 |
HealthStatus |
String |
unknown,healthy,unhealthy |
|
健康状态 |
|
|
|
ServiceType |
String |
vm |
后端服务类型 |
ServiceId |
String |
i-bb47a9330268aafc4384b96f07080f25-yancct01 |
后端实例ID |
ServicePort |
Integer |
88 |
后端端口 |
Weight |
Integer |
8 |
后端权重范围 |
请求示例
入参示例
curl --request POST \
--url 'https://kenc.api.ksyun.com' \
--header 'X-Action: DescribeListeners' \
--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"}'
成功示例
{
"Code":"Success",
"Listeners":[
{
"HealthCheck":{
"Interval":5,
"Switch":1,
"Timeout":4,
"UnhealthyThreshold":4
},
"ListenerId":"7fba8be4-32c7-4f08-bcfe-27d050e591bc",
"ListenerName":"kenc_listener",
"ListenerPort":8080,
"ListenerProtocol":"TCP",
"Scheduler":"wrr",
"Services":[
{
"HealthStatus":"unhealthy",
"ServiceId":"i-7471e84c21ae4a883d826f3c6af78aae-yuxct01",
"ServicePort":80,
"ServiceType":"vm",
"Weight":20
}
],
"Session":{
"PersistenceTimeout":3600,
"Switch":1
}
}
],
"RequestId":"8e9028d4-f030-4539-9b63-88c52f02c9c9"
}
}
失败示例
{
"RequestId": "22a9015d-fd66-45a7-b82e-8e01d39ad94e",
"Code": "InvalidParameter",
"Message": "Invalid param NamespaceId."
}