ulighthost

package
v0.22.59 Latest Latest
Warning

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

Go to latest
Published: Feb 6, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package ulighthost include resources of ucloud ulighthost product

See also

for detail.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Bundle

type Bundle struct {

	// 外网带宽。单位:Mbps。
	Bandwidth int

	// 套餐ID。
	BundleId string

	// CPU核数。
	CPU int

	// 内存大小。单位:MB。
	Memory int

	// 系统盘大小。单位:GB。
	SysDiskSpace int

	// 流量包大小。单位:GB。
	TrafficPacket int
}

Bundle - 轻量应用云主机套餐

type CheckULHostResourceCapacityRequest

type CheckULHostResourceCapacityRequest struct {
	request.CommonBase

	// 套餐ID。如:"ulh.c1m1s40b30t800"
	BundleId *string `required:"true"`

	// 计费模式。枚举值: \\ > Year,按年付费; \\ > Month,按月付费;\\ > ThirtyDay,30天期付费,跨境电商相关套餐使用此计费方式;默认:Month
	ChargeType *string `required:"false"`

	// 主机代金券ID。请通过DescribeCoupon接口查询,或登录用户中心查看
	CouponId *string `required:"false"`

	// 镜像ID。 请通过 [DescribeImage](describe_image.html)获取
	ImageId *string `required:"true"`

	// 轻量应用主机名称。默认:套餐ID。请遵照[[api:uhost-api:specification|字段规范]]设定实例名称。
	Name *string `required:"false"`

	// 购买时长。默认:1。不支持购买到月末
	Quantity *int `required:"false"`

	// 防火墙ID,默认:Web推荐防火墙。如何查询SecurityGroupId请参见 [DescribeFirewall](api/unet-api/describe_firewall.html)。
	SecurityGroupId *string `required:"false"`

	// 子网 ID。默认为当前地域的默认子网。
	SubnetId *string `required:"false"`

	// VPC ID。默认为当前地域的默认VPC。
	VPCId *string `required:"false"`
}

CheckULHostResourceCapacityRequest is request schema for CheckULHostResourceCapacity action

type CheckULHostResourceCapacityResponse

type CheckULHostResourceCapacityResponse struct {
	response.CommonBase

	// 错误信息
	Message string

	// 资源是否充足
	ResourceEnough bool
}

CheckULHostResourceCapacityResponse is response schema for CheckULHostResourceCapacity action

type CreateULHostInstanceRequest

type CreateULHostInstanceRequest struct {
	request.CommonBase

	// 套餐ID。如:"ulh.c1m1s40b30t800"
	BundleId *string `required:"true"`

	// 计费模式。枚举值: \\ > Year,按年付费; \\ > Month,按月付费;\\ > ThirtyDay,30天期付费,跨境电商相关套餐使用此计费方式;默认:Month
	ChargeType *string `required:"false"`

	// 主机代金券ID。请通过DescribeCoupon接口查询,或登录用户中心查看
	CouponId *string `required:"false"`

	// 镜像ID。 请通过 [DescribeImage](describe_image.html)获取
	ImageId *string `required:"true"`

	// 轻量应用主机名称。默认:套餐ID。请遵照[[api:uhost-api:specification|字段规范]]设定实例名称。
	Name *string `required:"false"`

	// ULHost密码。请遵照[[api:uhost-api:specification|字段规范]]设定密码。密码需使用base64进行编码,举例如下:# echo -n Password1 | base64
	Password *string `required:"true"`

	// 购买时长。默认:1。不支持购买到月末
	Quantity *int `required:"false"`

	// 防火墙ID,默认:Web推荐防火墙。如何查询SecurityGroupId请参见 [DescribeFirewall](api/unet-api/describe_firewall.html)。
	SecurityGroupId *string `required:"false"`

	// 子网 ID。默认为当前地域的默认子网。
	SubnetId *string `required:"false"`

	// VPC ID。默认为当前地域的默认VPC。
	VPCId *string `required:"false"`
}

CreateULHostInstanceRequest is request schema for CreateULHostInstance action

type CreateULHostInstanceResponse

type CreateULHostInstanceResponse struct {
	response.CommonBase

	// 错误信息
	Message string

	// 实例ID
	ULHostId string
}

CreateULHostInstanceResponse is response schema for CreateULHostInstance action

type DescribeULHostBundlesRequest

type DescribeULHostBundlesRequest struct {
	request.CommonBase
}

DescribeULHostBundlesRequest is request schema for DescribeULHostBundles action

type DescribeULHostBundlesResponse

type DescribeULHostBundlesResponse struct {
	response.CommonBase

	// 套餐列表
	Bundles []Bundle

	// 错误信息
	Message string
}

DescribeULHostBundlesResponse is response schema for DescribeULHostBundles action

type DescribeULHostImageRequest

type DescribeULHostImageRequest struct {
	request.CommonBase

	// 镜像Id
	ImageId *string `required:"false"`

	// 镜像Id列表
	ImageIds []string `required:"false"`

	// 镜像类型。标准镜像:Base,应用镜像:App, 自定义镜像:Custom,默认返回所有类型
	ImageType *string `required:"false"`

	// 返回数据长度,默认为20
	Limit *int `required:"false"`

	// 列表起始位置偏移量,默认为0
	Offset *int `required:"false"`

	// 操作系统类型:Linux, Windows 默认返回所有类型
	OsType *string `required:"false"`

	// 使用场景,当ImageType为"App"时生效。- Normal 常规专区- CrossBorder 跨境专区默认返回所有
	Scene *string `required:"false"`

	// 业务组Id。默认:Default
	Tag *string `required:"false"`
}

DescribeULHostImageRequest is request schema for DescribeULHostImage action

type DescribeULHostImageResponse

type DescribeULHostImageResponse struct {
	response.CommonBase

	// 镜像列表详见 UHostImageSet
	ImageSet []ULHostImageSet

	// 满足条件的镜像总数
	TotalCount int
}

DescribeULHostImageResponse is response schema for DescribeULHostImage action

type DescribeULHostInstanceRequest

type DescribeULHostInstanceRequest struct {
	request.CommonBase

	// 返回数据长度,默认为20,最大100
	Limit *int `required:"false"`

	// 列表起始位置偏移量,默认为0
	Offset *int `required:"false"`

	// 【数组】轻量应用云主机ID。
	ULHostIds []string `required:"false"`
}

DescribeULHostInstanceRequest is request schema for DescribeULHostInstance action

type DescribeULHostInstanceResponse

type DescribeULHostInstanceResponse struct {
	response.CommonBase

	// 错误信息
	Message string

	// 实例列表
	ULHostInstanceSets []ULHostInstanceSet
}

DescribeULHostInstanceResponse is response schema for DescribeULHostInstance action

type ExclusiveUTPInfo

type ExclusiveUTPInfo struct {

	// 当前周期剩余流量
	AvailableSize int

	// 创建时间
	CreateTime int

	// 当前周期超出限额的流量
	ExcessSize int

	// 上次重置时间
	LastResetTime int

	// 下次重置时间
	NextResetTime int

	// 当前周期总流量
	TotalSize int

	// 当前周期已使用流量
	UsedSize int
}

ExclusiveUTPInfo - 流量包详情

type GetULHostInstancePriceRequest

type GetULHostInstancePriceRequest struct {
	request.CommonBase

	// 套餐ID
	BundleId *string `required:"true"`

	// 获取指定计费模式的价格。枚举值:\\ > Year,按年付费; \\ > Month。未指定时,返回所有计费模式价格
	ChargeType *string `required:"false"`

	// 购买台数,范围[1,5]。默认:1
	Count *int `required:"false"`

	// 购买时长。默认: 1。不支持购买到月末
	Quantity *int `required:"false"`
}

GetULHostInstancePriceRequest is request schema for GetULHostInstancePrice action

type GetULHostInstancePriceResponse

type GetULHostInstancePriceResponse struct {
	response.CommonBase

	// 错误信息
	Message string

	// 价格
	PriceSet []ULHostPriceSet
}

GetULHostInstancePriceResponse is response schema for GetULHostInstancePrice action

type GetULHostRenewPriceRequest

type GetULHostRenewPriceRequest struct {
	request.CommonBase

	// 计费类型。支持:Year/Month;默认:Month
	ChargeType *string `required:"false"`

	// ULHost实例ID
	ULHostId *string `required:"true"`
}

GetULHostRenewPriceRequest is request schema for GetULHostRenewPrice action

type GetULHostRenewPriceResponse

type GetULHostRenewPriceResponse struct {
	response.CommonBase

	// 价格
	PriceSet []ULHostPriceSet
}

GetULHostRenewPriceResponse is response schema for GetULHostRenewPrice action

type ModifyULHostAttributeRequest

type ModifyULHostAttributeRequest struct {
	request.CommonBase

	// 名称。和Remark至少选择一个进行修改
	Name *string `required:"false"`

	// 备注。和Name至少选择一个进行修改
	Remark *string `required:"false"`

	// ULHost实例Id
	ULHostId *string `required:"true"`
}

ModifyULHostAttributeRequest is request schema for ModifyULHostAttribute action

type ModifyULHostAttributeResponse

type ModifyULHostAttributeResponse struct {
	response.CommonBase

	// 错误信息
	Message string

	// ULHost实例Id
	ULHostId string
}

ModifyULHostAttributeResponse is response schema for ModifyULHostAttribute action

type PoweroffULHostInstanceRequest

type PoweroffULHostInstanceRequest struct {
	request.CommonBase

	// ULHost实例ID
	ULHostId *string `required:"true"`
}

PoweroffULHostInstanceRequest is request schema for PoweroffULHostInstance action

type PoweroffULHostInstanceResponse

type PoweroffULHostInstanceResponse struct {
	response.CommonBase

	// ULHost实例ID
	ULHostId string
}

PoweroffULHostInstanceResponse is response schema for PoweroffULHostInstance action

type RebootULHostInstanceRequest

type RebootULHostInstanceRequest struct {
	request.CommonBase

	// ULHost实例ID
	ULHostId *string `required:"true"`
}

RebootULHostInstanceRequest is request schema for RebootULHostInstance action

type RebootULHostInstanceResponse

type RebootULHostInstanceResponse struct {
	response.CommonBase

	// ULHost实例ID
	ULHostId string
}

RebootULHostInstanceResponse is response schema for RebootULHostInstance action

type ReinstallULHostInstanceRequest

type ReinstallULHostInstanceRequest struct {
	request.CommonBase

	// 镜像Id。暂不支持使用自定义镜像重装
	ImageId *string `required:"true"`

	// 登陆密码。密码需使用base64进行编码,举例如下:# echo -n Password1 | base64 UGFzc3dvcmQx
	Password *string `required:"true"`

	// 实例Id
	ULHostId *string `required:"true"`
}

ReinstallULHostInstanceRequest is request schema for ReinstallULHostInstance action

type ReinstallULHostInstanceResponse

type ReinstallULHostInstanceResponse struct {
	response.CommonBase

	// 错误信息
	Message string

	// 实例Id
	ULHostId string
}

ReinstallULHostInstanceResponse is response schema for ReinstallULHostInstance action

type ResetULHostInstancePasswordRequest

type ResetULHostInstancePasswordRequest struct {
	request.CommonBase

	// ULHost新密码(密码格式使用BASE64编码)
	Password *string `required:"true"`

	// ULHost实例ID
	ULHostId *string `required:"true"`
}

ResetULHostInstancePasswordRequest is request schema for ResetULHostInstancePassword action

type ResetULHostInstancePasswordResponse

type ResetULHostInstancePasswordResponse struct {
	response.CommonBase

	// ULHost实例ID
	ULHostId string
}

ResetULHostInstancePasswordResponse is response schema for ResetULHostInstancePassword action

type StartULHostInstanceRequest

type StartULHostInstanceRequest struct {
	request.CommonBase

	// ULHost实例ID
	ULHostId *string `required:"true"`
}

StartULHostInstanceRequest is request schema for StartULHostInstance action

type StartULHostInstanceResponse

type StartULHostInstanceResponse struct {
	response.CommonBase

	// ULHost实例ID
	ULHostId string
}

StartULHostInstanceResponse is response schema for StartULHostInstance action

type StopULHostInstanceRequest

type StopULHostInstanceRequest struct {
	request.CommonBase

	// ULHost实例ID。
	ULHostId *string `required:"true"`
}

StopULHostInstanceRequest is request schema for StopULHostInstance action

type StopULHostInstanceResponse

type StopULHostInstanceResponse struct {
	response.CommonBase

	// ULHost实例ID
	ULHostId string
}

StopULHostInstanceResponse is response schema for StopULHostInstance action

type TerminateULHostInstanceRequest

type TerminateULHostInstanceRequest struct {
	request.CommonBase

	// 删除主机时是否同时删除挂载的数据盘。默认为false。
	ReleaseUDisk *bool `required:"false"`

	// ULHost资源Id
	ULHostId *string `required:"true"`
}

TerminateULHostInstanceRequest is request schema for TerminateULHostInstance action

type TerminateULHostInstanceResponse

type TerminateULHostInstanceResponse struct {
	response.CommonBase

	// 用于判断主机删除时是否进入回收站。放入回收站:"Yes", 彻底删除:“No”。
	InRecycle string

	// ULHost 实例 Id
	ULHostId string
}

TerminateULHostInstanceResponse is response schema for TerminateULHostInstance action

type UHostIPSet

type UHostIPSet struct {

	// IP对应的带宽, 单位: Mb  (内网IP不显示带宽信息)
	Bandwidth int

	// 内网 Private 类型下,表示是否为默认网卡。true: 是默认网卡;其他值:不是。
	Default string

	// IP地址
	IP string

	// 外网IP资源ID 。(内网IP无对应的资源ID)
	IPId string

	// IPv4/IPv6;
	IPMode string

	// 内网 Private 类型下,当前网卡的Mac。
	Mac string

	// 弹性网卡为默认网卡时,返回对应的 ID 值
	NetworkInterfaceId string

	// IP地址对应的子网 ID。(北京一不支持,字段返回为空)
	SubnetId string

	// 国际: Internation,BGP: Bgp,内网: Private
	Type string

	// IP地址对应的VPC ID。(北京一不支持,字段返回为空)
	VPCId string

	// 当前EIP的权重。权重最大的为当前的出口IP。
	Weight int
}

UHostIPSet -

type ULHostDiskSet

type ULHostDiskSet struct {

	// 磁盘Id
	DiskId string

	// 磁盘类型。如:"CLOUD_RSSD"、"CLOUD_SSD"
	DiskType string

	// 磁盘盘符。系统盘:"vda"
	Drive string

	// 是否为系统盘。是:"True";否:"False"
	IsBoot string

	// 磁盘大小。单位:GB
	Size int

	// 磁盘类型。系统盘:"Boot";数据盘:"Data"
	Type string
}

ULHostDiskSet - 轻量应用主机的磁盘信息

type ULHostImageSet

type ULHostImageSet struct {

	// 创建时间,格式为Unix时间戳
	CreateTime int

	// 用于控制台显示的名称
	DisplayName string

	// 特殊状态标识,目前包含NetEnhnced(网络增强1.0), NetEnhanced_Ultra(网络增强2.0), NetEnhanced_Extreme(网络增强3.0), HotPlug(热升级), GPU(GPU镜像),CloudInit, IPv6(支持IPv6网络),RssdAttachable(支持RSSD云盘),Vgpu_AMD(支持AMD的vgpu),Vgpu_NVIDIA(支持NVIDIA的vgpu),Aarch64_Type(支持arm64架构)
	Features []string

	// 镜像描述
	ImageDescription string

	// 镜像ID
	ImageId string

	// 应用镜像图标url
	ImageLogoLink string

	// 镜像名称
	ImageName string

	// 镜像大小
	ImageSize int

	// 镜像类型 标准镜像:Base, 行业镜像:Business,自定义镜像:Custom
	ImageType string

	// 集成软件名称(仅行业镜像将返回这个值)
	IntegratedSoftware string

	// 系统EOL的时间,格式:YYYY/MM/DD
	MaintainEol string

	// 默认值为空”'。当CentOS 7.3/7.4/7.5等镜像会标记为“Broadwell”
	MinimalCPU string

	// 操作系统名称
	OsName string

	// 操作系统类型:Linux,Windows
	OsType string

	// 场景分类,目前包含Featured(精选),PreInstalledDrivers(预装驱动),AIPainting(AI绘画),AIModels(AI模型),HPC(高性能计算)
	SceneCategories []string

	// 镜像状态, 可用:Available,制作中:Making, 不可用:Unavailable,复制中:Copying
	State string

	// 业务组
	Tag string

	// 可用区,参见 [可用区列表](../summary/regionlist.html)
	Zone string
}

ULHostImageSet - DescribeULHostImage

type ULHostInstanceSet

type ULHostInstanceSet struct {

	// 【数组】镜像包含的应用列表。
	Apps []string

	// 是否自动续费。枚举值:Yes/No
	AutoRenew string

	// CPU核数。
	CPU int

	// 计费模式。枚举值:Month/Year
	ChargeType string

	// 创建时间。Unix时间戳
	CreateTime int

	// 磁盘信息
	DiskSet []ULHostDiskSet

	// 流量包详情信息
	EIPExclusiveUTPInfo ExclusiveUTPInfo

	// 过期时间。Unix时间戳
	ExpireTime int

	// IP信息
	IPSet []UHostIPSet

	// 镜像Id。
	ImageId string

	// 镜像名称。
	ImageName string

	// 是否过期。枚举值:Yes/No
	IsExpire string

	// 内存。单位:MB
	Memory int

	// 实例名称。默认套餐Id
	Name string

	// 备注。
	Remark string

	// 实例状态。枚举值:\\ >初始化: Initializing; \\ >启动中: Starting; \\> 运行中: Running; \\> 关机中: Stopping; \\ >关机: Stopped \\ >安装失败: Install Fail; \\ >重启中: Rebooting; \\ > 未知(空字符串,获取状态超时或出错):""
	State string

	// 业务组。
	Tag string

	// 实例Id。
	ULHostId string

	// 可用区。
	Zone string
}

ULHostInstanceSet - 轻量应用云主机详情

type ULHostPriceSet

type ULHostPriceSet struct {

	// 计费模式
	ChargeType string

	// 原价
	OriginalPrice float64

	// 价格
	Price float64
}

ULHostPriceSet - 轻量应用主机价格详情

type ULightHostClient

type ULightHostClient struct {
	*ucloud.Client
}

ULightHostClient is the client of ULightHost

func NewClient

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

NewClient will return a instance of ULightHostClient

func (*ULightHostClient) CheckULHostResourceCapacity

API: CheckULHostResourceCapacity

检查轻量应用云主机资源余量

func (*ULightHostClient) CreateULHostInstance

API: CreateULHostInstance

创建轻量应用云主机

func (*ULightHostClient) DescribeULHostBundles

API: DescribeULHostBundles

获取轻量应用云主机套餐列表

func (*ULightHostClient) DescribeULHostImage

API: DescribeULHostImage

获取指定数据中心镜像列表

func (*ULightHostClient) DescribeULHostInstance

API: DescribeULHostInstance

获取轻量应用云主机列表

func (*ULightHostClient) GetULHostInstancePrice

API: GetULHostInstancePrice

获取轻量应用云主机套餐价格

func (*ULightHostClient) GetULHostRenewPrice

API: GetULHostRenewPrice

获取主机续费价格

func (*ULightHostClient) ModifyULHostAttribute

API: ModifyULHostAttribute

修改指定ULHost实例属性信息,包含名称和备注

func (*ULightHostClient) NewCheckULHostResourceCapacityRequest

func (c *ULightHostClient) NewCheckULHostResourceCapacityRequest() *CheckULHostResourceCapacityRequest

NewCheckULHostResourceCapacityRequest will create request of CheckULHostResourceCapacity action.

func (*ULightHostClient) NewCreateULHostInstanceRequest

func (c *ULightHostClient) NewCreateULHostInstanceRequest() *CreateULHostInstanceRequest

NewCreateULHostInstanceRequest will create request of CreateULHostInstance action.

func (*ULightHostClient) NewDescribeULHostBundlesRequest

func (c *ULightHostClient) NewDescribeULHostBundlesRequest() *DescribeULHostBundlesRequest

NewDescribeULHostBundlesRequest will create request of DescribeULHostBundles action.

func (*ULightHostClient) NewDescribeULHostImageRequest

func (c *ULightHostClient) NewDescribeULHostImageRequest() *DescribeULHostImageRequest

NewDescribeULHostImageRequest will create request of DescribeULHostImage action.

func (*ULightHostClient) NewDescribeULHostInstanceRequest

func (c *ULightHostClient) NewDescribeULHostInstanceRequest() *DescribeULHostInstanceRequest

NewDescribeULHostInstanceRequest will create request of DescribeULHostInstance action.

func (*ULightHostClient) NewGetULHostInstancePriceRequest

func (c *ULightHostClient) NewGetULHostInstancePriceRequest() *GetULHostInstancePriceRequest

NewGetULHostInstancePriceRequest will create request of GetULHostInstancePrice action.

func (*ULightHostClient) NewGetULHostRenewPriceRequest

func (c *ULightHostClient) NewGetULHostRenewPriceRequest() *GetULHostRenewPriceRequest

NewGetULHostRenewPriceRequest will create request of GetULHostRenewPrice action.

func (*ULightHostClient) NewModifyULHostAttributeRequest

func (c *ULightHostClient) NewModifyULHostAttributeRequest() *ModifyULHostAttributeRequest

NewModifyULHostAttributeRequest will create request of ModifyULHostAttribute action.

func (*ULightHostClient) NewPoweroffULHostInstanceRequest

func (c *ULightHostClient) NewPoweroffULHostInstanceRequest() *PoweroffULHostInstanceRequest

NewPoweroffULHostInstanceRequest will create request of PoweroffULHostInstance action.

func (*ULightHostClient) NewRebootULHostInstanceRequest

func (c *ULightHostClient) NewRebootULHostInstanceRequest() *RebootULHostInstanceRequest

NewRebootULHostInstanceRequest will create request of RebootULHostInstance action.

func (*ULightHostClient) NewReinstallULHostInstanceRequest

func (c *ULightHostClient) NewReinstallULHostInstanceRequest() *ReinstallULHostInstanceRequest

NewReinstallULHostInstanceRequest will create request of ReinstallULHostInstance action.

func (*ULightHostClient) NewResetULHostInstancePasswordRequest

func (c *ULightHostClient) NewResetULHostInstancePasswordRequest() *ResetULHostInstancePasswordRequest

NewResetULHostInstancePasswordRequest will create request of ResetULHostInstancePassword action.

func (*ULightHostClient) NewStartULHostInstanceRequest

func (c *ULightHostClient) NewStartULHostInstanceRequest() *StartULHostInstanceRequest

NewStartULHostInstanceRequest will create request of StartULHostInstance action.

func (*ULightHostClient) NewStopULHostInstanceRequest

func (c *ULightHostClient) NewStopULHostInstanceRequest() *StopULHostInstanceRequest

NewStopULHostInstanceRequest will create request of StopULHostInstance action.

func (*ULightHostClient) NewTerminateULHostInstanceRequest

func (c *ULightHostClient) NewTerminateULHostInstanceRequest() *TerminateULHostInstanceRequest

NewTerminateULHostInstanceRequest will create request of TerminateULHostInstance action.

func (*ULightHostClient) PoweroffULHostInstance

API: PoweroffULHostInstance

直接关闭UHost实例电源,无需等待实例正常关闭。

func (*ULightHostClient) RebootULHostInstance

API: RebootULHostInstance

重新启动UHost实例。

func (*ULightHostClient) ReinstallULHostInstance

API: ReinstallULHostInstance

重装轻量应用云主机

func (*ULightHostClient) ResetULHostInstancePassword

API: ResetULHostInstancePassword

重置轻量应用云主机管理员密码。

func (*ULightHostClient) StartULHostInstance

API: StartULHostInstance

启动处于关闭状态的UHost实例。

func (*ULightHostClient) StopULHostInstance

API: StopULHostInstance

指停止处于运行状态的ULHost实例

func (*ULightHostClient) TerminateULHostInstance

API: TerminateULHostInstance

删除指定数据中心的ULHost实例。

Jump to

Keyboard shortcuts

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