ufs

Documentation

Overview

Package ufs include resources of ucloud ufs product

See also

• API: https://docs.ucloud.cn/api/ufs-api/index
• Product: https://www.ucloud.cn/site/product/ufs.html

for detail.

Index

• type CreateUFSVolumeRequest
• type CreateUFSVolumeResponse
• type DescribeUFSVolume2Request
• type DescribeUFSVolume2Response
• type ExtendUFSVolumeRequest
• type ExtendUFSVolumeResponse
• type RemoveUFSVolumeRequest
• type RemoveUFSVolumeResponse
• type UFSClient
  • func NewClient(config *ucloud.Config, credential *auth.Credential) *UFSClient
  • func (c *UFSClient) CreateUFSVolume(req *CreateUFSVolumeRequest) (*CreateUFSVolumeResponse, error)
  • func (c *UFSClient) DescribeUFSVolume2(req *DescribeUFSVolume2Request) (*DescribeUFSVolume2Response, error)
  • func (c *UFSClient) ExtendUFSVolume(req *ExtendUFSVolumeRequest) (*ExtendUFSVolumeResponse, error)
  • func (c *UFSClient) NewCreateUFSVolumeRequest() *CreateUFSVolumeRequest
  • func (c *UFSClient) NewDescribeUFSVolume2Request() *DescribeUFSVolume2Request
  • func (c *UFSClient) NewExtendUFSVolumeRequest() *ExtendUFSVolumeRequest
  • func (c *UFSClient) NewRemoveUFSVolumeRequest() *RemoveUFSVolumeRequest
  • func (c *UFSClient) RemoveUFSVolume(req *RemoveUFSVolumeRequest) (*RemoveUFSVolumeResponse, error)
• type UFSVolumeInfo2

Types

type CreateUFSVolumeRequest

type CreateUFSVolumeRequest struct {
	request.CommonBase

	// 计费模式，枚举值为： Year，按年付费； Month，按月付费； Dynamic，按需付费（需开启权限）； Trial，试用（需开启权限） 默认为Dynamic
	ChargeType *string `required:"false"`

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

	// 文件系统协议，枚举值，NFSv3表示NFS V3协议，NFSv4表示NFS V4协议
	ProtocolType *string `required:"true"`

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

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

	// 文件系统大小，单位为GB，最大不超过20T，香港容量型必须为100的整数倍，Size最小为500GB，北京，上海，广州的容量型必须为1024的整数倍，Size最小为1024GB。性能型文件系统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 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 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) 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) ExtendUFSVolume

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

API: ExtendUFSVolume

文件系统扩容

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) NewExtendUFSVolumeRequest

func (c *UFSClient) NewExtendUFSVolumeRequest() *ExtendUFSVolumeRequest

NewExtendUFSVolumeRequest will create request of ExtendUFSVolume action.

func (*UFSClient) NewRemoveUFSVolumeRequest

func (c *UFSClient) NewRemoveUFSVolumeRequest() *RemoveUFSVolumeRequest

NewRemoveUFSVolumeRequest will create request of RemoveUFSVolume action.

func (*UFSClient) RemoveUFSVolume

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

API: RemoveUFSVolume

删除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 - 文件系统信息