puhui-uci

[同步] 创建监听转发策略-240528

开发环境

http://192.168.3.254:31299

POST

/api/v1/loadbalancer/listener-rule/create

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.CreateLbListenerRuleOptions)

可选

backendGroupId

string

可选

和redirect字段互斥

condition

string

可选

for aws only

domain

string

可选

healthCheck

string

可选

for qcloud only 开启 on

healthCheckDomain

string

可选

for qcloud only

healthCheckFail

integer

可选

for qcloud only

healthCheckHttpCode

string

可选

for qcloud only

healthCheckInterval

integer

可选

for qcloud only

healthCheckMethod

string

可选

for qcloud only

healthCheckRise

integer

可选

for qcloud only

healthCheckTimeout

integer

可选

for qcloud only

healthCheckType

string

可选

for qcloud only

healthCheckUri

string

可选

for qcloud only

httpRequestRate

integer

可选

for cloudpods only

httpRequestRatePerSrc

integer

可选

for cloudpods only

listenerId

string

可选

loadbalancerId

string

必需

name

string

可选

path

string

可选

redirect

string

可选

for cloudpods only off raw

redirectCode

integer

可选

for cloudpods only

redirectHost

string

可选

for cloudpods only

redirectPath

string

可选

for cloudpods only

redirectScheme

string

可选

for cloudpods only

regionId

string

必需

scheduler

string

可选

for qcloud only 轮询(RR) 加权轮询(WRR) 加权最小连接数(WLC) 源IP一致性哈希(SCH) 小写

stickySessionCookieTimeout

integer

可选

for qcloud only 会话保持单位秒 0 关闭； 30~86400

示例

{
    "cloudCredentialInfo": {
        "accessKey": "string",
        "accountId": "string",
        "hypervisor": "string",
        "provider": "Aliyun",
        "secretKey": "string",
        "url": "string"
    },
    "data": {
        "backendGroupId": "string",
        "condition": "string",
        "domain": "string",
        "healthCheck": "string",
        "healthCheckDomain": "string",
        "healthCheckFail": 0,
        "healthCheckHttpCode": "string",
        "healthCheckInterval": 0,
        "healthCheckMethod": "string",
        "healthCheckRise": 0,
        "healthCheckTimeout": 0,
        "healthCheckType": "string",
        "healthCheckUri": "string",
        "httpRequestRate": 0,
        "httpRequestRatePerSrc": 0,
        "listenerId": "string",
        "loadbalancerId": "string",
        "name": "string",
        "path": "string",
        "redirect": "string",
        "redirectCode": 0,
        "redirectHost": "string",
        "redirectPath": "string",
        "redirectScheme": "string",
        "regionId": "string",
        "scheduler": "string",
        "stickySessionCookieTimeout": 0
    }
}

示例代码

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-rule/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cloudCredentialInfo": {
        "accessKey": "string",
        "accountId": "string",
        "hypervisor": "string",
        "provider": "Aliyun",
        "secretKey": "string",
        "url": "string"
    },
    "data": {
        "backendGroupId": "string",
        "condition": "string",
        "domain": "string",
        "healthCheck": "string",
        "healthCheckDomain": "string",
        "healthCheckFail": 0,
        "healthCheckHttpCode": "string",
        "healthCheckInterval": 0,
        "healthCheckMethod": "string",
        "healthCheckRise": 0,
        "healthCheckTimeout": 0,
        "healthCheckType": "string",
        "healthCheckUri": "string",
        "httpRequestRate": 0,
        "httpRequestRatePerSrc": 0,
        "listenerId": "string",
        "loadbalancerId": "string",
        "name": "string",
        "path": "string",
        "redirect": "string",
        "redirectCode": 0,
        "redirectHost": "string",
        "redirectPath": "string",
        "redirectScheme": "string",
        "regionId": "string",
        "scheduler": "string",
        "stickySessionCookieTimeout": 0
    }
}'

返回响应

🟢200成功

application/json

Body

content

object

可选

page

integer

可选

pageSize

integer

可选

resources

array[object (codeup_aliyun_com_644a10bf88aef0db4b8c1edc_uci_puhui-uci_pkg_model.LoadbalancerListenerRule) {21}]

返回列表数据

可选

total

integer

可选

errorCode

string

失败 code

可选

errorMsg

string

失败信息

可选

msg

string

响应信息，ok

可选

success

boolean

是否操作成功

可选

taskId

string

任务id

可选

taskName

string

任务名称

可选

示例

{
    "content": {
        "page": 0,
        "pageSize": 0,
        "resources": [
            {
                "backendGroupId": "string",
                "createdAt": "string",
                "deleted": true,
                "domain": "string",
                "healthCheckFall": 0,
                "healthCheckInterval": 0,
                "healthCheckRise": 0,
                "healthCheckTimeout": 0,
                "httpRequestRate": 0,
                "httpRequestRatePerSrc": 0,
                "id": "string",
                "isDefault": true,
                "listenerId": "string",
                "name": "string",
                "path": "string",
                "redirect": "string",
                "redirectCode": 0,
                "redirectHost": "string",
                "redirectPath": "string",
                "redirectScheme": "string",
                "status": "string"
            }
        ],
        "total": 0
    },
    "errorCode": "string",
    "errorMsg": "string",
    "msg": "string",
    "success": true,
    "taskId": "string",
    "taskName": "string"
}

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

[异步] 创建负载均衡监听

[同步] 删除监听转发策略-240528