Documentation
¶
Overview ¶
Package ucloudstack include resources of ucloud ucloudstack product
See also
- API: https://docs.ucloud.cn/api/ucloudstack-api/index
- Product: https://www.ucloud.cn/site/product/ucloudstack.html
for detail.
Index ¶
- type CreateVMInstanceRequest
- type CreateVMInstanceResponse
- type DeleteVMInstanceRequest
- type DeleteVMInstanceResponse
- type DescribeMetricRequest
- type DescribeMetricResponse
- type DescribeVMInstanceRequest
- type DescribeVMInstanceResponse
- type MetricInfo
- type MetricSet
- type StopVMInstanceRequest
- type StopVMInstanceResponse
- type UCloudStackClient
- func (c *UCloudStackClient) CreateVMInstance(req *CreateVMInstanceRequest) (*CreateVMInstanceResponse, error)
- func (c *UCloudStackClient) DeleteVMInstance(req *DeleteVMInstanceRequest) (*DeleteVMInstanceResponse, error)
- func (c *UCloudStackClient) DescribeMetric(req *DescribeMetricRequest) (*DescribeMetricResponse, error)
- func (c *UCloudStackClient) DescribeVMInstance(req *DescribeVMInstanceRequest) (*DescribeVMInstanceResponse, error)
- func (c *UCloudStackClient) NewCreateVMInstanceRequest() *CreateVMInstanceRequest
- func (c *UCloudStackClient) NewDeleteVMInstanceRequest() *DeleteVMInstanceRequest
- func (c *UCloudStackClient) NewDescribeMetricRequest() *DescribeMetricRequest
- func (c *UCloudStackClient) NewDescribeVMInstanceRequest() *DescribeVMInstanceRequest
- func (c *UCloudStackClient) NewStopVMInstanceRequest() *StopVMInstanceRequest
- func (c *UCloudStackClient) StopVMInstance(req *StopVMInstanceRequest) (*StopVMInstanceResponse, error)
- type VMDiskInfo
- type VMIPInfo
- type VMInstanceInfo
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateVMInstanceRequest ¶
type CreateVMInstanceRequest struct {
request.CommonBase
// 系统盘类型。枚举值:Normal,表示普通;SSD,表示SSD;
BootDiskType *string `required:"true"`
// CPU 个数,目前只能输入数据库配置指定规格参数,如:1核2048M、2核4096M、4核8192M、8核16384M、16核32768M。
CPU *int `required:"true"`
// 计费模式。枚举值:Dynamic,表示小时;Month,表示月;Year,表示年;
ChargeType *string `required:"true"`
// 数据盘大小,单位 GB。默认值为0。范围:【0,8000】,步长10。
DataDiskSpace *int `required:"false"`
// 数据盘类型。枚举值:Normal,表示普通;SSD,表示SSD;
DataDiskType *string `required:"true"`
// GPU 卡核心的占用个数。枚举值:【1,2,4】。GPU与CPU、内存大小关系:CPU个数>=4*GPU个数,同时内存与CPU规格匹配.
GPU *int `required:"false"`
// 镜像 ID。基础镜像 ID 或者自制镜像 ID。如:cn-image-centos-74。
ImageID *string `required:"true"`
// 指定内网IP。输入有效的指定内网 IP。默认为系统自动分配内网 IP。
InternalIP *string `required:"false"`
// 内网安全组 ID。输入“有效”状态的安全组的ID。
LANSGID *string `required:"false"`
// 内存大小,单位 M。目前只能输入数据库配置指定规格参数,如:1核2048M、2核4096M、4核8192M、8核16384M、16核32768M。
Memory *int `required:"true"`
// 虚拟机名称。可输入如:myVM。名称只能包含中英文、数字以及- _ .且1-30个字符。
Name *string `required:"true"`
// 密码。可输入如:ucloud.cn。密码长度限6-30个字符;需要同时包含两项或以上(大写字母/小写字母/数字/特殊符号);windows不能包含用户名(administrator)中超过2个连续字符的部分。
Password *string `required:"true"`
// 购买时长。默认值1。小时不生效,月范围【1,11】,年范围【1,5】。
Quantity *int `required:"false"`
// 子网 ID。
SubnetID *string `required:"true"`
// 机型。枚举值:Normal,表示普通;SSD,表示SSD;
VMType *string `required:"true"`
// VPC ID。
VPCID *string `required:"true"`
// 外网安全组 ID。输入“有效”状态的安全组的ID。
WANSGID *string `required:"true"`
}
CreateVMInstanceRequest is request schema for CreateVMInstance action
type CreateVMInstanceResponse ¶
type CreateVMInstanceResponse struct {
response.CommonBase
// 返回信息描述。
Message string
// 【数组】返回创建虚拟机的 ID 数组。
VMID string
}
CreateVMInstanceResponse is response schema for CreateVMInstance action
type DeleteVMInstanceRequest ¶
type DeleteVMInstanceRequest struct {
request.CommonBase
// 虚拟机 ID。输入有效的虚拟机 ID。
VMID *string `required:"true"`
}
DeleteVMInstanceRequest is request schema for DeleteVMInstance action
type DeleteVMInstanceResponse ¶
type DeleteVMInstanceResponse struct {
response.CommonBase
// 返回信息描述。
Message string
}
DeleteVMInstanceResponse is response schema for DeleteVMInstance action
type DescribeMetricRequest ¶
type DescribeMetricRequest struct {
request.CommonBase
// 开始时间
BeginTime *string `required:"true"`
// 结束时间
EndTime *string `required:"true"`
// 监控指标。获取虚拟机监控信息调用举例,MetricName.0="CPUUtilization"、MetricName.0="MemUsage"。虚拟机监控指标枚举值:BlockProcessCount,表示阻塞进程数;CPUUtilization,表示CPU使用率;DiskReadOps,表示磁盘读次数;DiskWriteOps,表示磁盘写次数;IORead,表示磁盘读吞吐;IOWrite,表示磁盘写吞吐;LoadAvg,表示平均负载1分钟;MemUsage,表示内存使用率;NetPacketIn,表示网卡入包量;NetPacketOut,表示网卡出包量;NICIn,表示网卡入带宽;NICOut,表示网卡出带宽;SpaceUsage,表示空间使用率;TCPConnectCount,表示TCP连接数;
MetricName []string `required:"true"`
// 资源ID
ResourceID *string `required:"true"`
}
DescribeMetricRequest is request schema for DescribeMetric action
type DescribeMetricResponse ¶
type DescribeMetricResponse struct {
response.CommonBase
// 返回信息列表
Infos []MetricInfo
// 返回信息描述
Message string
// 返回监控信息条数
TotalCount int
}
DescribeMetricResponse is response schema for DescribeMetric action
type DescribeVMInstanceRequest ¶
type DescribeVMInstanceRequest struct {
request.CommonBase
// 返回数据长度,默认为20,最大100。
Limit *int `required:"false"`
// 列表起始位置偏移量,默认为0。
Offset *string `required:"false"`
// 子网 ID。输入“有效”状态的子网 ID。
SubnetID *string `required:"false"`
// 【数组】虚拟机的 ID。输入有效的 ID。调用方式举例:PrivateIp.0=“one-id”、PrivateIp.1=“two-id”。
VMIDs []string `required:"false"`
// VPC ID。输入“有效”状态的VPC ID。
VPCID *string `required:"false"`
}
DescribeVMInstanceRequest is request schema for DescribeVMInstance action
type DescribeVMInstanceResponse ¶
type DescribeVMInstanceResponse struct {
response.CommonBase
// 【数组】返回虚拟机对象数组
Infos []VMInstanceInfo
// 返回信息描述
Message string
// 返回虚拟机总个数
TotalCount int
}
DescribeVMInstanceResponse is response schema for DescribeVMInstance action
type MetricInfo ¶
type MetricInfo struct {
// 监控值信息
Infos []MetricSet
// 监控指标。虚拟机的监控指标枚举值为:BlockProcessCount,表示阻塞进程数;CPUUtilization,表示CPU使用率;DiskReadOps,表示磁盘读次数;DiskWriteOps,表示磁盘写次数;IORead,表示磁盘读吞吐;IOWrite,表示磁盘写吞吐;LoadAvg,表示平均负载1分钟;MemUsage,表示内存使用率;NetPacketIn,表示网卡入包量;NetPacketOut,表示网卡出包量;NICIn,表示网卡入带宽;NICOut,表示网卡出带宽;SpaceUsage,表示空间使用率;TCPConnectCount,表示TCP连接数;
MetricName string
}
MetricInfo - 监控信息
this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn/api for detail.
type MetricSet ¶
MetricSet - 监控值
this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn/api for detail.
type StopVMInstanceRequest ¶
type StopVMInstanceRequest struct {
request.CommonBase
// 虚拟机�ID
VMID *string `required:"true"`
}
StopVMInstanceRequest is request schema for StopVMInstance action
type StopVMInstanceResponse ¶
type StopVMInstanceResponse struct {
response.CommonBase
// 返回信息描述
Message string
// 虚拟机 ID
VMID string
}
StopVMInstanceResponse is response schema for StopVMInstance action
type UCloudStackClient ¶
UCloudStackClient is the client of UCloudStack
func NewClient ¶
func NewClient(config *ucloud.Config, credential *auth.Credential) *UCloudStackClient
NewClient will return a instance of UCloudStackClient
func (*UCloudStackClient) CreateVMInstance ¶
func (c *UCloudStackClient) CreateVMInstance(req *CreateVMInstanceRequest) (*CreateVMInstanceResponse, error)
CreateVMInstance - 创建UCloudStack虚拟机
func (*UCloudStackClient) DeleteVMInstance ¶
func (c *UCloudStackClient) DeleteVMInstance(req *DeleteVMInstanceRequest) (*DeleteVMInstanceResponse, error)
DeleteVMInstance - 删除UCloudStack虚拟机
func (*UCloudStackClient) DescribeMetric ¶
func (c *UCloudStackClient) DescribeMetric(req *DescribeMetricRequest) (*DescribeMetricResponse, error)
DescribeMetric - 获取资源监控信息
func (*UCloudStackClient) DescribeVMInstance ¶
func (c *UCloudStackClient) DescribeVMInstance(req *DescribeVMInstanceRequest) (*DescribeVMInstanceResponse, error)
DescribeVMInstance - 查询UCloudStack虚拟机
func (*UCloudStackClient) NewCreateVMInstanceRequest ¶
func (c *UCloudStackClient) NewCreateVMInstanceRequest() *CreateVMInstanceRequest
NewCreateVMInstanceRequest will create request of CreateVMInstance action.
func (*UCloudStackClient) NewDeleteVMInstanceRequest ¶
func (c *UCloudStackClient) NewDeleteVMInstanceRequest() *DeleteVMInstanceRequest
NewDeleteVMInstanceRequest will create request of DeleteVMInstance action.
func (*UCloudStackClient) NewDescribeMetricRequest ¶
func (c *UCloudStackClient) NewDescribeMetricRequest() *DescribeMetricRequest
NewDescribeMetricRequest will create request of DescribeMetric action.
func (*UCloudStackClient) NewDescribeVMInstanceRequest ¶
func (c *UCloudStackClient) NewDescribeVMInstanceRequest() *DescribeVMInstanceRequest
NewDescribeVMInstanceRequest will create request of DescribeVMInstance action.
func (*UCloudStackClient) NewStopVMInstanceRequest ¶
func (c *UCloudStackClient) NewStopVMInstanceRequest() *StopVMInstanceRequest
NewStopVMInstanceRequest will create request of StopVMInstance action.
func (*UCloudStackClient) StopVMInstance ¶
func (c *UCloudStackClient) StopVMInstance(req *StopVMInstanceRequest) (*StopVMInstanceResponse, error)
StopVMInstance - 关闭UCloudStack虚拟机
type VMDiskInfo ¶
type VMDiskInfo struct {
// 磁盘 ID
DiskID string
// 磁盘盘符
Drive string
// 是否是弹性磁盘。枚举值为:Y,表示是;N,表示否;
IsElastic string
// 磁盘名称
Name string
// 磁盘大小,单位 GB
Size int
// 磁盘类型。枚举值:Boot,表示系统盘;Data,表示数据盘;
Type string
}
VMDiskInfo - UCloudStack虚拟机磁盘信息
this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn/api for detail.
type VMIPInfo ¶
type VMIPInfo struct {
// IP 值
IP string
// 网卡 ID
InterfaceID string
// 是否是弹性网卡。枚举值:Y,表示是;N,表示否;
IsElastic string
// MAC 地址值
MAC string
// 安全组 ID
SGID string
// 安全组名称
SGName string
// 子网 ID
SubnetID string
// 子网名称
SubnetName string
// IP 类型。枚举值:Private,表示内网;Public,表示外网;Physical,表示物理网;
Type string
// VPC ID
VPCID string
// VPC 名称
VPCName string
}
VMIPInfo - UCloudStack虚拟机IP信息
this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn/api for detail.
type VMInstanceInfo ¶
type VMInstanceInfo struct {
// CPU 个数
CPU int
// 虚拟机计费模式。枚举值:Dynamic,表示小时;Month,表示月;Year,表示年;
ChargeType string
// 虚拟机创建时间
CreateTime int
// 磁盘信息
DiskInfos []VMDiskInfo
// 虚拟机过期时间
ExpireTime int
// IP 信息
IPInfos []VMIPInfo
// 镜像 ID
ImageID string
// 内存大小,单位 M
Memory int
// 虚拟机名称
Name string
// 操作系统名称
OSName string
// 操作系统类型
OSType string
// Region
Region string
// Region 别名
RegionAlias string
// 备注
Remark string
// 虚拟机状态。枚举值:Initializing,表示初始化;Starting,表示启动中;Restarting,表示重启中;Running,表示运行;Stopping,表示关机中;Stopped,表示关机;Deleted,表示已删除;Resizing,表示修改配置中;Terminating,表示销毁中;Terminated,表示已销毁;Migrating,表示迁移中;WaitReinstall,表示重装中;Reinstalling,表示重装中;Poweroffing,表示断电中;ChangeSGing,表示修改防火墙中;
State string
// 子网 ID
SubnetID string
// 子网 名称
SubnetName string
// 虚拟机 ID
VMID string
// 虚拟机类型
VMType string
// 虚拟机类型别名
VMTypeAlias string
// VPC ID
VPCID string
// VPC 名称
VPCName string
// Zone
Zone string
// Zone 别名
ZoneAlias string
}
VMInstanceInfo - UCloudStack虚拟机信息
this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn/api for detail.