api

package
v0.9.272 Latest Latest
Warning

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

 Go to latest Published: Jul 21, 2026 License: Apache-2.0 Imports: 3 Imported by: 1

Documentation

Overview

* Copyright 2025 Baidu, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software distributed under the * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, * either express or implied. See the License for the specific language governing permissions * and limitations under the License.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AttachTags 

func AttachTags(cli bce.Client, body *TagsOperationRequest) error

AttachTags -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • error: the return error if any occurs

func DeleteHpas 

func DeleteHpas(cli bce.Client, body *DeleteHpasReq) error

DeleteHpas -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • error: the return error if any occurs

func DetachHpasVolume added in v0.9.265 

func DetachHpasVolume(cli bce.Client, body *DetachHpasVolumeReq) error

func DetachTags 

func DetachTags(cli bce.Client, body *TagsOperationRequest) error

DetachTags -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • error: the return error if any occurs

func ModifyHpasJumbo added in v0.9.263 

func ModifyHpasJumbo(cli bce.Client, body *ModifyJumboReq) error

func ModifyInstancesAttribute added in v0.9.222 

func ModifyInstancesAttribute(cli bce.Client, body *ModifyInstancesAttributeReq) error

ModifyInstancesAttribute -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • error: the return error if any occurs

func ModifyPasswordHpas 

func ModifyPasswordHpas(cli bce.Client, body *ModifyPasswordHpasReq) error

ModifyPasswordHpas -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • error: the return error if any occurs

func RebootHpas 

func RebootHpas(cli bce.Client, body *RebootHpasReq) error

RebootHpas -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • error: the return error if any occurs

func ResetHpas 

func ResetHpas(cli bce.Client, body *ResetHpasReq) error

ResetHpas -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • error: the return error if any occurs

func StartHpas 

func StartHpas(cli bce.Client, body *StartHpasReq) error

StartHpas -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • error: the return error if any occurs

func StopHpas 

func StopHpas(cli bce.Client, body *StopHpasReq) error

StopHpas -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • error: the return error if any occurs

Types

type AssignIpv4Req added in v0.9.221 

type AssignIpv4Req struct {
	HpasId                  string   `json:"hpasId"`
	PrivateIps              []string `json:"privateIps,omitempty"`
	SecondaryPrivateIpCount int      `json:"secondaryPrivateIpCount,omitempty"`
}

type AssignIpv4Resp added in v0.9.221 

type AssignIpv4Resp struct {
	RequestId  string   `json:"requestId"`
	PrivateIps []string `json:"privateIps"`
}

func AssignPrivateIpAddresses added in v0.9.221 

func AssignPrivateIpAddresses(cli bce.Client, body *AssignIpv4Req) (
	*AssignIpv4Resp, error)

AssignPrivateIpAddresses -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • *api.EdpResultRespAssignIpv4Resp:
  • error: the return error if any occurs

type AssignIpv6Req added in v0.9.221 

type AssignIpv6Req struct {
	HpasId           string   `json:"hpasId"`
	Ipv6Addresses    []string `json:"ipv6Addresses,omitempty"`
	Ipv6AddressCount int      `json:"ipv6AddressCount,omitempty"`
	Reboot           bool     `json:"reboot,omitempty"`
}

type AssignIpv6Resp added in v0.9.221 

type AssignIpv6Resp struct {
	RequestId     string   `json:"requestId"`
	Ipv6Addresses []string `json:"ipv6Addresses"`
}

func AssignIpv6Addresses added in v0.9.221 

func AssignIpv6Addresses(cli bce.Client, body *AssignIpv6Req) (
	*AssignIpv6Resp, error)

AssignIpv6Addresses -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • *api.EdpResultRespAssignIpv6Resp:
  • error: the return error if any occurs

type AttachHpasVolumeReq added in v0.9.265 

type AttachHpasVolumeReq struct {
	HpasId    string   `json:"hpasId,omitempty"`
	VolumeIds []string `json:"volumeIds,omitempty"`
}

type AttachHpasVolumeResp added in v0.9.265 

type AttachHpasVolumeResp struct {
	FailedVolumeIds []string `json:"failedVolumeIds,omitempty"`
}

func AttachHpasVolume added in v0.9.265 

func AttachHpasVolume(cli bce.Client, body *AttachHpasVolumeReq) (*AttachHpasVolumeResp, error)

type BaseMarkerV3Req 

type BaseMarkerV3Req struct {
	Marker  string `json:"marker,omitempty"`
	MaxKeys int    `json:"maxKeys,omitempty"`
}

type BaseV3Resp added in v0.9.221 

type BaseV3Resp struct {
	RequestId *string `json:"requestId"`
}

func AttachSecurityGroups added in v0.9.231 

func AttachSecurityGroups(cli bce.Client, body *SecurityGroupsReq) (*BaseV3Resp, error)

AttachSecurityGroups - 加入安全组

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • error: the return error if any occurs

func DeleteImages added in v0.9.222 

func DeleteImages(cli bce.Client, body *DeleteImagesReq) (*BaseV3Resp, error)

DeleteImages - 删除自定义镜像

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • *api.BaseV3Resp:
  • error: the return error if any occurs

func DetachSecurityGroups added in v0.9.231 

func DetachSecurityGroups(cli bce.Client, body *SecurityGroupsReq) (*BaseV3Resp, error)

DetachSecurityGroups - 移除安全组

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • error: the return error if any occurs

func ModifyImageAttribute added in v0.9.222 

func ModifyImageAttribute(cli bce.Client, body *ModifyImageAttributeReq) (*BaseV3Resp, error)

ModifyImageAttribute - 修改自定义镜像

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • *api.BaseV3Resp:
  • error: the return error if any occurs

func ModifyInstanceVpc added in v0.9.231 

func ModifyInstanceVpc(cli bce.Client, body *ModifyInstanceVpcRequest) (*BaseV3Resp, error)

ModifyInstanceVpc -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • error: the return error if any occurs

func ModifyInstancesSubnet added in v0.9.231 

func ModifyInstancesSubnet(cli bce.Client, body *ModifyInstancesSubnetRequest) (*BaseV3Resp, error)

ModifyInstancesSubnet -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • error: the return error if any occurs

func ModifyReservedHpasName added in v0.9.250 

func ModifyReservedHpasName(cli bce.Client, body *ModifyReservedHpasNameReq) (*BaseV3Resp, error)

ModifyReservedHpasName

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • *api.BaseV3Resp:
  • error: the return error if any occurs

func ReplaceSecurityGroups added in v0.9.231 

func ReplaceSecurityGroups(cli bce.Client, body *SecurityGroupsReq) (*BaseV3Resp, error)

ReplaceSecurityGroups - 变更安全组

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • error: the return error if any occurs

func UnAssignIpv6Addresses added in v0.9.221 

func UnAssignIpv6Addresses(cli bce.Client, body *UnAssignIpv6Req) (*BaseV3Resp, error)

UnAssignIpv6Addresses -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • *api.EdpResultRespVoid:
  • error: the return error if any occurs

func UnAssignPrivateIpAddresses added in v0.9.221 

func UnAssignPrivateIpAddresses(cli bce.Client, body *UnAssignIpv4Req) (*BaseV3Resp, error)

UnAssignPrivateIpAddresses -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • *api.EdpResultRespVoid:
  • error: the return error if any occurs

type BillingModel 

type BillingModel struct {
	ChargeType          string `json:"chargeType,omitempty"`
	Period              int32  `json:"period,omitempty"`
	PeriodUnit          string `json:"periodUnit,omitempty"`
	AutoRenew           bool   `json:"autoRenew,omitempty"`
	AutoRenewPeriodUnit string `json:"autoRenewPeriodUnit,omitempty"`
	AutoRenewPeriod     int32  `json:"autoRenewPeriod,omitempty"`
	SpotPriceLimit      string `json:"spotPriceLimit,omitempty"`
	SpotStrategy        string `json:"spotStrategy,omitempty"`
}

type CancelImagesCopyReq added in v0.9.271 

type CancelImagesCopyReq struct {
	ImageIds []string `json:"imageIds"`
}

type CopyImagesReq added in v0.9.271 

type CopyImagesReq struct {
	ImageId           string                 `json:"imageId"`
	DestinationImages []DestinationImageInfo `json:"destinationImages"`
}

type CopyImagesResp added in v0.9.271 

type CopyImagesResp struct {
	RequestId         string                   `json:"requestId"`
	DestinationImages []DestinationImageResult `json:"destinationImages"`
}

func CancelImagesCopy added in v0.9.271 

func CancelImagesCopy(cli bce.Client, body *CancelImagesCopyReq) (*CopyImagesResp, error)

CancelImagesCopy - Cancels HPAS image copies in the current region.

PARAMS:

  • cli: the client agent which can perform sending request
  • body: destination image IDs to cancel

RETURNS:

  • *api.CopyImagesResp: per-image cancellation results
  • error: the return error if any occurs

func CopyImages added in v0.9.271 

func CopyImages(cli bce.Client, body *CopyImagesReq) (*CopyImagesResp, error)

CopyImages - Copies an HPAS image to one or more destination regions.

PARAMS:

  • cli: the client agent which can perform sending request
  • body: source image and destination image information

RETURNS:

  • *api.CopyImagesResp: per-destination acceptance results
  • error: the return error if any occurs

type CreateCombinedCouponReq added in v0.9.241 

type CreateCombinedCouponReq struct {
	Name                       string `json:"name,omitempty"`
	PurchaseNum                int    `json:"purchaseNum,omitempty"`
	AutoRenew                  bool   `json:"autoRenew,omitempty"`
	AutoRenewPeriod            int    `json:"autoRenewPeriod,omitempty"`
	AutoRenewPeriodUnit        string `json:"autoRenewPeriodUnit,omitempty"`
	ReservedInstancePeriod     int    `json:"reservedInstancePeriod,omitempty"`
	ReservedInstancePeriodUnit string `json:"reservedInstancePeriodUnit,omitempty"`
}

type CreateHpasReq 

type CreateHpasReq struct {
	AppType             string                   `json:"appType,omitempty"`
	AppPerformanceLevel string                   `json:"appPerformanceLevel,omitempty"`
	Name                string                   `json:"name,omitempty"`
	ApplicationName     string                   `json:"applicationName,omitempty"`
	AutoSeqSuffix       bool                     `json:"autoSeqSuffix,omitempty"`
	Description         string                   `json:"description,omitempty"`
	PurchaseNum         int                      `json:"purchaseNum,omitempty"`
	ZoneName            string                   `json:"zoneName,omitempty"`
	ImageId             string                   `json:"imageId,omitempty"`
	SubnetId            string                   `json:"subnetId,omitempty"`
	Password            string                   `json:"password,omitempty"`
	KeypairId           string                   `json:"keypairId,omitempty"`
	EhcClusterId        string                   `json:"ehcClusterId,omitempty"`
	SecurityGroupType   string                   `json:"securityGroupType,omitempty"`
	SecurityGroupIds    []string                 `json:"securityGroupIds,omitempty"`
	InternalIps         []string                 `json:"internalIps,omitempty"`
	BillingModel        BillingModel             `json:"billingModel,omitempty"`
	Tags                []TagModel               `json:"tags,omitempty"`
	UserData            string                   `json:"userData,omitempty"`
	ReservedInstance    *CreateCombinedCouponReq `json:"reservedInstance,omitempty"`
	RootDiskSizeInGb    int                      `json:"rootDiskSizeInGb,omitempty"`
	RootDiskStorageType string                   `json:"rootDiskStorageType,omitempty"`
	EnableJumboFrame    bool                     `json:"enableJumboFrame,omitempty"`
	DataVolumes         []DataVolume             `json:"dataVolumes,omitempty"`
}

type CreateHpasResp 

type CreateHpasResp struct {
	OrderId       string   `json:"orderId"`
	HpasIds       []string `json:"hpasIds"`
	CouponHpasIds []string `json:"couponHpasIds"`
}

func CreateHpas 

func CreateHpas(cli bce.Client, body *CreateHpasReq) (*CreateHpasResp, error)

CreateHpas -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • *api.CreateHpasResp:
  • error: the return error if any occurs

type CreateImageReq added in v0.9.222 

type CreateImageReq struct {
	HpasId    string `json:"hpasId"`
	ImageName string `json:"imageName"`
}

type CreateImageResp added in v0.9.222 

type CreateImageResp struct {
	RequestId *string `json:"requestId"`
	ImageId   *string `json:"imageId"`
}

func CreateImage added in v0.9.222 

func CreateImage(cli bce.Client, body *CreateImageReq) (*CreateImageResp, error)

CreateImage - 创建自定义镜像接口

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • *api.DescribeHpasImageResp:
  • error: the return error if any occurs

type CreateReservedHpasReq added in v0.9.216 

type CreateReservedHpasReq struct {
	Name                string       `json:"name,omitempty"`
	ZoneName            string       `json:"zoneName,omitempty"`
	AppType             string       `json:"appType,omitempty"`
	AppPerformanceLevel string       `json:"appPerformanceLevel,omitempty"`
	BillingModel        BillingModel `json:"billingModel,omitempty"`
	PurchaseNum         int          `json:"purchaseNum,omitempty"`
	EhcClusterId        string       `json:"ehcClusterId,omitempty"`
	Tags                []TagModel   `json:"tags,omitempty"`
}

type CreateReservedHpasResp added in v0.9.216 

type CreateReservedHpasResp struct {
	OrderId         string   `json:"orderId,omitempty"`
	ReservedHpasIds []string `json:"reservedHpasIds,omitempty"`
}

func CreateReservedHpas added in v0.9.216 

func CreateReservedHpas(cli bce.Client, body *CreateReservedHpasReq) (*CreateReservedHpasResp, error)

CreateReservedHpas -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • *api.CreateReservedHpasResp:
  • error: the return error if any occurs

type DataVolume added in v0.9.269 

type DataVolume struct {
	VolumeType     string `json:"volumeType,omitempty"`
	VolumeSizeInGb int    `json:"volumeSizeInGiB,omitempty"`
	VolumeCount    int    `json:"volumeCount,omitempty"`
	SnapshotId     string `json:"snapshotId,omitempty"`
	EncryptKeyId   string `json:"encryptKeyId,omitempty"`
	ExtraIops      int    `json:"extraIops,omitempty"`
}

DataVolume 数据盘配置

type DeleteHpasReq 

type DeleteHpasReq struct {
	HpasIds      []string `json:"hpasIds"`
	DeleteVolume bool     `json:"deleteVolume,omitempty"`
}

type DeleteImagesReq added in v0.9.222 

type DeleteImagesReq struct {
	ImageIds []string `json:"imageIds"`
}

type DescribeHpasImageReq added in v0.9.222 

type DescribeHpasImageReq struct {
	Marker    string `json:"marker"`
	MaxKeys   int    `json:"maxKeys"`
	ImageType string `json:"imageType"`
}

type DescribeHpasImageResp 

type DescribeHpasImageResp struct {
	RequestId   string          `json:"requestId"`
	IsTruncated bool            `json:"isTruncated"`
	Marker      string          `json:"marker"`
	MaxKeys     int32           `json:"maxKeys"`
	NextMarker  string          `json:"nextMarker"`
	Images      []ImageResponse `json:"images"`
}

func ImageList 

func ImageList(cli bce.Client, body *DescribeHpasImageReq) (*DescribeHpasImageResp, error)

ImageList - 查询镜像接口

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • *api.DescribeHpasImageResp:
  • error: the return error if any occurs

type DescribeHpasSpecsReq added in v0.9.239 

type DescribeHpasSpecsReq struct {
	ZoneName            string `json:"zoneName,omitempty"`
	AppType             string `json:"appType,omitempty"`
	AppPerformanceLevel string `json:"appPerformanceLevel,omitempty"`
	IsCoupon            bool   `json:"isCoupon,omitempty"`
}

type DescribeHpasSpecsResp added in v0.9.239 

type DescribeHpasSpecsResp struct {
	RequestId string     `json:"requestId,omitempty"`
	HpasSpecs []HpasSpec `json:"hpasSpecs,omitempty"`
}

func DescribeHpasSpecs added in v0.9.239 

func DescribeHpasSpecs(cli bce.Client, body *DescribeHpasSpecsReq) (*DescribeHpasSpecsResp, error)

type DescribeHpasVncUrlReq added in v0.9.229 

type DescribeHpasVncUrlReq struct {
	HpasId string `json:"hpasId"`
}

type DescribeHpasVncUrlResp added in v0.9.229 

type DescribeHpasVncUrlResp struct {
	VncUrl string `json:"vncUrl"`
}

func DescribeHpasVncUrl added in v0.9.229 

func DescribeHpasVncUrl(cli bce.Client, body *DescribeHpasVncUrlReq) (*DescribeHpasVncUrlResp, error)

type DescribeInstanceInventoryQuantityReq added in v0.9.234 

type DescribeInstanceInventoryQuantityReq struct {
	AppType             string `json:"appType"`
	AppPerformanceLevel string `json:"appPerformanceLevel"`
	ZoneName            string `json:"zoneName"`
	EhcClusterId        string `json:"ehcClusterId,omitempty"`
}

type DescribeInstanceInventoryQuantityResp added in v0.9.234 

type DescribeInstanceInventoryQuantityResp struct {
	InventoryQuantity int `json:"inventoryQuantity"`
}

func DescribeInstanceInventoryQuantity added in v0.9.234 

func DescribeInstanceInventoryQuantity(cli bce.Client, body *DescribeInstanceInventoryQuantityReq) (*DescribeInstanceInventoryQuantityResp, error)

type DestinationImageInfo added in v0.9.271 

type DestinationImageInfo struct {
	DestinationImageName string `json:"destinationImageName"`
	DestinationRegion    string `json:"destinationRegion"`
}

type DestinationImageResult added in v0.9.271 

type DestinationImageResult struct {
	DestinationRegion  string `json:"destinationRegion"`
	DestinationImageId string `json:"destinationImageId"`
	Status             bool   `json:"status"`
	ErrMsg             string `json:"errMsg,omitempty"`
}

type DetachHpasVolumeReq added in v0.9.265 

type DetachHpasVolumeReq struct {
	VolumeIds []string `json:"volumeIds,omitempty"`
}

type HpasReservedResponse added in v0.9.216 

type HpasReservedResponse struct {
	ReservedHpasId      string        `json:"reservedHpasId"`
	Name                string        `json:"name"`
	ZoneName            string        `json:"zoneName"`
	AppType             string        `json:"appType"`
	OfferingType        string        `json:"offeringType"`
	Status              string        `json:"status"`
	ReservedHpasPeriod  int           `json:"reservedHpasPeriod"`
	AppPerformanceLevel string        `json:"appPerformanceLevel"`
	CreateTime          string        `json:"createTime"`
	ExpireTime          string        `json:"expireTime"`
	Tags                []TagResponse `json:"tags"`
	HpasId              string        `json:"hpasId"`
	HpasName            string        `json:"hpasName"`
	DeductInstance      bool          `json:"deductInstance,omitempty"`
	EhcClusterId        string        `json:"ehcClusterId"`
	EhcClusterName      string        `json:"ehcClusterName"`
}

type HpasResponse 

type HpasResponse struct {
	HpasId              string        `json:"hpasId"`
	Name                string        `json:"name"`
	ZoneName            string        `json:"zoneName"`
	Status              string        `json:"status"`
	AppType             string        `json:"appType"`
	AppPerformanceLevel string        `json:"appPerformanceLevel"`
	ChargeType          string        `json:"chargeType"`
	VpcId               string        `json:"vpcId"`
	VpcName             string        `json:"vpcName"`
	VpcCidr             string        `json:"vpcCidr"`
	InternalIp          string        `json:"internalIp"`
	SubnetId            string        `json:"subnetId"`
	SubnetName          string        `json:"subnetName"`
	EhcClusterId        string        `json:"ehcClusterId"`
	EhcClusterName      string        `json:"ehcClusterName"`
	ImageId             string        `json:"imageId"`
	ImageName           string        `json:"imageName"`
	CreateTime          string        `json:"createTime"`
	Tags                []TagResponse `json:"tags"`
	RdmaNicTopo         []RdmaNicTopo `json:"rdmaNicTopo"`
	NicInfo             []NicInfo     `json:"nicInfo"`
	AppImageFamily      string        `json:"appImageFamily"`
	RdmaUnitID          string        `json:"rdmaUnitID"`
	RdmaPodName         string        `json:"rdmaPodName"`
	KeypairId           string        `json:"keypairId"`
	KeypairName         string        `json:"keypairName"`
	UserData            string        `json:"userData"`
	VolumeInfo          []VolumeInfo  `json:"volumeInfo"`
	EnableJumboFrame    bool          `json:"enableJumboFrame"`
	SupportJumboFrame   bool          `json:"supportJumboFrame"`
}

type HpasSpec added in v0.9.239 

type HpasSpec struct {
	AppType             string `json:"appType,omitempty"`
	Description         string `json:"description,omitempty"`
	Name                string `json:"name,omitempty"`
	AppPerformanceLevel string `json:"appPerformanceLevel,omitempty"`
	ChargeType          string `json:"chargeType,omitempty"`
	AppImageFamily      string `json:"appImageFamily,omitempty"`
	ZoneName            string `json:"zoneName,omitempty"`
	EniQuota            int    `json:"eniQuota,omitempty"`
	EriQuota            int    `json:"eriQuota,omitempty"`
	EphemeralDiskInGb   int    `json:"ephemeralDiskInGb,omitempty"`
	EphemeralDiskCount  int    `json:"ephemeralDiskCount,omitempty"`
	EphemeralDiskType   string `json:"ephemeralDiskType,omitempty"`
	NicIpv4Quota        int    `json:"nicIpv4Quota,omitempty"`
	NicIpv6Quota        int    `json:"nicIpv6Quota,omitempty"`
	CpuCount            int    `json:"cpuCount,omitempty"`
	MemoryCapacityInGB  int    `json:"memoryCapacityInGB,omitempty"`
	GpuCardCount        int    `json:"gpuCardCount,omitempty"`
	EnableJumboFrame    bool   `json:"enableJumboFrame,omitempty"`
	CdsDataCount        int    `json:"cdsDataCount,omitempty"`
	NeedEhcClusterId    bool   `json:"needEhcClusterId,omitempty"`
}

type ImageResponse 

type ImageResponse struct {
	ImageId          string   `json:"imageId"`
	Name             string   `json:"name"`
	ImageType        string   `json:"imageType"`
	ImageStatus      string   `json:"imageStatus"`
	CreateTime       string   `json:"createTime"`
	SupportedAppType []string `json:"supportedAppType"`
	ImageSizeInGB    int      `json:"imageSizeInGB"`
	MinDiskInGB      int      `json:"minDiskInGB"`
}

type Ipv4Info added in v0.9.221 

type Ipv4Info struct {
	PrivateIP string `json:"privateIp"`
	Primary   bool   `json:"primary"`
}

type Ipv6Info added in v0.9.221 

type Ipv6Info struct {
	Ipv6Address string `json:"ipv6Address"`
}

type ListHpasByMakerReq added in v0.9.221 

type ListHpasByMakerReq struct {
	HpasIds      []string `json:"hpasIds,omitempty"`
	Name         string   `json:"name,omitempty"`
	ZoneName     string   `json:"zoneName,omitempty"`
	HpasStatus   string   `json:"hpasStatus,omitempty"`
	AppType      string   `json:"appType,omitempty"`
	ShowRdmaTopo bool     `json:"showRdmaTopo,omitempty"`
	Marker       string   `json:"marker,omitempty"`
	MaxKeys      int      `json:"maxKeys,omitempty"`
	VpcId        string   `json:"vpcId,omitempty"`
	PrivateIps   []string `json:"privateIps,omitempty"`
	EhcClusterId string   `json:"ehcClusterId,omitempty"`
}

type ListHpasByMakerResp added in v0.9.221 

type ListHpasByMakerResp struct {
	Marker      string         `json:"marker"`
	IsTruncated bool           `json:"isTruncated"`
	NextMarker  string         `json:"nextMarker"`
	MaxKeys     int            `json:"maxKeys"`
	Hpass       []HpasResponse `json:"hpass"`
}

func ListHpasByMaker added in v0.9.221 

func ListHpasByMaker(cli bce.Client, body *ListHpasByMakerReq) (
	*ListHpasByMakerResp, error)

ListHpasByMaker -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • *api.ListHpasByPageResp:
  • error: the return error if any occurs

type ListHpasByPageResp 

type ListHpasByPageResp struct {
	OrderBy    string         `json:"orderBy"`
	Order      string         `json:"order"`
	PageNo     int            `json:"pageNo"`
	PageSize   int            `json:"pageSize"`
	TotalCount int64          `json:"totalCount"`
	Hpass      []HpasResponse `json:"hpass"`
}

func ListHpas 

func ListHpas(cli bce.Client, body *ListHpasPageReq) (
	*ListHpasByPageResp, error)

ListHpas -

PARAMS:

  • cli: the client agent which can perform sending request
  • showRdmaTopo:
  • body:

RETURNS:

  • *api.ListHpasByPageResp:
  • error: the return error if any occurs

type ListHpasPageReq 

type ListHpasPageReq struct {
	HpasIds      []string `json:"hpasIds,omitempty"`
	Name         string   `json:"name,omitempty"`
	ZoneName     string   `json:"zoneName,omitempty"`
	HpasStatus   string   `json:"hpasStatus,omitempty"`
	AppType      string   `json:"appType,omitempty"`
	ShowRdmaTopo bool     `json:"showRdmaTopo,omitempty"`
	PageNo       int      `json:"pageNo,omitempty"`
	PageSize     int      `json:"pageSize,omitempty"`
}

type ListReservedHpasByMakerReq added in v0.9.221 

type ListReservedHpasByMakerReq struct {
	ReservedHpasIds    []string `json:"reservedHpasIds,omitempty"`
	Name               string   `json:"name,omitempty"`
	ZoneName           string   `json:"zoneName,omitempty"`
	ReservedHpasStatus string   `json:"reservedHpasStatus,omitempty"`
	AppType            string   `json:"appType,omitempty"`
	HpasId             string   `json:"hpasId,omitempty"`
	Marker             string   `json:"marker,omitempty"`
	MaxKeys            int      `json:"maxKeys,omitempty"`
}

type ListReservedHpasByMakerResp added in v0.9.221 

type ListReservedHpasByMakerResp struct {
	Marker           string                 `json:"marker"`
	IsTruncated      bool                   `json:"isTruncated"`
	NextMarker       string                 `json:"nextMarker"`
	MaxKeys          int                    `json:"maxKeys"`
	ReservedHpasList []HpasReservedResponse `json:"reservedHpasList"`
}

func ListReservedHpasByMaker added in v0.9.221 

func ListReservedHpasByMaker(cli bce.Client, body *ListReservedHpasByMakerReq) (
	*ListReservedHpasByMakerResp, error)

ListReservedHpasByMaker -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • *api.ListHpasByPageResp:
  • error: the return error if any occurs

type ListReservedHpasByPageResp added in v0.9.216 

type ListReservedHpasByPageResp struct {
	OrderBy          string                 `json:"orderBy"`
	Order            string                 `json:"order"`
	PageNo           int32                  `json:"pageNo"`
	PageSize         int32                  `json:"pageSize"`
	TotalCount       int64                  `json:"totalCount"`
	ReservedHpasList []HpasReservedResponse `json:"reservedHpasList"`
}

func DescribeReservedHpas added in v0.9.216 

func DescribeReservedHpas(cli bce.Client, body *ListReservedHpasPageReq) (
	*ListReservedHpasByPageResp, error)

DescribeReservedHpas -

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • *api.ListReservedHpasByPageResp:
  • error: the return error if any occurs

type ListReservedHpasPageReq added in v0.9.216 

type ListReservedHpasPageReq struct {
	ReservedHpasIds    []string `json:"reservedHpasIds,omitempty"`
	Name               string   `json:"name,omitempty"`
	ZoneName           string   `json:"zoneName,omitempty"`
	ReservedHpasStatus string   `json:"reservedHpasStatus,omitempty"`
	AppType            string   `json:"appType,omitempty"`
	PageNo             int      `json:"pageNo,omitempty"`
	PageSize           int      `json:"pageSize,omitempty"`
}

type ModifyImageAttributeReq added in v0.9.222 

type ModifyImageAttributeReq struct {
	ImageId   string `json:"imageId"`
	ImageName string `json:"imageName"`
}

type ModifyInstanceVpcRequest added in v0.9.231 

type ModifyInstanceVpcRequest struct {
	HpasId            string   `json:"hpasId"`
	SubnetId          string   `json:"subnetId"`
	PrivateIp         string   `json:"privateIp"`
	SecurityGroupType string   `json:"securityGroupType"`
	SecurityGroupIds  []string `json:"securityGroupIds"`
}

type ModifyInstancesAttributeReq added in v0.9.222 

type ModifyInstancesAttributeReq struct {
	HpasIds                    []string `json:"hpasIds,omitempty"`
	Name                       string   `json:"name,omitempty"`
	ApplicationName            string   `json:"applicationName,omitempty"`
	AutoSeqSuffix              bool     `json:"autoSeqSuffix,omitempty"`
	ForceApplicationNameUnique bool     `json:"forceApplicationNameUnique,omitempty"`
	Reboot                     bool     `json:"reboot,omitempty"`
}

type ModifyInstancesSubnetRequest added in v0.9.231 

type ModifyInstancesSubnetRequest struct {
	HpasIds   []string `json:"hpasIds"`
	SubnetId  string   `json:"subnetId"`
	PrivateIp string   `json:"privateIp"`
}

type ModifyJumboReq added in v0.9.263 

type ModifyJumboReq struct {
	HpasIds          []string `json:"hpasIds"`
	EnableJumboFrame bool     `json:"enableJumboFrame"`
}

type ModifyPasswordHpasReq 

type ModifyPasswordHpasReq struct {
	HpasId   string `json:"hpasId,omitempty"`
	Password string `json:"password,omitempty"`
}

type ModifyReservedHpasModel added in v0.9.250 

type ModifyReservedHpasModel struct {
	ReservedInstanceId string `json:"reservedInstanceId"`
	ZoneName           string `json:"zoneName"`
	EhcClusterId       string `json:"ehcClusterId"`
}

type ModifyReservedHpasNameReq added in v0.9.250 

type ModifyReservedHpasNameReq struct {
	ReservedInstanceIds []string `json:"reservedInstanceIds"`
	Name                string   `json:"name"`
}

type ModifyReservedHpasReq added in v0.9.250 

type ModifyReservedHpasReq struct {
	ModifyReservedHpasList []ModifyReservedHpasModel `json:"reservedInstances"`
}

type ModifyReservedHpasResp added in v0.9.250 

type ModifyReservedHpasResp struct {
	ModifyReservedInstanceOrders []ModifyReservedInstanceOrderModel `json:"modifyReservedInstanceOrders"`
}

func ModifyReservedHpas added in v0.9.250 

func ModifyReservedHpas(cli bce.Client, body *ModifyReservedHpasReq) (*ModifyReservedHpasResp, error)

ModifyReservedHpas

PARAMS:

  • cli: the client agent which can perform sending request
  • body:

RETURNS:

  • *api.ModifyReservedHpasResp:
  • error: the return error if any occurs

type ModifyReservedInstanceOrderModel added in v0.9.250 

type ModifyReservedInstanceOrderModel struct {
	ReservedInstanceId string `json:"reservedInstanceId"`
	OrderId            string `json:"orderId"`
}

type NicInfo added in v0.9.221 

type NicInfo struct {
	NicId             string     `json:"nicId"`
	NicName           string     `json:"nicName"`
	NicType           string     `json:"nicType"`
	SubnetId          string     `json:"subnetId"`
	Description       string     `json:"description"`
	HpasId            string     `json:"hpasId"`
	NicStatus         string     `json:"nicStatus"`
	MacAddress        string     `json:"macAddress"`
	VpcId             string     `json:"vpcId"`
	CreatedTime       string     `json:"createdTime"`
	Ipv4s             []Ipv4Info `json:"ipv4s"`
	Ipv6s             []Ipv6Info `json:"ipv6s"`
	SecurityGroupType string     `json:"securityGroupType"`
	SecurityGroupIds  []string   `json:"securityGroupIds"`
}

type RdmaNicTopo added in v0.9.221 

type RdmaNicTopo struct {
	RdmaIp      string `json:"rdmaIp"`
	SwitchName  string `json:"switchName"`
	SwitchPort  string `json:"switchPort"`
	RdmaMac     string `json:"rdmaMac"`
	RdmaGateway string `json:"rdmaGateway"`
}

type RebootHpasReq 

type RebootHpasReq struct {
	HpasIds   []string `json:"hpasIds,omitempty"`
	ForceStop bool     `json:"forceStop,omitempty"`
}

type RenewHpasReq added in v0.9.252 

type RenewHpasReq struct {
	HpasIds    []string `json:"hpasIds"`
	Period     int32    `json:"period,omitempty"`
	PeriodUnit string   `json:"periodUnit,omitempty"`
}

type RenewHpasResp added in v0.9.252 

type RenewHpasResp struct {
	RequestId string   `json:"requestId"`
	OrderId   string   `json:"orderId"`
	HpasIds   []string `json:"hpasIds"`
}

func RenewHpasInstances added in v0.9.252 

func RenewHpasInstances(cli bce.Client, body *RenewHpasReq) (*RenewHpasResp, error)

type ResetHpasReq 

type ResetHpasReq struct {
	HpasIds           []string `json:"hpasIds,omitempty"`
	ImageId           string   `json:"imageId,omitempty"`
	Password          string   `json:"password,omitempty"`
	KeypairId         string   `json:"keypairId,omitempty"`
	UserData          string   `json:"userData,omitempty"`
	CleanLastUserData bool     `json:"cleanLastUserData,omitempty"`
}

type SecurityGroupsReq added in v0.9.231 

type SecurityGroupsReq struct {
	HpasIds           []string `json:"hpasIds,omitempty"`
	SecurityGroupIds  []string `json:"securityGroupIds,omitempty"`
	SecurityGroupType string   `json:"securityGroupType,omitempty"`
}

type StartHpasReq 

type StartHpasReq struct {
	HpasIds []string `json:"hpasIds,omitempty"`
}

type StopHpasReq 

type StopHpasReq struct {
	HpasIds   []string `json:"hpasIds,omitempty"`
	ForceStop bool     `json:"forceStop,omitempty"`
}

type TagModel 

type TagModel struct {
	TagKey   string `json:"tagKey,omitempty"`
	TagValue string `json:"tagValue,omitempty"`
}

type TagResponse 

type TagResponse struct {
	TagKey   string `json:"tagKey"`
	TagValue string `json:"tagValue"`
}

type TagsOperationRequest 

type TagsOperationRequest struct {
	ResourceType string     `json:"resourceType,omitempty"`
	ResourceIds  []string   `json:"resourceIds,omitempty"`
	Tags         []TagModel `json:"tags,omitempty"`
}

type UnAssignIpv4Req added in v0.9.221 

type UnAssignIpv4Req struct {
	HpasId     string   `json:"hpasId"`
	PrivateIps []string `json:"privateIps,omitempty"`
}

type UnAssignIpv6Req added in v0.9.221 

type UnAssignIpv6Req struct {
	HpasId        string   `json:"hpasId"`
	Ipv6Addresses []string `json:"ipv6Addresses,omitempty"`
	Reboot        bool     `json:"reboot,omitempty"`
}

type VolumeInfo added in v0.9.245 

type VolumeInfo struct {
	VolumeId        string `json:"volumeId"`
	VolumeName      string `json:"volumeName"`
	VolumeSizeInGiB int    `json:"volumeSizeInGiB"`
	CreateTime      string `json:"createTime"`
	ExpiredTime     string `json:"expiredTime"`
	VolumeStatus    string `json:"volumeStatus"`
	VolumeType      string `json:"volumeType"`
	VolumeCategory  string `json:"volumeCategory"`
	Source          string `json:"source"`
}

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.