udisk

package
v0.0.0-...-c113622 Latest Latest
Warning

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

Go to latest
Published: Jul 1, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package udisk include resources of ucloud disk product

See also

for detail.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AttachUDiskRequest

type AttachUDiskRequest struct {
	request.CommonBase

	// UHost实例ID
	UHostId *string `required:"true"`

	// 需要挂载的UDisk实例ID.
	UDiskId *string `required:"true"`

	// 是否允许多点挂载(Yes: 允许多点挂载, No: 不允许多点挂载, 不填默认Yes )
	MultiAttach *string `required:"false"`
}

AttachUDiskRequest is request schema for AttachUDisk action

type AttachUDiskResponse

type AttachUDiskResponse struct {
	response.CommonBase

	// 挂载的UHost实例ID
	UHostId string

	// 挂载的UDisk实例ID
	UDiskId string
}

AttachUDiskResponse is response schema for AttachUDisk action

type CloneUDiskRequest

type CloneUDiskRequest struct {
	request.CommonBase

	// 实例名称
	Name *string `required:"true"`

	// 克隆父Disk的Id
	SourceId *string `required:"true"`

	// 方舟是否开启,"Yes":开启,"No":关闭;默认为"No"
	UDataArkMode *string `required:"false"`

	// 购买时长 默认: 1
	Quantity *int `required:"false"`

	// Disk注释
	Comment *string `required:"false"`

	// Year , Month, Dynamic 默认: Dynamic
	ChargeType *string `required:"false"`

	// 使用的代金券id
	CouponId *string `required:"false"`
}

CloneUDiskRequest is request schema for CloneUDisk action

type CloneUDiskResponse

type CloneUDiskResponse struct {
	response.CommonBase

	// 创建UDisk Id
	UDiskId []string
}

CloneUDiskResponse is response schema for CloneUDisk action

type CloneUDiskSnapshotRequest

type CloneUDiskSnapshotRequest struct {
	request.CommonBase

	// 实例名称
	Name *string `required:"true"`

	// 克隆父Snapshot的Id
	SourceId *string `required:"true"`

	// 购买UDisk大小,单位:GB,范围[1~2000], 权限位控制可达8T,若需要请申请开通相关权限。
	Size *int `required:"true"`

	// Disk注释
	Comment *string `required:"false"`

	// Year , Month, Dynamic 默认: Dynamic
	ChargeType *string `required:"false"`

	// 购买时长 默认: 1
	Quantity *int `required:"false"`

	// 是否开启数据方舟   默认:No
	UDataArkMode *string `required:"false"`

	// 使用的代金券id
	CouponId *string `required:"false"`
}

CloneUDiskSnapshotRequest is request schema for CloneUDiskSnapshot action

type CloneUDiskSnapshotResponse

type CloneUDiskSnapshotResponse struct {
	response.CommonBase

	// 创建UDisk Id
	UDiskId []string
}

CloneUDiskSnapshotResponse is response schema for CloneUDiskSnapshot action

type CreateUDiskRequest

type CreateUDiskRequest struct {
	request.CommonBase

	// 购买UDisk大小,单位:GB,普通盘: 范围[1~2000], 权限位控制可达8T,若需要请申请开通相关权限;SSD盘: 范围[1~4000]。
	Size *int `required:"true"`

	// 实例名称
	Name *string `required:"true"`

	// Year , Month, Dynamic, Trial 默认: Dynamic
	ChargeType *string `required:"false"`

	// 购买时长 默认: 1
	Quantity *int `required:"false"`

	// 是否开启数据方舟
	UDataArkMode *string `required:"false"`

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

	// UDisk 类型: DataDisk(普通数据盘),SSDDataDisk(SSD数据盘),RSSDDataDisk(RSSD数据盘),默认值(DataDisk)
	DiskType *string `required:"false"`

	// 使用的代金券id
	CouponId *string `required:"false"`
}

CreateUDiskRequest is request schema for CreateUDisk action

type CreateUDiskResponse

type CreateUDiskResponse struct {
	response.CommonBase

	// UDisk实例Id
	UDiskId []string
}

CreateUDiskResponse is response schema for CreateUDisk action

type CreateUDiskSnapshotRequest

type CreateUDiskSnapshotRequest struct {
	request.CommonBase

	// 快照的UDisk的Id
	UDiskId *string `required:"true"`

	// 快照名称
	Name *string `required:"true"`

	// Year , Month, Dynamic 默认: Dynamic
	ChargeType *string `required:"false"`

	// 购买时长 默认: 1
	Quantity *int `required:"false"`

	// 快照描述
	Comment *string `required:"false"`
}

CreateUDiskSnapshotRequest is request schema for CreateUDiskSnapshot action

type CreateUDiskSnapshotResponse

type CreateUDiskSnapshotResponse struct {
	response.CommonBase

	// 快照Id
	SnapshotId []string
}

CreateUDiskSnapshotResponse is response schema for CreateUDiskSnapshot action

type DeleteUDiskRequest

type DeleteUDiskRequest struct {
	request.CommonBase

	// 要删除的UDisk的Id
	UDiskId *string `required:"true"`
}

DeleteUDiskRequest is request schema for DeleteUDisk action

type DeleteUDiskResponse

type DeleteUDiskResponse struct {
	response.CommonBase
}

DeleteUDiskResponse is response schema for DeleteUDisk action

type DeleteUDiskSnapshotRequest

type DeleteUDiskSnapshotRequest struct {
	request.CommonBase

	// 快照Id
	SnapshotId *string `required:"true"`

	// UDisk Id,删除该盘所创建出来的所有快照
	UDiskId *string `required:"false"`
}

DeleteUDiskSnapshotRequest is request schema for DeleteUDiskSnapshot action

type DeleteUDiskSnapshotResponse

type DeleteUDiskSnapshotResponse struct {
	response.CommonBase
}

DeleteUDiskSnapshotResponse is response schema for DeleteUDiskSnapshot action

type DescribeUDiskPriceRequest

type DescribeUDiskPriceRequest struct {
	request.CommonBase

	// 购买UDisk大小,单位:GB,范围[1~1000]
	Size *int `required:"true"`

	// Year, Month, Dynamic,Trial,默认: Dynamic 如果不指定,则一次性获取三种计费
	ChargeType *string `required:"false"`

	// 购买UDisk的时长,默认值为1
	Quantity *int `required:"false"`

	// 是否打开数据方舟, 打开"Yes",关闭"No", 默认关闭
	UDataArkMode *string `required:"false"`

	// UDisk 类型: DataDisk(普通数据盘),SSDDataDisk(SSD数据盘),默认值(DataDisk)
	DiskType *string `required:"false"`
}

DescribeUDiskPriceRequest is request schema for DescribeUDiskPrice action

type DescribeUDiskPriceResponse

type DescribeUDiskPriceResponse struct {
	response.CommonBase

	// 价格参数列表,具体说明见 UDiskPriceDataSet
	DataSet []UDiskPriceDataSet
}

DescribeUDiskPriceResponse is response schema for DescribeUDiskPrice action

type DescribeUDiskRequest

type DescribeUDiskRequest struct {
	request.CommonBase

	// UDisk Id(留空返回全部)
	UDiskId *string `required:"false"`

	// 数据偏移量, 默认为0
	Offset *int `required:"false"`

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

	// 普通数据盘:DataDisk; 普通系统盘:SystemDisk; SSD数据盘:SSDDataDisk; RSSD数据盘:RSSDDataDisk; 为空拉取所有
	DiskType *string `required:"false"`
}

DescribeUDiskRequest is request schema for DescribeUDisk action

type DescribeUDiskResponse

type DescribeUDiskResponse struct {
	response.CommonBase

	// JSON 格式的UDisk数据列表, 每项参数可见下面 UDiskDataSet
	DataSet []UDiskDataSet

	// 根据过滤条件得到的总数
	TotalCount int
}

DescribeUDiskResponse is response schema for DescribeUDisk action

type DescribeUDiskSnapshotRequest

type DescribeUDiskSnapshotRequest struct {
	request.CommonBase

	// 数据偏移量, 默认为0
	Offset *int `required:"false"`

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

	// UDiskId,返回该盘所做快照.(必须同时传Zone)
	UDiskId *string `required:"false"`

	// 快照id,SnapshotId , UDiskId 同时传SnapshotId优先
	SnapshotId *string `required:"false"`
}

DescribeUDiskSnapshotRequest is request schema for DescribeUDiskSnapshot action

type DescribeUDiskSnapshotResponse

type DescribeUDiskSnapshotResponse struct {
	response.CommonBase

	// JSON 格式的Snapshot列表, 详细参见 UDiskSnapshotSet
	DataSet []UDiskSnapshotSet

	// 根据过滤条件得到的总数
	TotalCount int
}

DescribeUDiskSnapshotResponse is response schema for DescribeUDiskSnapshot action

type DescribeUDiskUpgradePriceRequest

type DescribeUDiskUpgradePriceRequest struct {
	request.CommonBase

	// 购买UDisk大小,单位:GB,范围[1~2000], 权限位控制可达8T,若需要请申请开通相关权限。
	Size *int `required:"true"`

	// 升级目标UDisk ID
	SourceId *string `required:"true"`

	// 是否打开数据方舟, 打开"Yes",关闭"No", 默认关闭
	UDataArkMode *string `required:"true"`

	// 磁盘类型,SSDDataDisk:ssd数据盘,DataDisk:普通数据盘。默认为DataDisk
	DiskType *string `required:"false"`
}

DescribeUDiskUpgradePriceRequest is request schema for DescribeUDiskUpgradePrice action

type DescribeUDiskUpgradePriceResponse

type DescribeUDiskUpgradePriceResponse struct {
	response.CommonBase

	// 价格
	Price float64
}

DescribeUDiskUpgradePriceResponse is response schema for DescribeUDiskUpgradePrice action

type DetachUDiskRequest

type DetachUDiskRequest struct {
	request.CommonBase

	// UHost实例ID
	UHostId *string `required:"true"`

	// 需要卸载的UDisk实例ID
	UDiskId *string `required:"true"`
}

DetachUDiskRequest is request schema for DetachUDisk action

type DetachUDiskResponse

type DetachUDiskResponse struct {
	response.CommonBase

	// 卸载的UHost实例ID
	UHostId string

	// 卸载的UDisk实例ID
	UDiskId string
}

DetachUDiskResponse is response schema for DetachUDisk action

type RenameUDiskRequest

type RenameUDiskRequest struct {
	request.CommonBase

	// 重命名的UDisk的Id
	UDiskId *string `required:"true"`

	// 重命名UDisk的name
	UDiskName *string `required:"true"`
}

RenameUDiskRequest is request schema for RenameUDisk action

type RenameUDiskResponse

type RenameUDiskResponse struct {
	response.CommonBase
}

RenameUDiskResponse is response schema for RenameUDisk action

type ResizeUDiskRequest

type ResizeUDiskRequest struct {
	request.CommonBase

	// UDisk Id
	UDiskId *string `required:"true"`

	// 调整后大小, 单位:GB, 范围[1~2000],权限位控制可达8000,若需要请申请开通相关权限。
	Size *int `required:"true"`

	// 使用的代金券id
	CouponId *string `required:"false"`
}

ResizeUDiskRequest is request schema for ResizeUDisk action

type ResizeUDiskResponse

type ResizeUDiskResponse struct {
	response.CommonBase
}

ResizeUDiskResponse is response schema for ResizeUDisk action

type RestoreUDiskRequest

type RestoreUDiskRequest struct {
	request.CommonBase

	// 需要恢复的盘id
	UDiskId *string `required:"true"`

	// 从指定的快照恢复
	SnapshotId *string `required:"false"`

	// 指定从方舟恢复的备份时间点
	SnapshotTime *int `required:"false"`
}

RestoreUDiskRequest is request schema for RestoreUDisk action

type RestoreUDiskResponse

type RestoreUDiskResponse struct {
	response.CommonBase
}

RestoreUDiskResponse is response schema for RestoreUDisk action

type SetUDiskUDataArkModeRequest

type SetUDiskUDataArkModeRequest struct {
	request.CommonBase

	// 需要设置数据方舟的UDisk的Id
	UDiskId *string `required:"true"`

	// 是否开启数据方舟,开启:"Yes", 不支持:"No"
	UDataArkMode *string `required:"true"`
}

SetUDiskUDataArkModeRequest is request schema for SetUDiskUDataArkMode action

type SetUDiskUDataArkModeResponse

type SetUDiskUDataArkModeResponse struct {
	response.CommonBase
}

SetUDiskUDataArkModeResponse is response schema for SetUDiskUDataArkMode action

type UDiskClient

type UDiskClient struct {
	*ucloud.Client
}

UDiskClient is the client of UDisk

func NewClient

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

NewClient will return a instance of UDiskClient

func (*UDiskClient) AttachUDisk

func (c *UDiskClient) AttachUDisk(req *AttachUDiskRequest) (*AttachUDiskResponse, error)

AttachUDisk - 将一个可用的UDisk挂载到某台主机上,当UDisk挂载成功后,还需要在主机内部进行文件系统操作

func (*UDiskClient) CloneUDisk

func (c *UDiskClient) CloneUDisk(req *CloneUDiskRequest) (*CloneUDiskResponse, error)

CloneUDisk - 从UDisk创建UDisk克隆

func (*UDiskClient) CloneUDiskSnapshot

CloneUDiskSnapshot - 从快照创建UDisk克隆

func (*UDiskClient) CreateUDisk

func (c *UDiskClient) CreateUDisk(req *CreateUDiskRequest) (*CreateUDiskResponse, error)

CreateUDisk - 创建UDisk磁盘

func (*UDiskClient) CreateUDiskSnapshot

CreateUDiskSnapshot - 创建snapshot快照

func (*UDiskClient) DeleteUDisk

func (c *UDiskClient) DeleteUDisk(req *DeleteUDiskRequest) (*DeleteUDiskResponse, error)

DeleteUDisk - 删除UDisk

func (*UDiskClient) DeleteUDiskSnapshot

DeleteUDiskSnapshot - 删除Snapshot

func (*UDiskClient) DescribeUDisk

func (c *UDiskClient) DescribeUDisk(req *DescribeUDiskRequest) (*DescribeUDiskResponse, error)

DescribeUDisk - 获取UDisk实例

func (*UDiskClient) DescribeUDiskPrice

DescribeUDiskPrice - 获取UDisk实例价格信息

func (*UDiskClient) DescribeUDiskSnapshot

DescribeUDiskSnapshot - 获取UDisk快照

func (*UDiskClient) DescribeUDiskUpgradePrice

DescribeUDiskUpgradePrice - 获取UDisk升级价格信息

func (*UDiskClient) DetachUDisk

func (c *UDiskClient) DetachUDisk(req *DetachUDiskRequest) (*DetachUDiskResponse, error)

DetachUDisk - 卸载某个已经挂载在指定UHost实例上的UDisk

func (*UDiskClient) NewAttachUDiskRequest

func (c *UDiskClient) NewAttachUDiskRequest() *AttachUDiskRequest

NewAttachUDiskRequest will create request of AttachUDisk action.

func (*UDiskClient) NewCloneUDiskRequest

func (c *UDiskClient) NewCloneUDiskRequest() *CloneUDiskRequest

NewCloneUDiskRequest will create request of CloneUDisk action.

func (*UDiskClient) NewCloneUDiskSnapshotRequest

func (c *UDiskClient) NewCloneUDiskSnapshotRequest() *CloneUDiskSnapshotRequest

NewCloneUDiskSnapshotRequest will create request of CloneUDiskSnapshot action.

func (*UDiskClient) NewCreateUDiskRequest

func (c *UDiskClient) NewCreateUDiskRequest() *CreateUDiskRequest

NewCreateUDiskRequest will create request of CreateUDisk action.

func (*UDiskClient) NewCreateUDiskSnapshotRequest

func (c *UDiskClient) NewCreateUDiskSnapshotRequest() *CreateUDiskSnapshotRequest

NewCreateUDiskSnapshotRequest will create request of CreateUDiskSnapshot action.

func (*UDiskClient) NewDeleteUDiskRequest

func (c *UDiskClient) NewDeleteUDiskRequest() *DeleteUDiskRequest

NewDeleteUDiskRequest will create request of DeleteUDisk action.

func (*UDiskClient) NewDeleteUDiskSnapshotRequest

func (c *UDiskClient) NewDeleteUDiskSnapshotRequest() *DeleteUDiskSnapshotRequest

NewDeleteUDiskSnapshotRequest will create request of DeleteUDiskSnapshot action.

func (*UDiskClient) NewDescribeUDiskPriceRequest

func (c *UDiskClient) NewDescribeUDiskPriceRequest() *DescribeUDiskPriceRequest

NewDescribeUDiskPriceRequest will create request of DescribeUDiskPrice action.

func (*UDiskClient) NewDescribeUDiskRequest

func (c *UDiskClient) NewDescribeUDiskRequest() *DescribeUDiskRequest

NewDescribeUDiskRequest will create request of DescribeUDisk action.

func (*UDiskClient) NewDescribeUDiskSnapshotRequest

func (c *UDiskClient) NewDescribeUDiskSnapshotRequest() *DescribeUDiskSnapshotRequest

NewDescribeUDiskSnapshotRequest will create request of DescribeUDiskSnapshot action.

func (*UDiskClient) NewDescribeUDiskUpgradePriceRequest

func (c *UDiskClient) NewDescribeUDiskUpgradePriceRequest() *DescribeUDiskUpgradePriceRequest

NewDescribeUDiskUpgradePriceRequest will create request of DescribeUDiskUpgradePrice action.

func (*UDiskClient) NewDetachUDiskRequest

func (c *UDiskClient) NewDetachUDiskRequest() *DetachUDiskRequest

NewDetachUDiskRequest will create request of DetachUDisk action.

func (*UDiskClient) NewRenameUDiskRequest

func (c *UDiskClient) NewRenameUDiskRequest() *RenameUDiskRequest

NewRenameUDiskRequest will create request of RenameUDisk action.

func (*UDiskClient) NewResizeUDiskRequest

func (c *UDiskClient) NewResizeUDiskRequest() *ResizeUDiskRequest

NewResizeUDiskRequest will create request of ResizeUDisk action.

func (*UDiskClient) NewRestoreUDiskRequest

func (c *UDiskClient) NewRestoreUDiskRequest() *RestoreUDiskRequest

NewRestoreUDiskRequest will create request of RestoreUDisk action.

func (*UDiskClient) NewSetUDiskUDataArkModeRequest

func (c *UDiskClient) NewSetUDiskUDataArkModeRequest() *SetUDiskUDataArkModeRequest

NewSetUDiskUDataArkModeRequest will create request of SetUDiskUDataArkMode action.

func (*UDiskClient) RenameUDisk

func (c *UDiskClient) RenameUDisk(req *RenameUDiskRequest) (*RenameUDiskResponse, error)

RenameUDisk - 重命名UDisk

func (*UDiskClient) ResizeUDisk

func (c *UDiskClient) ResizeUDisk(req *ResizeUDiskRequest) (*ResizeUDiskResponse, error)

ResizeUDisk - 调整UDisk容量

func (*UDiskClient) RestoreUDisk

func (c *UDiskClient) RestoreUDisk(req *RestoreUDiskRequest) (*RestoreUDiskResponse, error)

RestoreUDisk - 从备份恢复数据至UDisk

func (*UDiskClient) SetUDiskUDataArkMode

SetUDiskUDataArkMode - 设置UDisk数据方舟的状态

type UDiskDataSet

type UDiskDataSet struct {

	// 可用区
	Zone string

	// UDisk实例Id
	UDiskId string

	// 实例名称
	Name string

	// 容量单位GB
	Size int

	// 状态:Available(可用),Attaching(挂载中), InUse(已挂载), Detaching(卸载中), Initializating(分配中), Failed(创建失败),Cloning(克隆中),Restoring(恢复中),RestoreFailed(恢复失败),
	Status string

	// 创建时间
	CreateTime int

	// 过期时间
	ExpiredTime int

	// 挂载的UHost的Id
	UHostId string

	// 挂载的UHost的Name
	UHostName string

	// 挂载的UHost的IP
	UHostIP string

	// 挂载的设备名称
	DeviceName string

	// Year,Month,Dynamic,Trial
	ChargeType string

	// 业务组名称
	Tag string

	// 资源是否过期,过期:"Yes", 未过期:"No"
	IsExpire string

	// 是否支持数据方舟,支持:"2.0", 不支持:"1.0"
	Version string

	// 是否开启数据方舟,开启:"Yes", 不支持:"No"
	UDataArkMode string

	// 该盘快照个数
	SnapshotCount int

	// 该盘快照上限
	SnapshotLimit int

	// 云硬盘类型: 普通数据盘:DataDisk,普通系统盘:SystemDisk,SSD数据盘:SSDDataDisk,RSSD数据盘:RSSDDataDisk
	DiskType string

	// 是否支持克隆,1支持 ,0不支持
	CloneEnable int

	// 是否支持快照,1支持 ,0不支持
	SnapEnable int

	// 是否支持开启方舟,1支持 ,0不支持
	ArkSwitchEnable int
}

UDiskDataSet - DescribeUDisk

this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn for detail.

type UDiskPriceDataSet

type UDiskPriceDataSet struct {

	// Year, Month, Dynamic,Trial
	ChargeType string

	// 价格 (单位: 分)
	Price float64

	// "UDataArk","UDisk"
	ChargeName string
}

UDiskPriceDataSet - DescribeUDiskPrice

this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn for detail.

type UDiskSnapshotSet

type UDiskSnapshotSet struct {

	// 快照Id
	SnapshotId string

	// 快照名称
	Name string

	// 快照的源UDisk的Id
	UDiskId string

	// 快照的源UDisk的Name
	UDiskName string

	// 创建时间
	CreateTime int

	// 过期时间
	ExpiredTime int

	// 容量单位GB
	Size int

	// 快照描述
	Comment string

	// 快照状态,Normal:正常,Failed:失败,Creating:制作中
	Status string

	// 对应磁盘是否处于可用状态
	IsUDiskAvailable bool

	// 快照版本
	Version string

	// 对应磁盘制作快照时所挂载的主机
	UHostId string

	// 磁盘类型,0:数据盘,1:系统盘
	DiskType int
}

UDiskSnapshotSet - DescribeUDiskSnapshot

this model is auto created by ucloud code generater for open api, you can also see https://docs.ucloud.cn for detail.

Jump to

Keyboard shortcuts

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