puhui-uci

[同步] 更新监听-240531

开发环境

http://192.168.3.254:31299

POST

/api/v1/loadbalancer/listener/update

loadbalancer

更新监听

请求参数

Body 参数application/json

cloudCredentialInfo

object (codeup_aliyun_com_644a10bf88aef0db4b8c1edc_uci_puhui-uci_pkg_types.CloudProviderParams)

可选

accessKey

string

必需

身份验证 AccessKey

accountId

string

可选

用于百度云 // 服务商地址，用于私有云

hypervisor

string

用于轻量云

可选

provider

enum<string>

可选

云服务商，枚举类型 Aliyun、Qcloud

枚举值:

AliyunQcloudAwsHuaweiBaiduCfelCloudpodsEscrowEcloudCfelCtyunVolcEngineChinaUnionCfel

secretKey

string

必需

身份验证 SecretKey

url

string

可选

服务商地址，用于私有云

data

object (codeup_aliyun_com_644a10bf88aef0db4b8c1edc_uci_puhui-uci_pkg_types.UpdateListenerOptions)

可选

aclId

string

acl id

可选

aclStatus

string

可选

是否开启访问控制 on off

aclType

string

可选

访问控制类型 white black

backendConnectTimeout

integer

后端连接超时时间

可选

backendGroupId

string

后端服务组id

可选

backendGroupType

string

可选

aliyun服务组类型默认：default 主备：master_slave 普通：normal default不支持

certificateId

string

证书id

可选

enableHttp2

boolean

可选

是否开启http2 https需要

gzip

boolean

Gzip数据压缩

可选

healthCheck

string

可选

是否开启健康检查 on off

healthCheckDomain

string

可选

健康检查域名 http需要

healthCheckExp

string

udp 需要

可选

healthCheckFall

integer

可选

healthCheckHttpCode

string

可选

正常状态码必填 http_2xx,http_3xx

healthCheckInterval

integer

可选

healthCheckReq

string

udp 需要

可选

healthCheckRise

integer

可选

healthCheckTimeout

integer

可选

healthCheckType

string

可选

健康检查协议 tcp udp http

healthCheckUri

string

可选

健康检查路径 http必填

httpRequestRate

integer

限定接收请求速率

可选

httpRequestRatePerSrc

integer

可选

限定同源IP发送请求速率

listenerId

string

必需

loadbalancerId

string

必需

regionId

string

必需

scheduler

string

可选

调度算法轮询(RR) 加权轮询(WRR) 加权最小连接数(WLC) 源IP一致性哈希(SCH) 小写

sendProxy

string

可选

stickySession

string

可选

保持会话 off on

stickySessionCookie

string

可选

stickySessionCookieTimeout

integer

可选

stickySessionType

string

可选

insert server

tLSCipherPolicy

string

https需要

可选

xforwardedFor

boolean

可选

是否通过X-Forwarded-For字段获取客户端真实IP

示例

{
    "cloudCredentialInfo": {
        "accessKey": "string",
        "accountId": "string",
        "hypervisor": "string",
        "provider": "Aliyun",
        "secretKey": "string",
        "url": "string"
    },
    "data": {
        "aclId": "string",
        "aclStatus": "string",
        "aclType": "string",
        "backendConnectTimeout": 0,
        "backendGroupId": "string",
        "backendGroupType": "string",
        "certificateId": "string",
        "enableHttp2": true,
        "gzip": true,
        "healthCheck": "string",
        "healthCheckDomain": "string",
        "healthCheckExp": "string",
        "healthCheckFall": 0,
        "healthCheckHttpCode": "string",
        "healthCheckInterval": 0,
        "healthCheckReq": "string",
        "healthCheckRise": 0,
        "healthCheckTimeout": 0,
        "healthCheckType": "string",
        "healthCheckUri": "string",
        "httpRequestRate": 0,
        "httpRequestRatePerSrc": 0,
        "listenerId": "string",
        "loadbalancerId": "string",
        "regionId": "string",
        "scheduler": "string",
        "sendProxy": "string",
        "stickySession": "string",
        "stickySessionCookie": "string",
        "stickySessionCookieTimeout": 0,
        "stickySessionType": "string",
        "tLSCipherPolicy": "string",
        "xforwardedFor": true
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://192.168.3.254:31299/api/v1/loadbalancer/listener/update' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cloudCredentialInfo": {
        "accessKey": "string",
        "accountId": "string",
        "hypervisor": "string",
        "provider": "Aliyun",
        "secretKey": "string",
        "url": "string"
    },
    "data": {
        "aclId": "string",
        "aclStatus": "string",
        "aclType": "string",
        "backendConnectTimeout": 0,
        "backendGroupId": "string",
        "backendGroupType": "string",
        "certificateId": "string",
        "enableHttp2": true,
        "gzip": true,
        "healthCheck": "string",
        "healthCheckDomain": "string",
        "healthCheckExp": "string",
        "healthCheckFall": 0,
        "healthCheckHttpCode": "string",
        "healthCheckInterval": 0,
        "healthCheckReq": "string",
        "healthCheckRise": 0,
        "healthCheckTimeout": 0,
        "healthCheckType": "string",
        "healthCheckUri": "string",
        "httpRequestRate": 0,
        "httpRequestRatePerSrc": 0,
        "listenerId": "string",
        "loadbalancerId": "string",
        "regionId": "string",
        "scheduler": "string",
        "sendProxy": "string",
        "stickySession": "string",
        "stickySessionCookie": "string",
        "stickySessionCookieTimeout": 0,
        "stickySessionType": "string",
        "tLSCipherPolicy": "string",
        "xforwardedFor": true
    }
}'

返回响应

🟢200成功

application/json

Body

failure

array[string]

可选

success

array[string]

可选

示例

{
    "failure": [
        "string"
    ],
    "success": [
        "string"
    ]
}

修改于 2025-04-17 10:22:13

[同步] 禁用监听-240527

[同步] 更新lb属性(qcloud)-250224