ulb

package
v0.21.16 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 31, 2021 License: Apache-2.0 Imports: 4 Imported by: 11

Documentation

Overview

Package ulb include resources of ucloud ulb product

See also

for detail.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AllocateBackendBatchRequest 

type AllocateBackendBatchRequest struct {
	request.CommonBase

	//
	ApiVersion *int `required:"false"`

	//
	Backends []string `required:"true"`

	//
	ULBId *string `required:"true"`

	//
	VServerId *string `required:"true"`
}

AllocateBackendBatchRequest is request schema for AllocateBackendBatch action

type AllocateBackendBatchResponse 

type AllocateBackendBatchResponse struct {
	response.CommonBase

	//
	BackendSet []BackendSet
}

AllocateBackendBatchResponse is response schema for AllocateBackendBatch action

type AllocateBackendRequest 

type AllocateBackendRequest struct {
	request.CommonBase

	// 后端实例状态开关，枚举值： 1：启用； 0：禁用 默认为启用
	Enabled *int `required:"false"`

	// rs是否为backup，默认为00：普通rs1：backup的rs
	IsBackup *int `required:"false"`

	// 所添加的后端资源服务端口，取值范围[1-65535]，默认80
	Port *int `required:"false"`

	// 所添加的后端服务器的资源实例IP，当ResourceType 为 UHybrid 时有效，且必填
	ResourceIP *string `required:"false"`

	// 所添加的后端资源的资源ID
	ResourceId *string `required:"true"`

	// 所添加的后端资源的类型，枚举值：UHost -> 云主机；UNI -> 虚拟网卡；UPM -> 物理云主机； UDHost -> 私有专区主机；UDocker -> 容器；UHybrid->混合云主机；CUBE->Cube；默认值为UHost。报文转发模式不支持UDocker、UHybrid、CUBE
	ResourceType *string `required:"true"`

	// 所添加的后端服务器所在的子网，当ResourceType 为 UHybrid 时有效，且必填
	SubnetId *string `required:"false"`

	// 负载均衡实例的ID
	ULBId *string `required:"true"`

	// 所添加的后端服务器所在的vpc，当ResourceType 为 UHybrid 时有效，且必填
	VPCId *string `required:"false"`

	// VServer实例的ID
	VServerId *string `required:"true"`

	// 所添加的后端RS权重（在加权轮询算法下有效），取值范围[0-100]，默认为1
	Weight *int `required:"false"`
}

AllocateBackendRequest is request schema for AllocateBackend action

type AllocateBackendResponse 

type AllocateBackendResponse struct {
	response.CommonBase

	// 所添加的后端资源在ULB中的对象ID，（为ULB系统中使用，与资源自身ID无关），可用于 UpdateBackendAttribute/UpdateBackendAttributeBatch/ReleaseBackend
	BackendId string
}

AllocateBackendResponse is response schema for AllocateBackend action

type BackendSet 

type BackendSet struct {

	//
	BackendId string

	//
	ResourceId string
}

BackendSet -

type BindSSLRequest added in v0.6.10 

type BindSSLRequest struct {
	request.CommonBase

	// SSL证书的Id
	SSLId *string `required:"true"`

	// 所绑定ULB实例ID
	ULBId *string `required:"true"`

	// 所绑定VServer实例ID
	VServerId *string `required:"true"`
}

BindSSLRequest is request schema for BindSSL action

type BindSSLResponse added in v0.6.10 

type BindSSLResponse struct {
	response.CommonBase
}

BindSSLResponse is response schema for BindSSL action

type CreatePolicyGroupRequest added in v0.14.3 

type CreatePolicyGroupRequest struct {
	request.CommonBase

	// 内容转发策略组名称，默认为空
	GroupName *string `required:"false"`
}

CreatePolicyGroupRequest is request schema for CreatePolicyGroup action

type CreatePolicyGroupResponse added in v0.14.3 

type CreatePolicyGroupResponse struct {
	response.CommonBase

	// 内容转发策略组的Id
	GroupId string
}

CreatePolicyGroupResponse is response schema for CreatePolicyGroup action

type CreatePolicyRequest 

type CreatePolicyRequest struct {
	request.CommonBase

	// 内容转发策略应用的后端资源实例的ID，来源于 AllocateBackend 返回的 BackendId
	BackendId []string `required:"true"`

	// 内容转发匹配字段
	Match *string `required:"true"`

	// 策略优先级，1-9999
	PolicyPriority *int `required:"false"`

	// 内容转发匹配字段的类型
	Type *string `required:"false"`

	// 需要添加内容转发策略的负载均衡实例ID
	ULBId *string `required:"true"`

	// 需要添加内容转发策略的VServer实例ID
	VServerId *string `required:"true"`
}

CreatePolicyRequest is request schema for CreatePolicy action

type CreatePolicyResponse 

type CreatePolicyResponse struct {
	response.CommonBase

	// 内容转发策略ID
	PolicyId string
}

CreatePolicyResponse is response schema for CreatePolicy action

type CreateSSLRequest added in v0.6.10 

type CreateSSLRequest struct {
	request.CommonBase

	// CA证书
	CaCert *string `required:"false"`

	// 加密证书的私钥
	PrivateKey *string `required:"false"`

	// SSL证书的完整内容，包括用户证书、加密证书的私钥、CA证书
	SSLContent *string `required:"false"`

	// SSL证书的名字，默认值为空
	SSLName *string `required:"true"`

	// 所添加的SSL证书类型，目前只支持Pem格式
	SSLType *string `required:"false"`

	// 用户的证书
	UserCert *string `required:"false"`
}

CreateSSLRequest is request schema for CreateSSL action

type CreateSSLResponse added in v0.6.10 

type CreateSSLResponse struct {
	response.CommonBase

	// SSL证书的Id
	SSLId string
}

CreateSSLResponse is response schema for CreateSSL action

type CreateULBRequest 

type CreateULBRequest struct {
	request.CommonBase

	// ULB 所属的业务组ID，如果不传则使用默认的业务组
	BusinessId *string `required:"false"`

	// 付费方式, 枚举值为: Year, 按年付费; Month, 按月付费; Dynamic, 按时付费
	ChargeType *string `required:"false"`

	// 防火墙ID，如果不传，则默认不绑定防火墙
	FirewallId *string `required:"false"`

	// 创建的ULB是否为内网模式
	InnerMode *string `required:"false"`

	// ULB 监听器类型，枚举值：RequestProxy，请求代理； PacketsTransmit ，报文转发。默认为RequestProxy
	ListenType *string `required:"false"`

	// 创建的ULB是否为外网模式，默认即为外网模式
	OuterMode *string `required:"false"`

	// 【该字段已废弃，请谨慎使用】
	PrivateIp *string `required:"false" deprecated:"true"`

	// 备注
	Remark *string `required:"false"`

	// 内网ULB 所属的子网ID，如果不传则使用默认的子网
	SubnetId *string `required:"false"`

	// 业务组
	Tag *string `required:"false"`

	// 负载均衡的名字，默认值为“ULB”
	ULBName *string `required:"false"`

	// ULB所在的VPC的ID, 如果不传则使用默认的VPC
	VPCId *string `required:"false"`
}

CreateULBRequest is request schema for CreateULB action

type CreateULBResponse 

type CreateULBResponse struct {
	response.CommonBase

	// IPv6地址Id
	IPv6AddressId string

	// 负载均衡实例的Id
	ULBId string
}

CreateULBResponse is response schema for CreateULB action

type CreateVServerRequest 

type CreateVServerRequest struct {
	request.CommonBase

	// ListenType为RequestProxy时表示空闲连接的回收时间，单位：秒，取值范围：时(0，86400]，默认值为60；ListenType为PacketsTransmit时表示连接保持的时间，单位：秒，取值范围：[60，900]，0 表示禁用连接保持
	ClientTimeout *int `required:"false"`

	// 根据MonitorType确认； 当MonitorType为Path时，此字段有意义，代表HTTP检查域名
	Domain *string `required:"false"`

	// VServer后端端口，取值范围[1-65535]；默认值为80
	FrontendPort *int `required:"false"`

	// 监听器类型，枚举值，RequestProxy ，请求代理；PacketsTransmit ，报文转发。默认为RequestProxy
	ListenType *string `required:"false"`

	// VServer负载均衡模式，枚举值：Roundrobin -> 轮询;Source -> 源地址；ConsistentHash -> 一致性哈希；SourcePort -> 源地址（计算端口）；ConsistentHashPort -> 一致性哈希（计算端口）; WeightRoundrobin -> 加权轮询; Leastconn -> 最小连接数;Backup ->主备模式。ConsistentHash，SourcePort，ConsistentHashPort 只在报文转发中使用；Leastconn只在请求代理中使用；Roundrobin、Source和WeightRoundrobin,Backup在请求代理和报文转发中使用。默认为："Roundrobin"
	Method *string `required:"false"`

	// 健康检查类型，枚举值：Port -> 端口检查；Path -> 路径检查；Ping -> Ping探测；Customize -> UDP检查请求代理型默认值为Port，其中TCP协议仅支持Port，其他协议支持Port和Path;报文转发型TCP协议仅支持Port，UDP协议支持Ping、Port和Customize，默认值为Ping
	MonitorType *string `required:"false"`

	// 根据MonitorType确认； 当MonitorType为Path时，此字段有意义，代表HTTP检查路径
	Path *string `required:"false"`

	// 根据PersistenceType确认； None和ServerInsert： 此字段无意义； UserDefined：此字段传入自定义会话保持String
	PersistenceInfo *string `required:"false"`

	// VServer会话保持方式，默认关闭会话保持。枚举值：None -> 关闭；ServerInsert -> 自动生成KEY；UserDefined -> 用户自定义KEY。
	PersistenceType *string `required:"false"`

	// VServer实例的协议，请求代理模式下有 HTTP、HTTPS、TCP，报文转发下有 TCP，UDP。默认为“HTTP"
	Protocol *string `required:"false"`

	// 根据MonitorType确认； 当MonitorType为Customize时，此字段有意义，代表UDP检查发出的请求报文
	RequestMsg *string `required:"false"`

	// 根据MonitorType确认； 当MonitorType为Customize时，此字段有意义，代表UDP检查请求应收到的响应报文
	ResponseMsg *string `required:"false"`

	// 负载均衡实例ID
	ULBId *string `required:"true"`

	// VServer实例名称，默认为"VServer"
	VServerName *string `required:"false"`
}

CreateVServerRequest is request schema for CreateVServer action

type CreateVServerResponse 

type CreateVServerResponse struct {
	response.CommonBase

	// VServer实例的Id
	VServerId string
}

CreateVServerResponse is response schema for CreateVServer action

type DeletePolicyGroupRequest added in v0.14.3 

type DeletePolicyGroupRequest struct {
	request.CommonBase

	// 内容转发策略组ID
	GroupId *string `required:"true"`
}

DeletePolicyGroupRequest is request schema for DeletePolicyGroup action

type DeletePolicyGroupResponse added in v0.14.3 

type DeletePolicyGroupResponse struct {
	response.CommonBase
}

DeletePolicyGroupResponse is response schema for DeletePolicyGroup action

type DeletePolicyRequest 

type DeletePolicyRequest struct {
	request.CommonBase

	// 【该字段已废弃，请谨慎使用】
	GroupId *string `required:"false" deprecated:"true"`

	// 内容转发策略ID
	PolicyId *string `required:"true"`

	// VServer 资源ID
	VServerId *string `required:"false"`
}

DeletePolicyRequest is request schema for DeletePolicy action

type DeletePolicyResponse 

type DeletePolicyResponse struct {
	response.CommonBase
}

DeletePolicyResponse is response schema for DeletePolicy action

type DeleteSSLRequest added in v0.6.10 

type DeleteSSLRequest struct {
	request.CommonBase

	// SSL证书的ID
	SSLId *string `required:"true"`
}

DeleteSSLRequest is request schema for DeleteSSL action

type DeleteSSLResponse added in v0.6.10 

type DeleteSSLResponse struct {
	response.CommonBase
}

DeleteSSLResponse is response schema for DeleteSSL action

type DeleteULBRequest 

type DeleteULBRequest struct {
	request.CommonBase

	// 删除ulb时是否释放绑定的EIP，false标识只解绑EIP，true表示会释放绑定的EIP，默认是false。Anycast IP 此参数无效
	ReleaseEip *bool `required:"false"`

	// 负载均衡实例的ID
	ULBId *string `required:"true"`
}

DeleteULBRequest is request schema for DeleteULB action

type DeleteULBResponse 

type DeleteULBResponse struct {
	response.CommonBase
}

DeleteULBResponse is response schema for DeleteULB action

type DeleteVServerRequest 

type DeleteVServerRequest struct {
	request.CommonBase

	// 负载均衡实例的ID
	ULBId *string `required:"true"`

	// VServer实例的ID
	VServerId *string `required:"true"`
}

DeleteVServerRequest is request schema for DeleteVServer action

type DeleteVServerResponse 

type DeleteVServerResponse struct {
	response.CommonBase
}

DeleteVServerResponse is response schema for DeleteVServer action

type DescribePolicyGroupRequest added in v0.14.3 

type DescribePolicyGroupRequest struct {
	request.CommonBase

	// 内容转发策略组ID
	GroupId *string `required:"false"`

	// 数据分页值，默认为20
	Limit *int `required:"false"`

	// 数据偏移量，默认值为0
	Offset *int `required:"false"`
}

DescribePolicyGroupRequest is request schema for DescribePolicyGroup action

type DescribePolicyGroupResponse added in v0.14.3 

type DescribePolicyGroupResponse struct {
	response.CommonBase

	// 内容转发策略组列表，具体结构见 UlbPolicyGroupSet
	DataSet []UlbPolicyGroupSet
}

DescribePolicyGroupResponse is response schema for DescribePolicyGroup action

type DescribeSSLRequest added in v0.6.10 

type DescribeSSLRequest struct {
	request.CommonBase

	// 数据分页值，默认为20
	Limit *int `required:"false"`

	// 数据偏移量，默认值为0
	Offset *int `required:"false"`

	// SSL证书的Id
	SSLId *string `required:"false"`
}

DescribeSSLRequest is request schema for DescribeSSL action

type DescribeSSLResponse added in v0.6.10 

type DescribeSSLResponse struct {
	response.CommonBase

	// SSL证书详细信息，具体结构见 ULBSSLSet
	DataSet []ULBSSLSet

	// 满足条件的SSL证书总数
	TotalCount int
}

DescribeSSLResponse is response schema for DescribeSSL action

type DescribeULBRequest 

type DescribeULBRequest struct {
	request.CommonBase

	// ULB所属的业务组ID
	BusinessId *string `required:"false"`

	// 数据分页值，默认为20
	Limit *int `required:"false"`

	// 数据偏移量，默认为0
	Offset *int `required:"false"`

	// ULB所属的子网ID
	SubnetId *string `required:"false"`

	// 负载均衡实例的Id。 若指定则返回指定的负载均衡实例的信息； 若不指定则返回当前数据中心中所有的负载均衡实例的信息
	ULBId *string `required:"false"`

	// ULB所属的VPC
	VPCId *string `required:"false"`
}

DescribeULBRequest is request schema for DescribeULB action

type DescribeULBResponse 

type DescribeULBResponse struct {
	response.CommonBase

	// ULB列表，每项参数详见 ULBSet
	DataSet []ULBSet

	// 满足条件的ULB总数
	TotalCount int
}

DescribeULBResponse is response schema for DescribeULB action

type DescribeULBSimpleRequest added in v0.17.2 

type DescribeULBSimpleRequest struct {
	request.CommonBase

	// ULB所属的业务组ID
	BusinessId *string `required:"false"`

	// 数据分页值，默认为10000
	Limit *int `required:"false"`

	// 数据偏移量，默认为0
	Offset *int `required:"false"`

	// ULB所属的子网ID
	SubnetId *string `required:"false"`

	// 负载均衡实例的Id。 若指定则返回指定的负载均衡实例的信息； 若不指定则返回当前数据中心中所有的负载均衡实例的信息
	ULBId *string `required:"false"`

	// ULB所属的VPC
	VPCId *string `required:"false"`
}

DescribeULBSimpleRequest is request schema for DescribeULBSimple action

type DescribeULBSimpleResponse added in v0.17.2 

type DescribeULBSimpleResponse struct {
	response.CommonBase

	// ULB列表，每项参数详见 ULBSimpleSet
	DataSet []ULBSimpleSet

	// 满足条件的ULB总数
	TotalCount int
}

DescribeULBSimpleResponse is response schema for DescribeULBSimple action

type DescribeVServerRequest 

type DescribeVServerRequest struct {
	request.CommonBase

	// 数据分页值
	Limit *int `required:"false"`

	// 数据偏移量
	Offset *int `required:"false"`

	// 负载均衡实例的Id
	ULBId *string `required:"true"`

	// VServer实例的Id；若指定则返回指定的VServer实例的信息； 若不指定则返回当前负载均衡实例下所有VServer的信息
	VServerId *string `required:"false"`
}

DescribeVServerRequest is request schema for DescribeVServer action

type DescribeVServerResponse 

type DescribeVServerResponse struct {
	response.CommonBase

	// VServer列表，每项参数详见 ULBVServerSet
	DataSet []ULBVServerSet

	// 满足条件的VServer总数
	TotalCount int
}

DescribeVServerResponse is response schema for DescribeVServer action

type FirewallSet added in v0.17.0 

type FirewallSet struct {

	// 防火墙ID
	FirewallId string

	// 防火墙名称
	FirewallName string
}

FirewallSet - ulb防火墙信息

type LoggerSet added in v0.17.0 

type LoggerSet struct {

	// ulb日志上传的bucket
	BucketName string

	// 上传到bucket使用的token的tokenid
	TokenID string

	// bucket的token名称
	TokenName string
}

LoggerSet - ulb日志信息

type PolicyBackendSet 

type PolicyBackendSet struct {

	// 所添加的后端资源在ULB中的对象ID，（为ULB系统中使用，与资源自身ID无关
	BackendId string

	// 后端资源的对象ID
	ObjectId string

	// 所添加的后端资源服务端口
	Port int

	// 后端资源的内网IP
	PrivateIP string

	// 后端资源的实例名称
	ResourceName string

	// 所添加的后端资源的类型，枚举值：UHost -> 云主机；UPM -> 物理云主机； UDHost -> 私有专区主机；UDocker -> 容器；UHybrid->混合云主机；CUBE->Cube；UNI -> 虚拟网卡
	ResourceType string

	// 如果资源绑定了弹性网卡，则展示弹性网卡的资源ID
	SubResourceId string

	// 如果资源绑定了弹性网卡，则展示弹性网卡的资源名称
	SubResourceName string

	// "UNI"或者为空
	SubResourceType string
}

PolicyBackendSet - 内容转发下rs详细信息

type ReleaseBackendRequest 

type ReleaseBackendRequest struct {
	request.CommonBase

	// 后端资源实例的ID(ULB后端ID，非资源自身ID)
	BackendId *string `required:"true"`

	// 负载均衡实例的ID
	ULBId *string `required:"true"`
}

ReleaseBackendRequest is request schema for ReleaseBackend action

type ReleaseBackendResponse 

type ReleaseBackendResponse struct {
	response.CommonBase
}

ReleaseBackendResponse is response schema for ReleaseBackend action

type SSLBindedTargetSet added in v0.6.11 

type SSLBindedTargetSet struct {

	// VServer 所属的ULB实例的资源ID
	ULBId string

	// ULB实例的名称
	ULBName string

	// SSL证书绑定到的VServer的资源ID
	VServerId string

	// 对应的VServer的名字
	VServerName string
}

SSLBindedTargetSet - DescribeSSL

type ULBBackendSet 

type ULBBackendSet struct {

	// 后端资源实例的Id
	BackendId string

	// 后端提供服务的实例启用与否，枚举值：0 禁用 1 启用
	Enabled int

	// 是否为backup，只有当vserver的Backup属性为1时才会有此字段，说明：0：主rs1：备rs
	IsBackup int

	// 后端提供服务的端口
	Port int

	// 后端提供服务的内网IP
	PrivateIP string

	// 资源实例的资源Id
	ResourceId string

	// 资源实例的资源名称
	ResourceName string

	// 资源实例的类型
	ResourceType string

	// 后端提供服务的实例运行状态，枚举值：0健康检查健康状态 1 健康检查异常
	Status int

	// 资源绑定的虚拟网卡实例的资源Id
	SubResourceId string

	// 资源绑定的虚拟网卡实例的资源名称
	SubResourceName string

	// 资源绑定的虚拟网卡实例的类型
	SubResourceType string

	// 后端提供服务的资源所在的子网的ID
	SubnetId string

	//
	Weight int
}

ULBBackendSet - DescribeULB

type ULBClient 

type ULBClient struct {
	*ucloud.Client
}

ULBClient is the client of ULB

func NewClient 

func NewClient(config *ucloud.Config, credential *auth.Credential) *ULBClient

NewClient will return a instance of ULBClient

func (*ULBClient) AllocateBackend 

func (c *ULBClient) AllocateBackend(req *AllocateBackendRequest) (*AllocateBackendResponse, error)

API: AllocateBackend

添加ULB后端资源实例

func (*ULBClient) AllocateBackendBatch 

func (c *ULBClient) AllocateBackendBatch(req *AllocateBackendBatchRequest) (*AllocateBackendBatchResponse, error)

API: AllocateBackendBatch

func (*ULBClient) BindSSL added in v0.6.10 

func (c *ULBClient) BindSSL(req *BindSSLRequest) (*BindSSLResponse, error)

API: BindSSL

将SSL证书绑定到VServer

func (*ULBClient) CreatePolicy 

func (c *ULBClient) CreatePolicy(req *CreatePolicyRequest) (*CreatePolicyResponse, error)

API: CreatePolicy

创建VServer内容转发策略

func (*ULBClient) CreatePolicyGroup added in v0.14.3 

func (c *ULBClient) CreatePolicyGroup(req *CreatePolicyGroupRequest) (*CreatePolicyGroupResponse, error)

API: CreatePolicyGroup

创建内容转发策略组

func (*ULBClient) CreateSSL added in v0.6.10 

func (c *ULBClient) CreateSSL(req *CreateSSLRequest) (*CreateSSLResponse, error)

API: CreateSSL

创建SSL证书，可以把整个 Pem 证书内容传过来，或者把证书、私钥、CA证书分别传过来

func (*ULBClient) CreateULB 

func (c *ULBClient) CreateULB(req *CreateULBRequest) (*CreateULBResponse, error)

API: CreateULB

创建负载均衡实例，可以选择内网或者外网

func (*ULBClient) CreateVServer 

func (c *ULBClient) CreateVServer(req *CreateVServerRequest) (*CreateVServerResponse, error)

API: CreateVServer

创建VServer实例，定义监听的协议和端口以及负载均衡算法

func (*ULBClient) DeletePolicy 

func (c *ULBClient) DeletePolicy(req *DeletePolicyRequest) (*DeletePolicyResponse, error)

API: DeletePolicy

删除内容转发策略

func (*ULBClient) DeletePolicyGroup added in v0.14.3 

func (c *ULBClient) DeletePolicyGroup(req *DeletePolicyGroupRequest) (*DeletePolicyGroupResponse, error)

API: DeletePolicyGroup

删除内容转发策略组

func (*ULBClient) DeleteSSL added in v0.6.10 

func (c *ULBClient) DeleteSSL(req *DeleteSSLRequest) (*DeleteSSLResponse, error)

API: DeleteSSL

删除SSL证书

func (*ULBClient) DeleteULB 

func (c *ULBClient) DeleteULB(req *DeleteULBRequest) (*DeleteULBResponse, error)

API: DeleteULB

删除负载均衡实例

func (*ULBClient) DeleteVServer 

func (c *ULBClient) DeleteVServer(req *DeleteVServerRequest) (*DeleteVServerResponse, error)

API: DeleteVServer

删除VServer实例

func (*ULBClient) DescribePolicyGroup added in v0.14.3 

func (c *ULBClient) DescribePolicyGroup(req *DescribePolicyGroupRequest) (*DescribePolicyGroupResponse, error)

API: DescribePolicyGroup

获取内容转发组详细信息

func (*ULBClient) DescribeSSL added in v0.6.10 

func (c *ULBClient) DescribeSSL(req *DescribeSSLRequest) (*DescribeSSLResponse, error)

API: DescribeSSL

获取SSL证书信息

func (*ULBClient) DescribeULB 

func (c *ULBClient) DescribeULB(req *DescribeULBRequest) (*DescribeULBResponse, error)

API: DescribeULB

获取ULB详细信息

func (*ULBClient) DescribeULBSimple added in v0.17.2 

func (c *ULBClient) DescribeULBSimple(req *DescribeULBSimpleRequest) (*DescribeULBSimpleResponse, error)

API: DescribeULBSimple

获取ULB信息

func (*ULBClient) DescribeVServer 

func (c *ULBClient) DescribeVServer(req *DescribeVServerRequest) (*DescribeVServerResponse, error)

API: DescribeVServer

获取ULB下的VServer的详细信息

func (*ULBClient) NewAllocateBackendBatchRequest 

func (c *ULBClient) NewAllocateBackendBatchRequest() *AllocateBackendBatchRequest

NewAllocateBackendBatchRequest will create request of AllocateBackendBatch action.

func (*ULBClient) NewAllocateBackendRequest 

func (c *ULBClient) NewAllocateBackendRequest() *AllocateBackendRequest

NewAllocateBackendRequest will create request of AllocateBackend action.

func (*ULBClient) NewBindSSLRequest added in v0.6.10 

func (c *ULBClient) NewBindSSLRequest() *BindSSLRequest

NewBindSSLRequest will create request of BindSSL action.

func (*ULBClient) NewCreatePolicyGroupRequest added in v0.14.3 

func (c *ULBClient) NewCreatePolicyGroupRequest() *CreatePolicyGroupRequest

NewCreatePolicyGroupRequest will create request of CreatePolicyGroup action.

func (*ULBClient) NewCreatePolicyRequest 

func (c *ULBClient) NewCreatePolicyRequest() *CreatePolicyRequest

NewCreatePolicyRequest will create request of CreatePolicy action.

func (*ULBClient) NewCreateSSLRequest added in v0.6.10 

func (c *ULBClient) NewCreateSSLRequest() *CreateSSLRequest

NewCreateSSLRequest will create request of CreateSSL action.

func (*ULBClient) NewCreateULBRequest 

func (c *ULBClient) NewCreateULBRequest() *CreateULBRequest

NewCreateULBRequest will create request of CreateULB action.

func (*ULBClient) NewCreateVServerRequest 

func (c *ULBClient) NewCreateVServerRequest() *CreateVServerRequest

NewCreateVServerRequest will create request of CreateVServer action.

func (*ULBClient) NewDeletePolicyGroupRequest added in v0.14.3 

func (c *ULBClient) NewDeletePolicyGroupRequest() *DeletePolicyGroupRequest

NewDeletePolicyGroupRequest will create request of DeletePolicyGroup action.

func (*ULBClient) NewDeletePolicyRequest 

func (c *ULBClient) NewDeletePolicyRequest() *DeletePolicyRequest

NewDeletePolicyRequest will create request of DeletePolicy action.

func (*ULBClient) NewDeleteSSLRequest added in v0.6.10 

func (c *ULBClient) NewDeleteSSLRequest() *DeleteSSLRequest

NewDeleteSSLRequest will create request of DeleteSSL action.

func (*ULBClient) NewDeleteULBRequest 

func (c *ULBClient) NewDeleteULBRequest() *DeleteULBRequest

NewDeleteULBRequest will create request of DeleteULB action.

func (*ULBClient) NewDeleteVServerRequest 

func (c *ULBClient) NewDeleteVServerRequest() *DeleteVServerRequest

NewDeleteVServerRequest will create request of DeleteVServer action.

func (*ULBClient) NewDescribePolicyGroupRequest added in v0.14.3 

func (c *ULBClient) NewDescribePolicyGroupRequest() *DescribePolicyGroupRequest

NewDescribePolicyGroupRequest will create request of DescribePolicyGroup action.

func (*ULBClient) NewDescribeSSLRequest added in v0.6.10 

func (c *ULBClient) NewDescribeSSLRequest() *DescribeSSLRequest

NewDescribeSSLRequest will create request of DescribeSSL action.

func (*ULBClient) NewDescribeULBRequest 

func (c *ULBClient) NewDescribeULBRequest() *DescribeULBRequest

NewDescribeULBRequest will create request of DescribeULB action.

func (*ULBClient) NewDescribeULBSimpleRequest added in v0.17.2 

func (c *ULBClient) NewDescribeULBSimpleRequest() *DescribeULBSimpleRequest

NewDescribeULBSimpleRequest will create request of DescribeULBSimple action.

func (*ULBClient) NewDescribeVServerRequest 

func (c *ULBClient) NewDescribeVServerRequest() *DescribeVServerRequest

NewDescribeVServerRequest will create request of DescribeVServer action.

func (*ULBClient) NewReleaseBackendRequest 

func (c *ULBClient) NewReleaseBackendRequest() *ReleaseBackendRequest

NewReleaseBackendRequest will create request of ReleaseBackend action.

func (*ULBClient) NewUnbindSSLRequest added in v0.6.10 

func (c *ULBClient) NewUnbindSSLRequest() *UnbindSSLRequest

NewUnbindSSLRequest will create request of UnbindSSL action.

func (*ULBClient) NewUpdateBackendAttributeRequest 

func (c *ULBClient) NewUpdateBackendAttributeRequest() *UpdateBackendAttributeRequest

NewUpdateBackendAttributeRequest will create request of UpdateBackendAttribute action.

func (*ULBClient) NewUpdatePolicyGroupAttributeRequest added in v0.14.3 

func (c *ULBClient) NewUpdatePolicyGroupAttributeRequest() *UpdatePolicyGroupAttributeRequest

NewUpdatePolicyGroupAttributeRequest will create request of UpdatePolicyGroupAttribute action.

func (*ULBClient) NewUpdatePolicyRequest 

func (c *ULBClient) NewUpdatePolicyRequest() *UpdatePolicyRequest

NewUpdatePolicyRequest will create request of UpdatePolicy action.

func (*ULBClient) NewUpdateULBAttributeRequest 

func (c *ULBClient) NewUpdateULBAttributeRequest() *UpdateULBAttributeRequest

NewUpdateULBAttributeRequest will create request of UpdateULBAttribute action.

func (*ULBClient) NewUpdateVServerAttributeRequest 

func (c *ULBClient) NewUpdateVServerAttributeRequest() *UpdateVServerAttributeRequest

NewUpdateVServerAttributeRequest will create request of UpdateVServerAttribute action.

func (*ULBClient) ReleaseBackend 

func (c *ULBClient) ReleaseBackend(req *ReleaseBackendRequest) (*ReleaseBackendResponse, error)

API: ReleaseBackend

从VServer释放后端资源实例

func (*ULBClient) UnbindSSL added in v0.6.10 

func (c *ULBClient) UnbindSSL(req *UnbindSSLRequest) (*UnbindSSLResponse, error)

API: UnbindSSL

从VServer解绑SSL证书

func (*ULBClient) UpdateBackendAttribute 

func (c *ULBClient) UpdateBackendAttribute(req *UpdateBackendAttributeRequest) (*UpdateBackendAttributeResponse, error)

API: UpdateBackendAttribute

更新ULB后端资源实例(服务节点)属性

func (*ULBClient) UpdatePolicy 

func (c *ULBClient) UpdatePolicy(req *UpdatePolicyRequest) (*UpdatePolicyResponse, error)

API: UpdatePolicy

更新内容转发规则，包括转发规则后的服务节点

func (*ULBClient) UpdatePolicyGroupAttribute added in v0.14.3 

func (c *ULBClient) UpdatePolicyGroupAttribute(req *UpdatePolicyGroupAttributeRequest) (*UpdatePolicyGroupAttributeResponse, error)

API: UpdatePolicyGroupAttribute

更新内容转发策略组属性

func (*ULBClient) UpdateULBAttribute 

func (c *ULBClient) UpdateULBAttribute(req *UpdateULBAttributeRequest) (*UpdateULBAttributeResponse, error)

API: UpdateULBAttribute

更新ULB名字业务组备注等属性字段

func (*ULBClient) UpdateVServerAttribute 

func (c *ULBClient) UpdateVServerAttribute(req *UpdateVServerAttributeRequest) (*UpdateVServerAttributeResponse, error)

API: UpdateVServerAttribute

更新VServer实例属性

type ULBIPSet 

type ULBIPSet struct {

	// 弹性IP的带宽值（暂未对外开放）
	Bandwidth int

	// 弹性IP的带宽类型，枚举值：1 表示是共享带宽，0 普通带宽类型（暂未对外开放）
	BandwidthType int

	// 弹性IP地址
	EIP string

	// 弹性IP的ID
	EIPId string

	// 弹性IP的运营商信息，枚举值为：  Bgp：BGP IP International：国际IP
	OperatorName string
}

ULBIPSet - DescribeULB

type ULBPolicySet 

type ULBPolicySet struct {

	// 内容转发下rs的详细信息，参考PolicyBackendSet
	BackendSet []PolicyBackendSet

	// 内容转发匹配字段;默认内容转发类型下为空。
	Match string

	// 内容转发Id，默认内容转发类型下为空。
	PolicyId string

	// 内容转发优先级，范围[1,9999]，数字越大优先级越高。默认内容转发规则下为0。
	PolicyPriority int

	// 内容类型，枚举值：Custom -> 客户自定义；Default -> 默认内容转发
	PolicyType string

	// 默认内容转发类型下返回当前rs总数
	TotalCount int

	// 内容转发匹配字段的类型，枚举值：Domain -> 域名；Path -> 路径； 默认内容转发类型下为空
	Type string

	// 所属VServerId
	VServerId string
}

ULBPolicySet - 内容转发详细列表

type ULBSSLSet 

type ULBSSLSet struct {

	// SSL证书绑定到的对象
	BindedTargetSet []SSLBindedTargetSet

	// SSL证书的创建时间
	CreateTime int

	// SSL证书的HASH值
	HashValue string

	// SSL证书的内容
	SSLContent string

	// SSL证书的Id
	SSLId string

	// SSL证书的名字
	SSLName string

	// SSL证书类型，暂时只有 Pem 一种类型
	SSLType string
}

ULBSSLSet - DescribeSSL

type ULBSet 

type ULBSet struct {

	// 带宽
	Bandwidth int

	// 带宽类型，枚举值为： 0，非共享带宽； 1，共享带宽
	BandwidthType int

	// ULB 所属的业务组ID
	BusinessId string

	// ULB的创建时间，格式为Unix Timestamp
	CreateTime int

	// ULB是否开启日志功能。0，关闭；1，开启
	EnableLog int

	// ULB的到期时间，格式为Unix Timestamp
	ExpireTime int `deprecated:"true"`

	// 防火墙信息，具体结构见下方 FirewallSet
	FirewallSet []FirewallSet

	// ULB的详细信息列表，具体结构见下方 ULBIPSet
	IPSet []ULBIPSet

	// ULB ip类型，枚举值：IPv6 / IPv4 （内部测试，暂未对外开放）
	IPVersion string

	// ULB 监听器类型，枚举值：RequestProxy，请求代理； PacketsTransmit ，报文转发；Comprehensive，兼容型；Pending，未定型
	ListenType string

	// 日志功能相关信息，仅当EnableLog为true时会返回，具体结构见下方 LoggerSet
	LogSet LoggerSet

	// 负载均衡的资源名称
	Name string

	// ULB的内网IP，当ULBType为OuterMode时，该值为空
	PrivateIP string

	// 负载均衡的备注
	Remark string

	// ULB的详细信息列表（废弃）
	Resource []string `deprecated:"true"`

	// ULB 为 InnerMode 时，ULB 所属的子网ID，默认为空
	SubnetId string

	// 负载均衡的业务组名称
	Tag string

	// 负载均衡的资源ID
	ULBId string

	//
	ULBName string `deprecated:"true"`

	// ULB 的类型
	ULBType string

	// ULB所在的VPC的ID
	VPCId string

	// 负载均衡实例中存在的VServer实例列表，具体结构见下方 ULBVServerSet
	VServerSet []ULBVServerSet
}

ULBSet - DescribeULB

type ULBSimpleSet added in v0.17.2 

type ULBSimpleSet struct {

	// 带宽
	Bandwidth int

	// 带宽类型，枚举值为： 0，非共享带宽； 1，共享带宽
	BandwidthType int

	// ULB 所属的业务组ID
	BusinessId string

	// ULB的创建时间，格式为Unix Timestamp
	CreateTime int

	// ULB是否开启日志功能。0，关闭；1，开启
	EnableLog int

	// 防火墙信息，具体结构见下方 FirewallSet
	FirewallSet []FirewallSet

	// ULB的详细信息列表，具体结构见下方 ULBIPSet
	IPSet []ULBIPSet

	// ULB提供服务的IP类型。枚举值，“IPv4”,"IPv6"。默认为“IPv4”
	IPVersion string

	// ULB 监听器类型，枚举值：RequestProxy，请求代理； PacketsTransmit ，报文转发；Comprehensive，兼容型；Pending，未定型
	ListenType string

	// 日志功能相关信息，仅当EnableLog为true时会返回，具体结构见下方 LoggerSet
	LogSet LoggerSet

	// 负载均衡的资源名称
	Name string

	// ULB的内网IP，当ULBType为OuterMode时，该值为空
	PrivateIP string

	// 负载均衡的备注
	Remark string

	// ULB 为 InnerMode 时，ULB 所属的子网ID
	SubnetId string

	// 负载均衡的业务组名称
	Tag string

	// 负载均衡的资源ID
	ULBId string

	// ULB 的类型（InnerMode or OuterMode）
	ULBType string

	// ULB所在的VPC的ID
	VPCId string

	// ulb下vserver数量
	VServerCount int
}

ULBSimpleSet - ulb简明信息

type ULBVServerSet 

type ULBVServerSet struct {

	// 后端资源信息列表，具体结构见下方 ULBBackendSet
	BackendSet []ULBBackendSet

	// 空闲连接的回收时间，单位：秒。
	ClientTimeout int

	// 根据MonitorType确认； 当MonitorType为Port时，此字段无意义。当MonitorType为Path时，代表HTTP检查域名
	Domain string

	// VServer服务端口
	FrontendPort int

	// 监听器类型，枚举值为: RequestProxy -> 请求代理；PacketsTransmit -> 报文转发
	ListenType string

	// VServer负载均衡的模式，枚举值：Roundrobin -> 轮询;Source -> 源地址；ConsistentHash -> 一致性哈希；SourcePort -> 源地址（计算端口）；ConsistentHashPort -> 一致性哈希（计算端口）。
	Method string

	// 健康检查类型，枚举值：Port -> 端口检查；Path -> 路径检查；Ping -> Ping探测， Customize -> UDP检查请求代理型默认值为Port，其中TCP协议仅支持Port，其他协议支持Port和Path; 报文转发型TCP协议仅支持Port，UDP协议支持Ping、Port和Customize
	MonitorType string

	// 根据MonitorType确认； 当MonitorType为Port时，此字段无意义。当MonitorType为Path时，代表HTTP检查路径
	Path string

	// 根据PersistenceType确定： None或ServerInsert，此字段为空； UserDefined，此字段展示用户自定义会话string。
	PersistenceInfo string

	// VServer会话保持方式。枚举值为： None -> 关闭会话保持； ServerInsert -> 自动生成； UserDefined -> 用户自定义。
	PersistenceType string

	// 内容转发信息列表，具体结构见下方 ULBPolicySet
	PolicySet []ULBPolicySet

	// VServer实例的协议。 枚举值为：HTTP，TCP，UDP，HTTPS。
	Protocol string

	// 根据MonitorType确认； 当MonitorType为Customize时，此字段有意义，代表UDP检查发出的请求报文
	RequestMsg string

	// 根据MonitorType确认； 当MonitorType为Customize时，此字段有意义，代表UDP检查请求应收到的响应报文
	ResponseMsg string

	// VServer绑定的SSL证书信息，具体结构见下方 ULBSSLSet。
	SSLSet []ULBSSLSet

	// VServer的运行状态。枚举值： 0 -> rs全部运行正常;1 -> rs全部运行异常；2 -> rs部分运行异常。
	Status int

	// VServer实例的Id
	VServerId string

	// VServer实例的名字
	VServerName string
}

ULBVServerSet - DescribeULB

type UlbPolicyBackendSet added in v0.14.3 

type UlbPolicyBackendSet struct {

	// 后端资源实例的ID
	BackendId string

	// 后端资源实例的服务端口
	Port int

	// 后端资源实例的内网IP
	PrivateIP string
}

UlbPolicyBackendSet - DescribePolicyGroup

type UlbPolicyGroupSet added in v0.14.3 

type UlbPolicyGroupSet struct {

	// 内容转发策略组ID
	GroupId string

	// 内容转发策略组名称
	GroupName string

	// 内容转发策略组详细信息，具体结构见 UlbPolicySet
	PolicySet []UlbPolicySet
}

UlbPolicyGroupSet - DescribePolicyGroup

type UlbPolicySet added in v0.14.3 

type UlbPolicySet struct {

	// 内容转发策略组ID所应用的后端资源列表，具体结构见 UlbPolicyBackendSet
	BackendSet []UlbPolicyBackendSet

	// 内容转发匹配字段
	Match string

	// 内容转发策略组ID
	PolicyId string

	// 内容转发匹配字段的类型，当前只支持按域名转发。枚举值为： Domain，按域名转发
	Type string

	// 内容转发策略组ID应用的VServer实例的ID
	VServerId string
}

UlbPolicySet - DescribePolicyGroup

type UnbindSSLRequest added in v0.6.10 

type UnbindSSLRequest struct {
	request.CommonBase

	// SSL证书的Id
	SSLId *string `required:"true"`

	// 所绑定ULB实例ID
	ULBId *string `required:"true"`

	// 所绑定VServer实例ID
	VServerId *string `required:"true"`
}

UnbindSSLRequest is request schema for UnbindSSL action

type UnbindSSLResponse added in v0.6.10 

type UnbindSSLResponse struct {
	response.CommonBase
}

UnbindSSLResponse is response schema for UnbindSSL action

type UpdateBackendAttributeRequest 

type UpdateBackendAttributeRequest struct {
	request.CommonBase

	// 后端资源实例的ID(ULB后端ID，非资源自身ID)
	BackendId *string `required:"true"`

	// 后端实例状态开关
	Enabled *int `required:"false"`

	// 是否为backup0：主rs1：备rs默认为0
	IsBackup *int `required:"false"`

	// 后端资源服务端口，取值范围[1-65535]
	Port *int `required:"false"`

	// 负载均衡资源ID
	ULBId *string `required:"true"`

	// 所添加的后端RS权重（在加权轮询算法下有效），取值范围[0-100]，默认为1
	Weight *int `required:"false"`
}

UpdateBackendAttributeRequest is request schema for UpdateBackendAttribute action

type UpdateBackendAttributeResponse 

type UpdateBackendAttributeResponse struct {
	response.CommonBase
}

UpdateBackendAttributeResponse is response schema for UpdateBackendAttribute action

type UpdatePolicyGroupAttributeRequest added in v0.14.3 

type UpdatePolicyGroupAttributeRequest struct {
	request.CommonBase

	// 内容转发策略组ID
	GroupId *string `required:"true"`

	// 修改策略转发组名称
	GroupName *string `required:"false"`
}

UpdatePolicyGroupAttributeRequest is request schema for UpdatePolicyGroupAttribute action

type UpdatePolicyGroupAttributeResponse added in v0.14.3 

type UpdatePolicyGroupAttributeResponse struct {
	response.CommonBase
}

UpdatePolicyGroupAttributeResponse is response schema for UpdatePolicyGroupAttribute action

type UpdatePolicyRequest 

type UpdatePolicyRequest struct {
	request.CommonBase

	// 内容转发策略应用的后端资源实例的ID，来源于 AllocateBackend 返回的 BackendId，不传表示更新转发节点为空
	BackendId []string `required:"false"`

	// 内容转发匹配字段
	Match *string `required:"true"`

	// 转发规则的ID，当Type为Default时，可以不传或为空
	PolicyId *string `required:"false"`

	// 内容转发匹配字段的类型，枚举值：Domain -> 域名转发规则；Path -> 路径转发规则；Default -> 默认转发规则，不传默认值Domain
	Type *string `required:"false"`

	// 需要添加内容转发策略的负载均衡实例ID
	ULBId *string `required:"true"`

	// 需要添加内容转发策略的VServer实例ID，只支持请求代理模式下，HTTP或HTTPS协议的VServer
	VServerId *string `required:"true"`
}

UpdatePolicyRequest is request schema for UpdatePolicy action

type UpdatePolicyResponse 

type UpdatePolicyResponse struct {
	response.CommonBase

	// 【该字段已废弃，请谨慎使用】
	PolicyId string `deprecated:"true"`
}

UpdatePolicyResponse is response schema for UpdatePolicy action

type UpdateULBAttributeRequest 

type UpdateULBAttributeRequest struct {
	request.CommonBase

	// 名字
	Name *string `required:"false"`

	// 备注
	Remark *string `required:"false"`

	// 业务
	Tag *string `required:"false"`

	// ULB资源ID
	ULBId *string `required:"true"`
}

UpdateULBAttributeRequest is request schema for UpdateULBAttribute action

type UpdateULBAttributeResponse 

type UpdateULBAttributeResponse struct {
	response.CommonBase
}

UpdateULBAttributeResponse is response schema for UpdateULBAttribute action

type UpdateVServerAttributeRequest 

type UpdateVServerAttributeRequest struct {
	request.CommonBase

	// 请求代理的VServer下表示空闲连接的回收时间，单位：秒，取值范围：时(0，86400]，默认值为60；报文转发的VServer下表示回话保持的时间，单位：秒，取值范围：[60，900]，0 表示禁用连接保持
	ClientTimeout *int `required:"false"`

	// MonitorType 为 Path 时指定健康检查发送请求时HTTP HEADER 里的域名
	Domain *string `required:"false"`

	// VServer负载均衡模式，枚举值：Roundrobin -> 轮询;Source -> 源地址；ConsistentHash -> 一致性哈希；SourcePort -> 源地址（计算端口）；ConsistentHashPort -> 一致性哈希（计算端口）; WeightRoundrobin -> 加权轮询; Leastconn -> 最小连接数；Backup -> 主备模式。ConsistentHash，SourcePort，ConsistentHashPort 只在报文转发中使用；Leastconn只在请求代理中使用；Roundrobin、Source和WeightRoundrobin,Backup在请求代理和报文转发中使用。默认为："Roundrobin"
	Method *string `required:"false"`

	// 健康检查类型，枚举值：Port -> 端口检查；Path -> 路径检查；Ping -> Ping探测，Customize -> UDP检查请求代理型默认值为Port，其中TCP协议仅支持Port，其他协议支持Port和Path;报文转发型TCP协议仅支持Port，UDP协议支持Ping、Port和Customize，默认值为Ping
	MonitorType *string `required:"false"`

	// MonitorType 为 Path 时指定健康检查发送请求时的路径，默认为 /
	Path *string `required:"false"`

	// 根据PersistenceType确定: None或ServerInsert, 此字段无意义; UserDefined, 则此字段传入用户自定义会话保持String. 若无此字段则不做修改
	PersistenceInfo *string `required:"false"`

	// VServer会话保持模式，若无此字段则不做修改。枚举值：None：关闭；ServerInsert：自动生成KEY；UserDefined：用户自定义KEY。
	PersistenceType *string `required:"false"`

	// 【该字段已废弃，请谨慎使用】
	Protocol *string `required:"false" deprecated:"true"`

	// 根据MonitorType确认； 当MonitorType为Customize时，此字段有意义，代表UDP检查发出的请求报文
	RequestMsg *string `required:"false"`

	// 根据MonitorType确认； 当MonitorType为Customize时，此字段有意义，代表UDP检查请求应收到的响应报文
	ResponseMsg *string `required:"false"`

	// 负载均衡实例ID
	ULBId *string `required:"true"`

	// VServer实例ID
	VServerId *string `required:"true"`

	// VServer实例名称，若无此字段则不做修改
	VServerName *string `required:"false"`
}

UpdateVServerAttributeRequest is request schema for UpdateVServerAttribute action

type UpdateVServerAttributeResponse 

type UpdateVServerAttributeResponse struct {
	response.CommonBase
}

UpdateVServerAttributeResponse is response schema for UpdateVServerAttribute action

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.