ufs

package
v0.22.15 Latest Latest
Warning

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

Go to latest
Published: Mar 21, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package ufs include resources of ucloud ufs product

See also

for detail.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddUFSVolumeMountPointRequest added in v0.21.19

type AddUFSVolumeMountPointRequest struct {
	request.CommonBase

	// 挂载点名称
	MountPointName *string `required:"true"`

	// Subnet ID
	SubnetId *string `required:"true"`

	// 文件系统ID
	VolumeId *string `required:"true"`

	// Vpc ID
	VpcId *string `required:"true"`
}

AddUFSVolumeMountPointRequest is request schema for AddUFSVolumeMountPoint action

type AddUFSVolumeMountPointResponse added in v0.21.19

type AddUFSVolumeMountPointResponse struct {
	response.CommonBase
}

AddUFSVolumeMountPointResponse is response schema for AddUFSVolumeMountPoint action

type CreateUFSVolumeRequest

type CreateUFSVolumeRequest struct {
	request.CommonBase

	// 计费模式,枚举值为: Year,按年付费; Month,按月付费; Dynamic,按需付费(需开启权限); Trial,试用(需开启权限) 默认为Dynamic
	ChargeType *string `required:"false"`

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

	// 文件系统协议,目前仅支持NFSv4
	ProtocolType *string `required:"true"`

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

	// 备注
	Remark *string `required:"false"`

	// 文件系统大小,单位为GB,必须为100的整数倍,容量型Size最小为500GB,性能型文件系统Size最小为100GB
	Size *int `required:"true"`

	// 文件系统存储类型,Basic表示容量型,Advanced表示性能型
	StorageType *string `required:"true"`

	// 文件系统所属业务组
	Tag *string `required:"false"`

	// 文件系统名称
	VolumeName *string `required:"false"`
}

CreateUFSVolumeRequest is request schema for CreateUFSVolume action

type CreateUFSVolumeResponse

type CreateUFSVolumeResponse struct {
	response.CommonBase

	// 文件系统ID
	VolumeId string

	// 文件系统名称
	VolumeName string

	// 文件系统挂载点状态
	VolumeStatus string
}

CreateUFSVolumeResponse is response schema for CreateUFSVolume action

type DescribeUFSVolume2Request

type DescribeUFSVolume2Request struct {
	request.CommonBase

	// 文件列表长度
	Limit *int `required:"false"`

	// 文件列表起始
	Offset *int `required:"false"`

	// 文件系统ID
	VolumeId *string `required:"false"`
}

DescribeUFSVolume2Request is request schema for DescribeUFSVolume2 action

type DescribeUFSVolume2Response

type DescribeUFSVolume2Response struct {
	response.CommonBase

	// 文件系统详细信息列表
	DataSet []UFSVolumeInfo2

	// 文件系统总数
	TotalCount int
}

DescribeUFSVolume2Response is response schema for DescribeUFSVolume2 action

type DescribeUFSVolumeMountpointRequest added in v0.21.19

type DescribeUFSVolumeMountpointRequest struct {
	request.CommonBase

	// 文件系统ID
	VolumeId *string `required:"true"`
}

DescribeUFSVolumeMountpointRequest is request schema for DescribeUFSVolumeMountpoint action

type DescribeUFSVolumeMountpointResponse added in v0.21.19

type DescribeUFSVolumeMountpointResponse struct {
	response.CommonBase

	//
	DataSet []MountPointInfo

	// 文件系统能创建的最大挂载点数目
	MaxMountPointNum int

	// 目前的挂载点总数
	TotalMountPointNum int
}

DescribeUFSVolumeMountpointResponse is response schema for DescribeUFSVolumeMountpoint action

type DescribeUFSVolumePriceRequest added in v0.21.38

type DescribeUFSVolumePriceRequest struct {
	request.CommonBase

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

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

	// 文件系统大小,单位为GB,新架构容量型最小容量为500GB,以100GB递增,最大不超过100TB。新架构性能型最小容量为100GB,以100GB递增,最大不超过20TB
	Size *int `required:"true"`

	// 文件存储类型,枚举值,Basic表示容量型产品,Advanced表示性能型产品
	StorageType *string `required:"true"`

	// 文件系统id,第一次创建文件系统时不需要传这个参数
	VolumeId *string `required:"false"`
}

DescribeUFSVolumePriceRequest is request schema for DescribeUFSVolumePrice action

type DescribeUFSVolumePriceResponse added in v0.21.38

type DescribeUFSVolumePriceResponse struct {
	response.CommonBase

	// ufs 价格信息
	DataSet []UFSPriceDataSet
}

DescribeUFSVolumePriceResponse is response schema for DescribeUFSVolumePrice action

type ExtendUFSVolumeRequest

type ExtendUFSVolumeRequest struct {
	request.CommonBase

	// 文件系统大小,单位为GB,最大不超过20T,香港容量型必须为100的整数倍,Size最小为500GB,北京,上海,广州的容量型必须为1024的整数倍,Size最小为1024GB。性能型文件系统Size最小为100GB
	Size *int `required:"true"`

	// 文件系统ID
	VolumeId *string `required:"true"`
}

ExtendUFSVolumeRequest is request schema for ExtendUFSVolume action

type ExtendUFSVolumeResponse

type ExtendUFSVolumeResponse struct {
	response.CommonBase
}

ExtendUFSVolumeResponse is response schema for ExtendUFSVolume action

type MountPointInfo added in v0.21.19

type MountPointInfo struct {

	// 文件系统创建时间(unix时间戳)
	CreateTime int

	// ${挂载点IP}:/
	MountPointIp string

	// 挂载点名称
	MountPointName string

	// Subnet ID + 网段的形式,方便前端展示
	SubnetDescription string

	// Subnet ID
	SubnetId string

	// Vpc ID
	VpcId string
}

MountPointInfo - 挂载点信息

type RemoveUFSVolumeMountPointRequest added in v0.21.19

type RemoveUFSVolumeMountPointRequest struct {
	request.CommonBase

	// Subnet ID
	SubnetId *string `required:"true"`

	// 文件系统ID
	VolumeId *string `required:"true"`

	// Vpc ID
	VpcId *string `required:"true"`
}

RemoveUFSVolumeMountPointRequest is request schema for RemoveUFSVolumeMountPoint action

type RemoveUFSVolumeMountPointResponse added in v0.21.19

type RemoveUFSVolumeMountPointResponse struct {
	response.CommonBase
}

RemoveUFSVolumeMountPointResponse is response schema for RemoveUFSVolumeMountPoint action

type RemoveUFSVolumeRequest

type RemoveUFSVolumeRequest struct {
	request.CommonBase

	// 文件系统ID
	VolumeId *string `required:"true"`
}

RemoveUFSVolumeRequest is request schema for RemoveUFSVolume action

type RemoveUFSVolumeResponse

type RemoveUFSVolumeResponse struct {
	response.CommonBase
}

RemoveUFSVolumeResponse is response schema for RemoveUFSVolume action

type UFSClient

type UFSClient struct {
	*ucloud.Client
}

UFSClient is the client of UFS

func NewClient

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

NewClient will return a instance of UFSClient

func (*UFSClient) AddUFSVolumeMountPoint added in v0.21.19

API: AddUFSVolumeMountPoint

添加文件系统挂载点

func (*UFSClient) CreateUFSVolume

func (c *UFSClient) CreateUFSVolume(req *CreateUFSVolumeRequest) (*CreateUFSVolumeResponse, error)

API: CreateUFSVolume

创建文件系统

func (*UFSClient) DescribeUFSVolume2

func (c *UFSClient) DescribeUFSVolume2(req *DescribeUFSVolume2Request) (*DescribeUFSVolume2Response, error)

API: DescribeUFSVolume2

获取文件系统列表

func (*UFSClient) DescribeUFSVolumeMountpoint added in v0.21.19

API: DescribeUFSVolumeMountpoint

获取文件系统挂载点信息

func (*UFSClient) DescribeUFSVolumePrice added in v0.21.38

API: DescribeUFSVolumePrice

获取文件系统价格

func (*UFSClient) ExtendUFSVolume

func (c *UFSClient) ExtendUFSVolume(req *ExtendUFSVolumeRequest) (*ExtendUFSVolumeResponse, error)

API: ExtendUFSVolume

文件系统扩容

func (*UFSClient) NewAddUFSVolumeMountPointRequest added in v0.21.19

func (c *UFSClient) NewAddUFSVolumeMountPointRequest() *AddUFSVolumeMountPointRequest

NewAddUFSVolumeMountPointRequest will create request of AddUFSVolumeMountPoint action.

func (*UFSClient) NewCreateUFSVolumeRequest

func (c *UFSClient) NewCreateUFSVolumeRequest() *CreateUFSVolumeRequest

NewCreateUFSVolumeRequest will create request of CreateUFSVolume action.

func (*UFSClient) NewDescribeUFSVolume2Request

func (c *UFSClient) NewDescribeUFSVolume2Request() *DescribeUFSVolume2Request

NewDescribeUFSVolume2Request will create request of DescribeUFSVolume2 action.

func (*UFSClient) NewDescribeUFSVolumeMountpointRequest added in v0.21.19

func (c *UFSClient) NewDescribeUFSVolumeMountpointRequest() *DescribeUFSVolumeMountpointRequest

NewDescribeUFSVolumeMountpointRequest will create request of DescribeUFSVolumeMountpoint action.

func (*UFSClient) NewDescribeUFSVolumePriceRequest added in v0.21.38

func (c *UFSClient) NewDescribeUFSVolumePriceRequest() *DescribeUFSVolumePriceRequest

NewDescribeUFSVolumePriceRequest will create request of DescribeUFSVolumePrice action.

func (*UFSClient) NewExtendUFSVolumeRequest

func (c *UFSClient) NewExtendUFSVolumeRequest() *ExtendUFSVolumeRequest

NewExtendUFSVolumeRequest will create request of ExtendUFSVolume action.

func (*UFSClient) NewRemoveUFSVolumeMountPointRequest added in v0.21.19

func (c *UFSClient) NewRemoveUFSVolumeMountPointRequest() *RemoveUFSVolumeMountPointRequest

NewRemoveUFSVolumeMountPointRequest will create request of RemoveUFSVolumeMountPoint action.

func (*UFSClient) NewRemoveUFSVolumeRequest

func (c *UFSClient) NewRemoveUFSVolumeRequest() *RemoveUFSVolumeRequest

NewRemoveUFSVolumeRequest will create request of RemoveUFSVolume action.

func (*UFSClient) NewUpdateUFSVolumeInfoRequest added in v0.21.19

func (c *UFSClient) NewUpdateUFSVolumeInfoRequest() *UpdateUFSVolumeInfoRequest

NewUpdateUFSVolumeInfoRequest will create request of UpdateUFSVolumeInfo action.

func (*UFSClient) RemoveUFSVolume

func (c *UFSClient) RemoveUFSVolume(req *RemoveUFSVolumeRequest) (*RemoveUFSVolumeResponse, error)

API: RemoveUFSVolume

删除UFS文件系统

func (*UFSClient) RemoveUFSVolumeMountPoint added in v0.21.19

API: RemoveUFSVolumeMountPoint

删除文件系统挂载点

func (*UFSClient) UpdateUFSVolumeInfo added in v0.21.19

func (c *UFSClient) UpdateUFSVolumeInfo(req *UpdateUFSVolumeInfoRequest) (*UpdateUFSVolumeInfoResponse, error)

API: UpdateUFSVolumeInfo

更改文件系统相关信息(名称/备注)

type UFSPriceDataSet added in v0.21.38

type UFSPriceDataSet struct {

	// “UFS”
	ChargeName string

	// Year, Month, Dynamic,Trial
	ChargeType string

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

UFSPriceDataSet - ufs 价格信息

type UFSVolumeInfo2

type UFSVolumeInfo2 struct {

	// 文件系统创建时间(unix时间戳)
	CreateTime int

	// 文件系统过期时间(unix时间戳)
	ExpiredTime int

	// 是否过期
	IsExpired string

	// 文件系统允许创建的最大挂载点数目
	MaxMountPointNum int

	// 文件系统协议,枚举值,NFSv3表示NFS V3协议,NFSv4表示NFS V4协议
	ProtocolType string

	// 文件系统备注信息
	Remark string

	// 文件系统大小,单位GB
	Size int

	// 文件系统存储类型,枚举值,Basic表示容量型,Advanced表示性能型
	StorageType string

	// 文件系统所属业务组
	Tag string

	// 当前文件系统已创建的挂载点数目
	TotalMountPointNum int

	// 文件系统当前使用容量,单位GB
	UsedSize int

	// 文件系统ID
	VolumeId string

	// 文件系统名称
	VolumeName string
}

UFSVolumeInfo2 - 文件系统信息

type UpdateUFSVolumeInfoRequest added in v0.21.19

type UpdateUFSVolumeInfoRequest struct {
	request.CommonBase

	// 文件系统备注(文件系统名称/备注至少传入其中一个)
	Remark *string `required:"false"`

	// 文件系统ID
	VolumeId *string `required:"true"`

	// 文件系统名称(文件系统名称/备注至少传入其中一个)
	VolumeName *string `required:"false"`
}

UpdateUFSVolumeInfoRequest is request schema for UpdateUFSVolumeInfo action

type UpdateUFSVolumeInfoResponse added in v0.21.19

type UpdateUFSVolumeInfoResponse struct {
	response.CommonBase
}

UpdateUFSVolumeInfoResponse is response schema for UpdateUFSVolumeInfo action

Jump to

Keyboard shortcuts

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