bec

package
v0.0.1-alpha Latest Latest
Warning

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

Go to latest
Published: Dec 6, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	*bce.BceClient
}

Client of BEC service is a kind of BceClient, so derived from BceClient

func NewClient

func NewClient(ak, sk, endPoint string) (*Client, error)

NewClient make the BEC service client with default configuration. Use `cli.Config.xxx` to access the config or change it to non-default value.

func (*Client) BatchCreateBlb

func (c *Client) BatchCreateBlb(args *api.BatchCreateBlbArgs) (*api.BatchCreateBlbResult, error)

BatchCreateBlb - batch create lb

PARAMS:

  • args: batch create lb args

RETURNS:

  • *api.BatchCreateBlbResult: the result of batch create lb
  • error: nil if ok otherwise the specific error

func (*Client) BatchCreateBlbMonitor

func (c *Client) BatchCreateBlbMonitor(blbId string, args *api.BatchCreateBlbMonitorArg) (*api.BatchCreateBlbMonitorResult, error)

BatchCreateBlbMonitor - batch create lb monitor

PARAMS:

  • blbId: lb id
  • args: batch create lb monitor args

RETURNS:

  • *api.BatchCreateBlbMonitorResult: the result of batch create lb nonitor
  • error: nil if ok otherwise the specific error

func (*Client) BatchDeleteBlb

func (c *Client) BatchDeleteBlb(blbIdList []string) (*api.BatchDeleteBlbResult, error)

BatchDeleteBlb - batch delete lb

PARAMS:

  • blbIdList: the list of lb

RETURNS:

  • *api.BatchDeleteBlbResult: the result of batch delete lb
  • error: nil if ok otherwise the specific error

func (*Client) BatchDeleteVmService

func (c *Client) BatchDeleteVmService(serviceIds *[]string) (*api.VmServiceBatchActionResult, error)

BatchDeleteVmService - batch delete vm service with the specific parameters

PARAMS:

  • serviceIds: service id list

RETURNS:

  • *VmServiceBatchActionResult: the result of batch delete service id list
  • error: nil if ok otherwise the specific error

func (*Client) BatchOperateVmService

func (c *Client) BatchOperateVmService(args *api.VmServiceBatchActionArgs) (*api.VmServiceBatchActionResult, error)

BatchOperateVmService - batch operate vm service with the specific parameters

PARAMS:

  • args: the arguments to batch operate vm service

RETURNS:

  • *VmServiceBatchActionResult: the result of batch operate vm service
  • error: nil if ok otherwise the specific error

func (*Client) CreateBlb

func (c *Client) CreateBlb(args *api.CreateBlbArgs) (*api.CreateBlbResult, error)

CreateBlb - create lb

PARAMS:

  • args: the lb create args

RETURNS:

  • *api.CreateBlbResult: the create lb result
  • error: nil if ok otherwise the specific error

func (*Client) CreateBlbBinding

func (c *Client) CreateBlbBinding(blbId string, args *api.CreateBlbBindingArgs) (*api.CreateBlbBindingResult, error)

CreateBlbBinding - create lb binding

PARAMS:

  • blbId: lb id
  • args: create lb binding args

RETURNS:

  • *api.CreateBlbBindingResult: the result of lb binding
  • error: nil if ok otherwise the specific error

func (*Client) CreateBlbMonitorPort

func (c *Client) CreateBlbMonitorPort(blbId string, args *api.BlbMonitorArgs) (*api.BlbMonitorResult, error)

CreateBlbMonitorPort - create lb monitor port

PARAMS:

  • blbId: lb id
  • args: create lb monitor port args

RETURNS:

  • *api.BlbMonitorResult: create lb monitor port result
  • error: nil if ok otherwise the specific error

func (*Client) CreateService

func (c *Client) CreateService(args *api.CreateServiceArgs) (*api.CreateServiceResult, error)

CreateService - create a container service with the specific parameters

PARAMS:

  • args: the arguments to create a container service

RETURNS:

  • *CreateClusterResult: the result of create a container service
  • error: nil if ok otherwise the specific error

func (*Client) CreateVmImage

func (c *Client) CreateVmImage(args *api.CreateVmImageArgs) (*api.CreateVmImageResult, error)

CreateVmImage - create a vm image

PARAMS:

  • args: the create vm image args

RETURNS:

  • *api.CreateVmImageResult: the result image
  • error: nil if ok otherwise the specific error

func (*Client) CreateVmPrivateIp

func (c *Client) CreateVmPrivateIp(vmID string, args *api.CreateVmPrivateIpForm) (*api.VmPrivateIpResult, error)

CreateVmPrivateIp - create vm private ip with the specific parameters

PARAMS:

  • vmID: vm id
  • args: the args to create vm private ip

RETURNS:

  • *VmConfigResult: the result of create vm private ip
  • error: nil if ok otherwise the specific error

func (*Client) CreateVmService

func (c *Client) CreateVmService(args *api.CreateVmServiceArgs) (*api.CreateVmServiceResult, error)

CreateCluster - create vm service with the specific parameters

PARAMS:

  • args: the arguments to create a vm service

RETURNS:

  • *CreateVmServiceResult: the result of create vm service
  • error: nil if ok otherwise the specific error

func (*Client) CreateVmServiceInstance

func (c *Client) CreateVmServiceInstance(serviceId string, args *api.CreateVmServiceArgs) (*api.CreateVmServiceResult, error)

CreateVmServiceInstance - create service vm instance with the specific parameters

PARAMS:

  • serviceId: service Id
  • args: the arguments to create service vm instance

RETURNS:

  • *CreateVmServiceResult: the result of create service instance
  • error: nil if ok otherwise the specific error

func (*Client) DeleteBlb

func (c *Client) DeleteBlb(blbId string) (*api.DeleteBlbResult, error)

DeleteBlb - delete lb

PARAMS:

  • blbId: lb id

RETURNS:

  • *api.DeleteBlbResult: delete lb result
  • error: nil if ok otherwise the specific error

func (*Client) DeleteBlbBindPod

func (c *Client) DeleteBlbBindPod(blbId string, args *api.DeleteBlbBindPodArgs) (*api.DeleteBlbBindPodResult, error)

DeleteBlbBindPod - delete lb bind pod

PARAMS:

  • blbId: lb id
  • args: delete lb bind pod args

RETURNS:

  • *api.DeleteBlbBindPodResult: the result of delete lb pod
  • error: nil if ok otherwise the specific error

func (*Client) DeleteBlbMonitorPort

func (c *Client) DeleteBlbMonitorPort(blbId string, args *[]api.Port) (*api.BlbMonitorResult, error)

DeleteBlbMonitorPort - delete lb monitor port

PARAMS:

  • blbId: lb id
  • args: delete lb monitor port args

RETURNS:

  • *api.BlbMonitorResult: delete lb monitor result
  • error: nil if ok otherwise the specific error

func (*Client) DeleteService

func (c *Client) DeleteService(serviceId string) (*api.ServiceActionResult, error)

DeleteService - delete service with the specific parameters

PARAMS:

  • serviceId: the service id

RETURNS:

  • *ServiceActionResult: the result of delete service
  • error: nil if ok otherwise the specific error

func (*Client) DeleteVmImage

func (c *Client) DeleteVmImage(args []string) (*api.VmImageOperateResult, error)

DeleteVmImage - delete a vm image

PARAMS:

  • args: the delete vm image args, spec vmId list

RETURNS:

  • *api.VmImageOperateResult: the result image delete
  • error: nil if ok otherwise the specific error

func (*Client) DeleteVmInstance

func (c *Client) DeleteVmInstance(vmID string) (*api.ActionInfoVo, error)

DeleteVmInstance - delete vm instance with the specific parameters

PARAMS:

  • vmID: vm id

RETURNS:

  • *ActionInfoVo: the result of delete vm instance
  • error: nil if ok otherwise the specific error

func (*Client) DeleteVmPrivateIp

func (c *Client) DeleteVmPrivateIp(vmID string, args *api.DeleteVmPrivateIpForm) (*api.VmPrivateIpResult, error)

DeleteVmPrivateIp - delete vm private ip with the specific parameters

PARAMS:

  • vmID: vm id
  • args: the args to delete vm private ip

RETURNS:

  • *VmPrivateIpResult: the result of delete vm private ip
  • error: nil if ok otherwise the specific error

func (*Client) DeleteVmService

func (c *Client) DeleteVmService(serviceId string) (*api.VmServiceActionResult, error)

DeleteVmService - delete a vm service with the specific parameters

PARAMS:

  • serviceId: service id

RETURNS:

  • *VmServiceActionResult: the result of delete vm service
  • error: nil if ok otherwise the specific error

func (*Client) GetBecAvailableNodeInfoVo

func (c *Client) GetBecAvailableNodeInfoVo(getType string) (*api.GetBecAvailableNodeInfoVoResult, error)

GetBecAvailableNodeInfoVo - get available node

PARAMS:

  • args: the type

RETURNS:

  • *api.GetBecAvailableNodeInfoVoResult: get available node
  • error: nil if ok otherwise the specific error

func (*Client) GetBlbBackendBindingStsList

func (c *Client) GetBlbBackendBindingStsList(blbId string, pageNo, pageSize int, keywordType, keyword string) (*api.GetBlbBackendBindingStsListResult, error)

GetBlbBackendBindingStsList - get lb backend's statefulset list

PARAMS:

  • blbId: lb id
  • keyword: the key word
  • keywordType: key word type
  • pageNo: page NO
  • pageSize: page size

RETURNS:

  • *api.GetBlbBackendBindingStsListResult: the list of sts result
  • error: nil if ok otherwise the specific error

func (*Client) GetBlbBackendPodList

func (c *Client) GetBlbBackendPodList(blbId string, pageNo, pageSize int) (*api.GetBlbBackendPodListResult, error)

GetBlbBackendPodList - get lb backend list

PARAMS:

  • blbId: lb id
  • pageNo: page NO
  • pageSize: page size

RETURNS:

  • *api.GetBlbBackendPodListResult: the result of lb backend list
  • error: nil if ok otherwise the specific error

func (*Client) GetBlbBindingPodListWithSts

func (c *Client) GetBlbBindingPodListWithSts(blbId, stsName string) (*[]api.Backends, error)

GetBlbBindingPodListWithSts - image list

PARAMS:

  • blbId: lb id
  • stsName: sts name

RETURNS:

  • *api.Backends: the list of backend
  • error: nil if ok otherwise the specific error

func (*Client) GetBlbDetail

func (c *Client) GetBlbDetail(blbId string) (*api.BlbInstanceVo, error)

GetBlbDetail - lb detail

PARAMS:

  • blbId: lb id

RETURNS:

  • *api.BlbInstanceVo: lb info
  • error: nil if ok otherwise the specific error

func (*Client) GetBlbList

func (c *Client) GetBlbList(lbType, order, orderBy, keyword, keywordType, status, region string,
	pageNo, pageSize int) (*api.GetBlbListResult, error)

GetBlbList - get lb list

PARAMS:

  • lbType: lb type
  • order: list order
  • orderBy: order by
  • keyword: the key word
  • keywordType: key word type
  • status: lb status
  • region: lb's region
  • pageNo: page NO
  • pageSize: page size

RETURNS:

  • *api.GetBlbListResult: the list of lb
  • error: nil if ok otherwise the specific error

func (*Client) GetBlbMetrics

func (c *Client) GetBlbMetrics(blbId, ipType, port, serviceProviderStr string, offsetInSeconds int, metricsType api.MetricsType) (*api.ServiceMetricsResult, error)

GetBlbMetrics - get lb metrics

PARAMS:

  • blbId: lb id
  • ipType: ip type
  • port: port
  • serviceProviderStr: service Provider
  • offsetInSeconds: offset Seconds
  • metricsType: metrics Type

RETURNS:

  • *api.ServiceMetricsResult: the list of vm images
  • error: nil if ok otherwise the specific error

func (*Client) GetBlbMonitorPortDetails

func (c *Client) GetBlbMonitorPortDetails(blbId string, protocol api.Protocol, port int) (*api.BlbMonitorArgs, error)

GetBlbMonitorPortDetails - get lb monitor port detail

PARAMS:

  • blbId: lb id
  • protocol: protocol
  • port: port

RETURNS:

  • *api.BlbMonitorArgs: lb monitor info result
  • error: nil if ok otherwise the specific error

func (*Client) GetBlbMonitorPortList

func (c *Client) GetBlbMonitorPortList(blbId string, pageNo, pageSize int) (*api.BlbMonitorListResult, error)

GetBlbMonitorPortList - get lb's monitor port list

PARAMS:

  • blbId: lb id
  • pageNo: page no
  • pageSize: page size

RETURNS:

  • *api.BlbMonitorListResult: the list of lb monitor ports
  • error: nil if ok otherwise the specific error

func (*Client) GetNodeVmInstanceList

func (c *Client) GetNodeVmInstanceList(args *api.ListRequest, region, serviceProvider, city string) (*api.GetNodeVmInstanceListResult, error)

GetNodeVmInstanceList - get node vm instance list with the specific parameters

PARAMS:

  • args: the arguments to get node vm instance list
  • region: region
  • serviceProvider: service provider
  • city: city

RETURNS:

  • *GetNodeVmInstanceListResult: the result of get node vm instance list
  • error: nil if ok otherwise the specific error

func (*Client) GetService

func (c *Client) GetService(serviceId string) (*api.ServiceDetailsVo, error)

GetService - get container service with the specific parameters

PARAMS:

  • serviceId: the service id

RETURNS:

  • *ServiceBriefVo: the result of get container service
  • error: nil if ok otherwise the specific error

func (*Client) GetServiceMetrics

func (c *Client) GetServiceMetrics(serviceId string, metricsType api.MetricsType, serviceProviderStr api.ServiceProvider, offsetInSeconds int) (*api.ServiceMetricsResult, error)

GetServiceMetrics - get service metrics with the specific parameters

PARAMS:

  • serviceId: the service id
  • metricsType: metrics Type
  • serviceProviderStr: service Provider
  • offsetInSeconds: offset Seconds

RETURNS:

  • *ServiceMetricsResult: the result of get service metrics
  • error: nil if ok otherwise the specific error

func (*Client) GetVirtualMachine

func (c *Client) GetVirtualMachine(vmID string) (*api.VmInstanceDetailsVo, error)

GetVirtualMachine - get vm with the specific parameters

PARAMS:

  • vmID: vm id

RETURNS:

  • *VmInstanceDetailsVo: the result of get vm
  • error: nil if ok otherwise the specific error

func (*Client) GetVmConfig

func (c *Client) GetVmConfig(vmID string) (*api.VmConfigResult, error)

GetVmConfig - get vm config with the specific parameters

PARAMS:

  • vmID: vm id

RETURNS:

  • *VmConfigResult: the result of get vm config
  • error: nil if ok otherwise the specific error

func (*Client) GetVmInstanceList

func (c *Client) GetVmInstanceList(args *api.ListRequest) (*api.LogicPageVmInstanceResult, error)

GetVmInstanceList - get vm list with the specific parameters

PARAMS:

  • args: the arguments to get vm list

RETURNS:

  • *LogicPageVmInstanceResult: the result of get vm list
  • error: nil if ok otherwise the specific error

func (*Client) GetVmInstanceMetrics

func (c *Client) GetVmInstanceMetrics(vmID string, serviceProvider api.ServiceProvider, offsetInSeconds int, metricsType api.MetricsType) (*api.ServiceMetricsResult, error)

GetVmInstanceMetrics - get vm metrics with the specific parameters

PARAMS:

  • vmId: vm id
  • offsetInSeconds: offset Seconds
  • serviceProvider: service provider
  • metricsType: metrics Type

RETURNS:

  • *ServiceMetricsResult: the result of get vm metrics
  • error: nil if ok otherwise the specific error

func (*Client) GetVmServiceDetail

func (c *Client) GetVmServiceDetail(serviceId string) (*api.VmServiceDetailsVo, error)

GetVmServiceDetail - get vm service detail with the specific parameters

PARAMS:

  • serviceId: vm service id

RETURNS:

  • *VmServiceDetailsVo: the result of vm service detail
  • error: nil if ok otherwise the specific error

func (*Client) GetVmServiceList

func (c *Client) GetVmServiceList(args *api.ListVmServiceArgs) (*api.ListVmServiceResult, error)

GetVmServiceList - get vm services with the specific parameters

PARAMS:

  • args: the arguments to get vm services

RETURNS:

  • *ListVmServiceResult: the result of get vm services
  • error: nil if ok otherwise the specific error

func (*Client) GetVmServiceMetrics

func (c *Client) GetVmServiceMetrics(serviceId string, metricType api.MetricsType, offsetInSeconds int, serviceProviderStr api.ServiceProvider) (*api.ServiceMetricsResult, error)

GetVmServiceMetrics - get vm service metrics with the specific parameters

PARAMS:

  • serviceId: service id
  • serviceProviderStr: service Provider
  • offsetInSeconds: offset Seconds
  • metricsType: metrics Type

RETURNS:

  • *ServiceMetricsResult: the result of get vm service metrics
  • error: nil if ok otherwise the specific error

func (*Client) ListService

func (c *Client) ListService(pageNo, pageSize int, keywordType, keyword, order, orderBy, status string) (*api.ListServiceResult, error)

ListService - list container service with the specific parameters

PARAMS:

  • pageNo: page No
  • pageSize: page Size
  • keywordType: keyword Type
  • keyword: keyword
  • order: order
  • orderBy: orderBy
  • status: status

RETURNS:

  • *ListServiceResult: the result of list container service
  • error: nil if ok otherwise the specific error

func (*Client) ListVmImage

func (c *Client) ListVmImage(args *api.ListVmImageArgs) (*api.ListVmImageResult, error)

ListVmImage - image list

PARAMS:

  • args: the vm image list args

RETURNS:

  • *api.ListVmImageResult: the list of vm images
  • error: nil if ok otherwise the specific error

func (*Client) OperateVmDeployment

func (c *Client) OperateVmDeployment(vmID string, action api.VmInstanceBatchOperateAction) (*api.OperateVmDeploymentResult, error)

OperateVmDeployment - operate vm with the specific parameters

PARAMS:

  • vmID: vm id
  • action: the arguments to operate vm

RETURNS:

  • *OperateVmDeploymentResult: the result of operate vm
  • error: nil if ok otherwise the specific error

func (*Client) ReinstallVmInstance

func (c *Client) ReinstallVmInstance(vmID string, args *api.ReinstallVmInstanceArg) (*api.ReinstallVmInstanceResult, error)

ReinstallVmInstance - reinstall vm instance with the specific parameters

PARAMS:

  • vmID: vm id
  • args: the arguments to reinstall vm instance

RETURNS:

  • *ReinstallVmInstanceResult: the result of reinstall vm instance
  • error: nil if ok otherwise the specific error

func (*Client) ServiceAction

func (c *Client) ServiceAction(serviceId string, action api.ServiceAction) (*api.ServiceActionResult, error)

ServiceAction - operate service with the specific parameters

PARAMS:

  • serviceId: the service id
  • action: operate action

RETURNS:

  • *ServiceActionResult: the result of operate service
  • error: nil if ok otherwise the specific error

func (*Client) ServiceBatchDelete

func (c *Client) ServiceBatchDelete(args *[]string) (*api.ServiceBatchOperateResult, error)

ServiceBatchDelete - batch delete service with the specific parameters

PARAMS:

  • args: the arguments to batch delete service

RETURNS:

  • *ServiceBatchOperateResult: the result of batch delete service
  • error: nil if ok otherwise the specific error

func (*Client) ServiceBatchOperate

func (c *Client) ServiceBatchOperate(args *api.ServiceBatchOperateArgs) (*api.ServiceBatchOperateResult, error)

ServiceBatchOperate - batch operate service with the specific parameters

PARAMS:

  • args: the arguments to batch operate service

RETURNS:

  • *ServiceBatchOperateResult: the result of batch operate service
  • error: nil if ok otherwise the specific error

func (*Client) UpdateBlb

func (c *Client) UpdateBlb(blbId string, args *api.UpdateBlbArgs) (*api.UpdateBlbResult, error)

UpdateBlb - update lb

PARAMS:

  • blbId: lb id
  • args: the vm image list args

RETURNS:

  • *api.UpdateBlbResult: update lb result
  • error: nil if ok otherwise the specific error

func (*Client) UpdateBlbBindPodWeight

func (c *Client) UpdateBlbBindPodWeight(blbId string, args *api.UpdateBindPodWeightArgs) (*api.UpdateBindPodWeightResult, error)

UpdateBlbBindPodWeight - update bind pod weight

PARAMS:

  • blbId: lb id
  • args: update bind pod weight args

RETURNS:

  • *api.UpdateBindPodWeightResult: the result of update bind pod weight
  • error: nil if ok otherwise the specific error

func (*Client) UpdateBlbMonitorPort

func (c *Client) UpdateBlbMonitorPort(blbId string, args *api.BlbMonitorArgs) (*api.BlbMonitorResult, error)

UpdateBlbMonitorPort - update lb monitor port

PARAMS:

  • blbId: lb id
  • args: monitor info args

RETURNS:

  • *api.BlbMonitorResult: update lb monitor result
  • error: nil if ok otherwise the specific error

func (*Client) UpdateService

func (c *Client) UpdateService(serviceId string, args *api.UpdateServiceArgs) (*api.UpdateServiceResult, error)

UpdateService - update service with the specific parameters

PARAMS:

  • serviceId: the service id
  • args: the arguments to update service

RETURNS:

  • *UpdateServiceResult: the result of update service
  • error: nil if ok otherwise the specific error

func (*Client) UpdateVmDeployment

func (c *Client) UpdateVmDeployment(vmID string, args *api.UpdateVmDeploymentArgs) (*api.UpdateVmDeploymentResult, error)

UpdateVmDeployment - update vm with the specific parameters

PARAMS:

  • vmID: vm id
  • args: the arguments to update vm

RETURNS:

  • *UpdateVmDeploymentResult: the result of update vm
  • error: nil if ok otherwise the specific error

func (*Client) UpdateVmImage

func (c *Client) UpdateVmImage(imageId string, args *api.UpdateVmImageArgs) (*api.VmImageOperateResult, error)

UpdateVmImage - update a vm image

PARAMS:

  • imageId: image id
  • args: the update vm image args

RETURNS:

  • *api.VmImageOperateResult: the result image update
  • error: nil if ok otherwise the specific error

func (*Client) UpdateVmService

func (c *Client) UpdateVmService(serviceId string, args *api.UpdateVmServiceArgs) (*api.UpdateVmServiceResult, error)

UpdateVmService - update vm service with the specific parameters

PARAMS:

  • args: the arguments to update a vm service

RETURNS:

  • *UpdateVmServiceResult: the result of update vm service
  • error: nil if ok otherwise the specific error

func (*Client) VmServiceAction

func (c *Client) VmServiceAction(serviceId string, action api.VmServiceAction) (*api.VmServiceActionResult, error)

VmServiceAction - operate vm service with the specific parameters

PARAMS:

  • serviceId: service id
  • action: operation action

RETURNS:

  • *VmServiceActionResult: the result of operate vm service
  • error: nil if ok otherwise the specific error

Directories

Path Synopsis
Package api defines all APIs supported by the BEC service of BCE.
Package api defines all APIs supported by the BEC service of BCE.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL