client

Documentation

Index

• Constants
• type EIP
• type NetworkInterface
  • func FromCreateResp(in *ecs.CreateNetworkInterfaceResponse) *NetworkInterface
  • func FromDescribeResp(in *ecs.NetworkInterfaceSet) *NetworkInterface
• type OpenAPI
  • func New(c credential.Client, readOnly, mutating flowcontrol.RateLimiter) (*OpenAPI, error)
  • func NewAliyun(ak, sk, regionID, credentialPath, secretNamespace, secretName string) (*OpenAPI, error)
  • func (a *OpenAPI) AddCommonBandwidthPackageIP(eipID, packageID string) error
  • func (a *OpenAPI) AllocateEIPAddress(bandwidth, chargeType, isp string) (*vpc.AllocateEipAddressResponse, error)
  • func (a *OpenAPI) AssignIpv6Addresses(ctx context.Context, eniID string, count int, idempotentKey string) ([]net.IP, error)
  • func (a *OpenAPI) AssignPrivateIPAddress(ctx context.Context, eniID string, count int, idempotentKey string) ([]net.IP, error)
  • func (a *OpenAPI) AssociateEIPAddress(eipID, eniID, privateIP string) error
  • func (a *OpenAPI) AttachNetworkInterface(ctx context.Context, eniID, instanceID, trunkENIID string) error
  • func (a *OpenAPI) CreateNetworkInterface(ctx context.Context, trunk bool, vSwitch string, securityGroups []string, ...) (*NetworkInterface, error)
  • func (a *OpenAPI) DeleteNetworkInterface(ctx context.Context, eniID string) error
  • func (a *OpenAPI) DescribeInstanceTypes(ctx context.Context, types []string) ([]ecs.InstanceType, error)
  • func (a *OpenAPI) DescribeNetworkInterface(ctx context.Context, vpcID string, eniID []string, instanceID string, ...) ([]*NetworkInterface, error)
  • func (a *OpenAPI) DetachNetworkInterface(ctx context.Context, eniID, instanceID, trunkENIID string) error
  • func (a *OpenAPI) ModifyNetworkInterfaceAttribute(ctx context.Context, eniID string, securityGroupIDs []string) error
  • func (a *OpenAPI) ReleaseEIPAddress(eipID string) error
  • func (a *OpenAPI) RemoveCommonBandwidthPackageIP(eipID, packageID string) error
  • func (a *OpenAPI) UnAssignIpv6Addresses(ctx context.Context, eniID string, ips []net.IP) error
  • func (a *OpenAPI) UnAssignPrivateIPAddresses(ctx context.Context, eniID string, ips []net.IP) error
  • func (a *OpenAPI) UnAssociateEIPAddress(eipID, eniID, eniIP string) error
  • func (a *OpenAPI) WaitForNetworkInterface(ctx context.Context, eniID string, status string, backoff wait.Backoff, ...) (*NetworkInterface, error)
• type VSwitch

Constants

const (
	LogFieldAPI              = "api"
	LogFieldRequestID        = "requestID"
	LogFieldInstanceID       = "instanceID"
	LogFieldSecondaryIPCount = "secondaryIPCount"
	LogFieldENIID            = "eni"
	LogFieldEIPID            = "eip"
	LogFieldPrivateIP        = "privateIP"
	LogFieldVSwitchID        = "vSwitchID"
	LogFieldSgID             = "securityGroupID"
	LogFieldResourceGroupID  = "resourceGroupID"
)

log fields

const (
	ENIStatusInUse     string = "InUse"
	ENIStatusAvailable string = "Available"
)

status for eni

const (
	ENITypePrimary   string = "Primary"
	ENITypeSecondary string = "Secondary"
	ENITypeTrunk     string = "Trunk"
	ENITypeMember    string = "Member"
)

const EIPInstanceTypeNetworkInterface = "NetworkInterface"

Types

type EIP

type EIP interface {
	AllocateEIPAddress(bandwidth, chargeType, isp string) (*vpc.AllocateEipAddressResponse, error)
	AssociateEIPAddress(eipID, eniID, privateIP string) error
	UnAssociateEIPAddress(eipID, eniID, eniIP string) error
	ReleaseEIPAddress(eipID string) error
	AddCommonBandwidthPackageIP(eipID, packageID string) error
}

type NetworkInterface

type NetworkInterface struct {
	Status             string             `json:"status,omitempty"`
	MacAddress         string             `json:"mac_address,omitempty"`
	NetworkInterfaceID string             `json:"network_interface_id,omitempty"`
	VSwitchID          string             `json:"v_switch_id,omitempty"`
	PrivateIPAddress   string             `json:"private_ip_address,omitempty"`
	PrivateIPSets      []ecs.PrivateIpSet `json:"private_ip_sets"`
	ZoneID             string             `json:"zone_id,omitempty"`
	SecurityGroupIDs   []string           `json:"security_group_ids,omitempty"`
	ResourceGroupID    string             `json:"resource_group_id,omitempty"`
	IPv6Set            []ecs.Ipv6Set      `json:"ipv6_set,omitempty"`
	Tags               []ecs.Tag          `json:"tags,omitempty"`

	// fields for DescribeNetworkInterface
	Type                    string `json:"type,omitempty"`
	InstanceID              string `json:"instance_id,omitempty"`
	TrunkNetworkInterfaceID string `json:"trunk_network_interface_id,omitempty"`
	DeviceIndex             int    `json:"device_index,omitempty"`
	CreationTime            string `json:"creation_time,omitempty"`
}

NetworkInterface openAPI result for ecs.CreateNetworkInterfaceResponse and ecs.NetworkInterfaceSet

func FromCreateResp

func FromCreateResp(in *ecs.CreateNetworkInterfaceResponse) *NetworkInterface

func FromDescribeResp

func FromDescribeResp(in *ecs.NetworkInterfaceSet) *NetworkInterface

type OpenAPI

type OpenAPI struct {
	ClientSet credential.Client

	ReadOnlyRateLimiter flowcontrol.RateLimiter
	MutatingRateLimiter flowcontrol.RateLimiter
}

func New

func New(c credential.Client, readOnly, mutating flowcontrol.RateLimiter) (*OpenAPI, error)

func NewAliyun

func NewAliyun(ak, sk, regionID, credentialPath, secretNamespace, secretName string) (*OpenAPI, error)

func (*OpenAPI) AddCommonBandwidthPackageIP

func (a *OpenAPI) AddCommonBandwidthPackageIP(eipID, packageID string) error

AddCommonBandwidthPackageIP add EIP to bandwidth package

func (*OpenAPI) AllocateEIPAddress

func (a *OpenAPI) AllocateEIPAddress(bandwidth, chargeType, isp string) (*vpc.AllocateEipAddressResponse, error)

AllocateEIPAddress create EIP

func (*OpenAPI) AssignIpv6Addresses

func (a *OpenAPI) AssignIpv6Addresses(ctx context.Context, eniID string, count int, idempotentKey string) ([]net.IP, error)

AssignIpv6Addresses assign ipv6 address

func (*OpenAPI) AssignPrivateIPAddress

func (a *OpenAPI) AssignPrivateIPAddress(ctx context.Context, eniID string, count int, idempotentKey string) ([]net.IP, error)

AssignPrivateIPAddress assign secondary ip

func (*OpenAPI) AssociateEIPAddress

func (a *OpenAPI) AssociateEIPAddress(eipID, eniID, privateIP string) error

AssociateEIPAddress bind eip to ip

func (*OpenAPI) AttachNetworkInterface

func (a *OpenAPI) AttachNetworkInterface(ctx context.Context, eniID, instanceID, trunkENIID string) error

AttachNetworkInterface attach eni

func (*OpenAPI) CreateNetworkInterface

func (a *OpenAPI) CreateNetworkInterface(ctx context.Context, trunk bool, vSwitch string, securityGroups []string, resourceGroupID string, ipCount, ipv6Count int, eniTags map[string]string) (*NetworkInterface, error)

CreateNetworkInterface instanceType Secondary Trunk

func (*OpenAPI) DeleteNetworkInterface

func (a *OpenAPI) DeleteNetworkInterface(ctx context.Context, eniID string) error

DeleteNetworkInterface del eni by id

func (*OpenAPI) DescribeInstanceTypes

func (a *OpenAPI) DescribeInstanceTypes(ctx context.Context, types []string) ([]ecs.InstanceType, error)

func (*OpenAPI) DescribeNetworkInterface

func (a *OpenAPI) DescribeNetworkInterface(ctx context.Context, vpcID string, eniID []string, instanceID string, instanceType string, status string, tags map[string]string) ([]*NetworkInterface, error)

DescribeNetworkInterface list eni

func (*OpenAPI) DetachNetworkInterface

func (a *OpenAPI) DetachNetworkInterface(ctx context.Context, eniID, instanceID, trunkENIID string) error

DetachNetworkInterface detach eni

func (*OpenAPI) ModifyNetworkInterfaceAttribute

func (a *OpenAPI) ModifyNetworkInterfaceAttribute(ctx context.Context, eniID string, securityGroupIDs []string) error

func (*OpenAPI) ReleaseEIPAddress

func (a *OpenAPI) ReleaseEIPAddress(eipID string) error

ReleaseEIPAddress delete EIP

func (*OpenAPI) RemoveCommonBandwidthPackageIP

func (a *OpenAPI) RemoveCommonBandwidthPackageIP(eipID, packageID string) error

RemoveCommonBandwidthPackageIP remove EIP from bandwidth package

func (*OpenAPI) UnAssignIpv6Addresses

func (a *OpenAPI) UnAssignIpv6Addresses(ctx context.Context, eniID string, ips []net.IP) error

UnAssignIpv6Addresses remove ip from eni return ok if 1. eni is released 2. ip is already released 3. release success

func (*OpenAPI) UnAssignPrivateIPAddresses

func (a *OpenAPI) UnAssignPrivateIPAddresses(ctx context.Context, eniID string, ips []net.IP) error

UnAssignPrivateIPAddresses remove ip from eni return ok if 1. eni is released 2. ip is already released 3. release success for primaryIP err is InvalidIp.IpUnassigned

func (*OpenAPI) UnAssociateEIPAddress

func (a *OpenAPI) UnAssociateEIPAddress(eipID, eniID, eniIP string) error

UnAssociateEIPAddress un-bind eip

func (*OpenAPI) WaitForNetworkInterface

func (a *OpenAPI) WaitForNetworkInterface(ctx context.Context, eniID string, status string, backoff wait.Backoff, ignoreNotExist bool) (*NetworkInterface, error)

WaitForNetworkInterface wait status of eni

type VSwitch

type VSwitch interface {
	DescribeVSwitchByID(ctx context.Context, vSwitchID string) (*vpc.VSwitch, error)
}