新建 - cloudpods

新建

请求参数

Body 参数application/json

count

integer <int64>

可选

默认值:

loadbalancerlistener

object (LoadbalancerListenerCreateInput)

可选

__meta__

object

可选

标签列表,最多支持20个

示例值:

{"user:rd":"op"}

acl_id

string

可选

acl_status

string

可选

acl_type

string

可选

backend_connect_timeout

integer <int64>

可选

range 1-180

默认值:

backend_group_id

string

可选

backend_idle_timeout

integer <int64>

可选

range 1-600

默认值:

certificate_id

string

可选

client_idle_timeout

integer <int64>

可选

range 1-600

默认值:

client_request_timeout

integer <int64>

可选

range 1-600

默认值:

description

string

资源描述

可选

示例值:

test create network

dry_run

boolean

可选

预检验参数,若为true则仅检查参数,并不真正创建变更

默认值:

false

egress_mbps

integer <int64>

可选

enable_http2

boolean

可选

默认值:

true

generate_name

string

可选

生成资源名称的模板，如果name为空，则为必填项
description: generated resource name, given a pattern to generate name, required if name is not given

示例值:

test###

gzip

boolean

可选

health_check

string

可选

默认值:

health_check_domain

string

可选

health_check_fail

integer <int64>

2-10

可选

默认值:

health_check_http_code

string

可选

默认值:

http_2xx,http_3xx

health_check_interval

integer <int64>

5-300

可选

默认值:

health_check_path

string

可选

health_check_rise

integer <int64>

2-10

可选

默认值:

health_check_timeout

integer <int64>

2-120

可选

默认值:

health_check_type

enum<string>

可选

枚举值:

tcpudphttp

http_request_rate

integer <int64>

可选

http_request_rate_src

integer <int64>

可选

is_emulated

boolean

可选

资源是否为模拟资源
description: the resource is an emulated resource

listener_port

integer <int64>

可选

listener_type

string

必需

loadbalancer_id

string

负载均衡ID

可选

name

string

必需

资源名称，如果generate_name为空，则为必填项
description: resource name, required if generated_name is not given

示例值:

test-network

redirect

string

可选

默认值:

off

redirect_code

integer <int64>

可选

redirect_host

string

可选

redirect_path

string

可选

redirect_scheme

string

可选

scheduler

string

可选

send_proxy

string

可选

status

string

用来存储资源的状态

可选

sticky_session

string

可选

sticky_session_cookie

string

可选

sticky_session_cookie_timeout

integer <int64>

可选

sticky_session_type

string

可选

tls_cipher_policy

string

可选

x_forwarded_for

boolean

可选

默认值:

true

示例

{
    "count": 1,
    "loadbalancerlistener": {
        "__meta__": {
            "user:rd": "op"
        },
        "acl_id": "string",
        "acl_status": "string",
        "acl_type": "string",
        "backend_connect_timeout": 5,
        "backend_group_id": "string",
        "backend_idle_timeout": 90,
        "certificate_id": "string",
        "client_idle_timeout": 90,
        "client_request_timeout": 10,
        "description": "test create network",
        "dry_run": false,
        "egress_mbps": 0,
        "enable_http2": true,
        "generate_name": "test###",
        "gzip": true,
        "health_check": "on",
        "health_check_domain": "string",
        "health_check_fail": 2,
        "health_check_http_code": "http_2xx,http_3xx",
        "health_check_interval": 30,
        "health_check_path": "string",
        "health_check_rise": 5,
        "health_check_timeout": 5,
        "health_check_type": "tcp",
        "http_request_rate": 0,
        "http_request_rate_src": 0,
        "is_emulated": true,
        "listener_port": 0,
        "listener_type": "string",
        "loadbalancer_id": "string",
        "name": "test-network",
        "redirect": "off",
        "redirect_code": 0,
        "redirect_host": "string",
        "redirect_path": "string",
        "redirect_scheme": "string",
        "scheduler": "string",
        "send_proxy": "string",
        "status": "string",
        "sticky_session": "string",
        "sticky_session_cookie": "string",
        "sticky_session_cookie_timeout": 0,
        "sticky_session_type": "string",
        "tls_cipher_policy": "string",
        "x_forwarded_for": true
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

loadbalancerlistener

object (LoadbalancerListenerDetails)

可选

account

string

云账号名称

可选

示例值:

google-account

account_health_status

string

云账号监控状态

可选

account_id

string

云账号Id

可选

示例值:

4d3c8979-9dd0-439b-8d78-36fe1ab1666c

account_read_only

boolean

可选

account_status

string

云账号状态

可选

acl

string

负载均衡ACL名称

可选

acl_id

string

本地Acl ID

可选

acl_status

string

可选

acl_type

string

可选

backend_connect_timeout

integer <int64>

连接空闲超时时间

可选

backend_group

string

可选

backend_group_id

string

可选

backend_idle_timeout

integer <int64>

后端连接超时时间

可选

backend_server_port

integer <int64>

可选

brand

string

云平台品牌

可选

示例值:

Google

can_delete

boolean

可选

资源是否可以删除, 若为flase, delete_fail_reason会返回不能删除的原因

示例值:

true

can_update

boolean

可选

资源是否可以更新, 若为false,update_fail_reason会返回资源不能删除的原因

示例值:

true

certificate

string

负载均衡证书名称

可选

certificate_id

string

可选

本地负载均衡证书ID

certificate_name

string

可选

client_idle_timeout

integer <int64>

连接请求超时时间

可选

client_request_timeout

integer <int64>

可选

cloud_env

string

云环境

可选

示例值:

public

cloudregion

string

区域的名称

可选

cloudregion_id

string

可用区的区域ID

可选

created_at

string <date-time>

资源创建时间

可选

delete_fail_reason

object (Error)

可选

deleted

boolean

资源是否被删除

可选

deleted_at

string <date-time>

资源删除时间

可选

description

string

资源描述信息

可选

egress_mbps

integer <int64>

可选

enable_http2

boolean

可选

environment

string

可选

Environment

external_id

string

可选

云上Id, 对应云上资源自身Id

gzip

boolean

获取客户端真实IP

可选

health_check

string

可选

health_check_domain

string

可选

health_check_exp

string

可选

UDP监听健康检查的请求串

health_check_fall

integer <int64>

可选

健康检查健康阈值 3秒

health_check_http_code

string

健康检查路径 /

可选

health_check_interval

integer <int64>

可选

健康检查超时时间 10秒

health_check_req

string

可选

health_check_rise

integer <int64>

可选

health_check_timeout

integer <int64>

可选

健康检查不健康阈值 15秒

health_check_type

string

可选

健康检查开启状态 on|off

health_check_uri

string

可选

健康检查域名 yunion.cn

http_request_rate

integer <int64>

可选

http_request_rate_per_src

integer <int64>

可选

限定监听接收请示速率

string

资源UUID

可选

imported_at

string <date-time>

资源导入时间

可选

is_default_vpc

boolean

是否为经典网络

可选

is_emulated

boolean

可选

是否是模拟资源, 部分从公有云上同步的资源并不真实存在, 例如宿主机
list 接口默认不会返回这类资源，除非显示指定 is_emulate=true 过滤参数

listener_port

integer <int64>

可选

listener_type

string

可选

loadbalancer

string

负载均衡名称

可选

loadbalancer_id

string

负载均衡ID

可选

manager

string

云订阅名称

可选

示例值:

google-account

manager_domain

string

子订阅所在域名称

可选

示例值:

Default

manager_domain_id

string

子订阅所在域Id

可选

示例值:

default

manager_id

string

可选

VPC归属云订阅ID

manager_project

string

子订阅所在项目名称

可选

示例值:

system

manager_project_id

string

子订阅所在项目Id

可选

示例值:

4d3c8979-9dd0-439b-8d78-36fe1ab1666c

metadata

object

标签

可选

name

string

资源名称

可选

progress

number <float>

操作进度0-100

可选

provider

string

云平台名称

可选

示例值:

Google

redirect

string

可选

redirect_code

integer <int64>

跳转类型

可选

redirect_host

string

可选

跳转uri scheme

redirect_path

string

跳转时变更Host

可选

redirect_scheme

string

可选

跳转HTTP code

region

string

区域的名称

可选

示例值:

Default

region_ext_id

string

纳管云区域的Id

可选

示例值:

59e7bc87-a6b3-4c39-8f02-c68e8243d4e4

region_external_id

string

可选

纳管云区域的组合Id(平台+Id)

示例值:

ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4

region_id

string

区域的Id

可选

示例值:

default

scheduler

string

可选

send_proxy

string

可选

source

string

可选

资源来源, cloud: 从云上同步下来的资源, local: 从本地创建的资源或资源在本地更改过项目

status

string

资源状态

可选

sticky_session

string

可选

sticky_session_cookie

string

可选

Cookie处理方式 insert(植入cookie)|server(重写cookie)

sticky_session_cookie_timeout

integer <int64>

Cookie名称

可选

sticky_session_type

string

可选

会话保持开启状态 on|off

tenant_id

string

可选

tls_cipher_policy

string

可选

update_fail_reason

object (Error)

可选

update_version

integer <int64>

资源被更新次数

可选

updated_at

string <date-time>

资源更新时间

可选

vpc

string

Vpc Name

可选

vpc_ext_id

string

VPC外部Id

可选

vpc_id

string

VPC ID

可选

xforwarded_for

boolean

可选

zone

string

可用区名称

可选

示例值:

北京一区

zone_ext_id

string

可选

纳管云的zoneId

zone_id

string

可用区ID

可选

示例

{
    "loadbalancerlistener": {
        "account": "google-account",
        "account_health_status": "string",
        "account_id": "4d3c8979-9dd0-439b-8d78-36fe1ab1666c",
        "account_read_only": true,
        "account_status": "string",
        "acl": "string",
        "acl_id": "string",
        "acl_status": "string",
        "acl_type": "string",
        "backend_connect_timeout": 0,
        "backend_group": "string",
        "backend_group_id": "string",
        "backend_idle_timeout": 0,
        "backend_server_port": 0,
        "brand": "Google",
        "can_delete": true,
        "can_update": true,
        "certificate": "string",
        "certificate_id": "string",
        "certificate_name": "string",
        "client_idle_timeout": 0,
        "client_request_timeout": 0,
        "cloud_env": "public",
        "cloudregion": "string",
        "cloudregion_id": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "delete_fail_reason": {
            "class": "string",
            "code": 0,
            "details": "string"
        },
        "deleted": true,
        "deleted_at": "2019-08-24T14:15:22Z",
        "description": "string",
        "egress_mbps": 0,
        "enable_http2": true,
        "environment": "string",
        "external_id": "string",
        "gzip": true,
        "health_check": "string",
        "health_check_domain": "string",
        "health_check_exp": "string",
        "health_check_fall": 0,
        "health_check_http_code": "string",
        "health_check_interval": 0,
        "health_check_req": "string",
        "health_check_rise": 0,
        "health_check_timeout": 0,
        "health_check_type": "string",
        "health_check_uri": "string",
        "http_request_rate": 0,
        "http_request_rate_per_src": 0,
        "id": "string",
        "imported_at": "2019-08-24T14:15:22Z",
        "is_default_vpc": true,
        "is_emulated": true,
        "listener_port": 0,
        "listener_type": "string",
        "loadbalancer": "string",
        "loadbalancer_id": "string",
        "manager": "google-account",
        "manager_domain": "Default",
        "manager_domain_id": "default",
        "manager_id": "string",
        "manager_project": "system",
        "manager_project_id": "4d3c8979-9dd0-439b-8d78-36fe1ab1666c",
        "metadata": {
            "property1": "string",
            "property2": "string"
        },
        "name": "string",
        "progress": 0,
        "provider": "Google",
        "redirect": "string",
        "redirect_code": 0,
        "redirect_host": "string",
        "redirect_path": "string",
        "redirect_scheme": "string",
        "region": "Default",
        "region_ext_id": "59e7bc87-a6b3-4c39-8f02-c68e8243d4e4",
        "region_external_id": "ZStack/59e7bc87-a6b3-4c39-8f02-c68e8243d4e4",
        "region_id": "default",
        "scheduler": "string",
        "send_proxy": "string",
        "source": "string",
        "status": "string",
        "sticky_session": "string",
        "sticky_session_cookie": "string",
        "sticky_session_cookie_timeout": 0,
        "sticky_session_type": "string",
        "tenant_id": "string",
        "tls_cipher_policy": "string",
        "update_fail_reason": {
            "class": "string",
            "code": 0,
            "details": "string"
        },
        "update_version": 0,
        "updated_at": "2019-08-24T14:15:22Z",
        "vpc": "string",
        "vpc_ext_id": "string",
        "vpc_id": "string",
        "xforwarded_for": true,
        "zone": "北京一区",
        "zone_ext_id": "string",
        "zone_id": "string"
    }
}