udisk

package
v0.21.42 Latest Latest
Warning

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

 Go to latest Published: Aug 31, 2022 License: Apache-2.0 Imports: 4 Imported by: 5

Documentation

Overview

Package udisk include resources of ucloud udisk 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

	// Host实例ID
	HostId *string `required:"false"`

	// 是否允许多点挂载（Yes: 允许多点挂载， No: 不允许多点挂载， 不填默认Yes ）
	MultiAttach *string `required:"false"`

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

	// UHost实例ID。【UHostId和HostId必须选填一个，本字段即将废弃，建议使用HostId】
	UHostId *string `required:"false"`
}

AttachUDiskRequest is request schema for AttachUDisk action

type AttachUDiskResponse 

type AttachUDiskResponse struct {
	response.CommonBase

	// 挂载的设备名称
	DeviceName string

	// 挂载的Host实例ID
	HostId string

	// 挂载的UDisk实例ID
	UDiskId string

	// 挂载的UHost实例ID。【即将废弃，建议使用HostId】
	UHostId string
}

AttachUDiskResponse is response schema for AttachUDisk action

type CloneUDiskRequest 

type CloneUDiskRequest struct {
	request.CommonBase

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

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

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

	// Host实例ID。克隆出的云盘可直接挂载到该主机上。
	HostId *string `required:"false"`

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

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

	// RDMA集群id。指定RSSD云盘克隆到对应的RDMA集群。
	RdmaClusterId *string `required:"false"`

	// 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No
	SnapshotService *string `required:"false"`

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

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

	// 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No
	UDataArkMode *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

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

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

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

	// Host实例ID。克隆出的云盘可直接挂载到该主机上。
	HostId *string `required:"false"`

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

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

	// RDMA集群id。指定RSSD云盘克隆到对应的RDMA集群。
	RdmaClusterId *string `required:"false"`

	// 购买UDisk大小,单位:GB,范围[1~8000]。(UDisk大小设定对本地盘快照有效，对云盘快照无效)
	Size *int `required:"false"`

	// 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No
	SnapshotService *string `required:"false"`

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

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

	// 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No
	UDataArkMode *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 CloneUDiskUDataArkRequest added in v0.16.6 

type CloneUDiskUDataArkRequest struct {
	request.CommonBase

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

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

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

	// Host实例ID。克隆出的云盘可直接挂载到该主机上。
	HostId *string `required:"false"`

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

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

	// RDMA集群id。指定RSSD云盘克隆到对应的RDMA集群。
	RdmaClusterId *string `required:"false"`

	// 购买UDisk大小,单位:GB,范围[1~8000]。(UDisk大小设定对本地盘备份有效，对云盘备份无效)
	Size *int `required:"false"`

	// 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No
	SnapshotService *string `required:"false"`

	// 指定从方舟克隆的备份时间点
	SnapshotTime *int `required:"true"`

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

	// 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No
	UDataArkMode *string `required:"false"`

	// 需要克隆的源盘id
	UDiskId *string `required:"true"`
}

CloneUDiskUDataArkRequest is request schema for CloneUDiskUDataArk action

type CloneUDiskUDataArkResponse added in v0.16.6 

type CloneUDiskUDataArkResponse struct {
	response.CommonBase

	// 创建UDisk Id
	UDiskId []string
}

CloneUDiskUDataArkResponse is response schema for CloneUDiskUDataArk action

type CreateAttachUDiskRequest added in v0.16.4 

type CreateAttachUDiskRequest struct {
	request.CommonBase

	// Year , Month, Dynamic, Postpay, Trial 。 Size小于等于2000时，默认为Dynamic；Size大于2000时，默认为Month。
	ChargeType *string `required:"false"`

	// 加密需要的cmk id，UKmsMode为Yes时，必填
	CmkId *string `required:"false"`

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

	// UDisk 类型: DataDisk（普通数据盘），SSDDataDisk（SSD数据盘），RSSDDataDisk（RSSD数据盘），EfficiencyDataDisk（高效数据盘），默认值（DataDisk）
	DiskType *string `required:"false"`

	// Host实例ID。当创建云盘类型为RSSDDataDisk时，根据传入的HostId，创建与虚机在同一PodId下的云盘。
	HostId *string `required:"false"`

	// 是否允许多点挂载（Yes: 允许多点挂载， No: 不允许多点挂载， 不填默认Yes ）
	MultiAttach *string `required:"false"`

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

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

	// 购买UDisk大小,单位:GB,普通数据盘：范围[1~8000]；SSD数据盘：范围[1~8000]；RSSD数据盘：范围[1~32000]；高效数据盘：范围[1~32000]。
	Size *int `required:"true"`

	// 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No
	SnapshotService *string `required:"false"`

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

	// 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No
	UDataArkMode *string `required:"false"`

	// UHost实例ID。当创建云盘类型为RSSDDataDisk时，根据传入的UHostId，创建与虚机在同一PodId下的云盘。【UHostId和HostId必须选填一个，本字段即将废弃，建议使用HostId】
	UHostId *string `required:"false"`

	// 是否加密。Yes：加密，No：不加密，默认值（No）
	UKmsMode *string `required:"false"`
}

CreateAttachUDiskRequest is request schema for CreateAttachUDisk action

type CreateAttachUDiskResponse added in v0.16.4 

type CreateAttachUDiskResponse struct {
	response.CommonBase

	// 挂载设备名称
	DeviceName string

	// 挂载的Host实例ID
	HostId string

	// 挂载的UDisk实例ID
	UDiskId string

	// 挂载的UHost实例ID。【即将废弃，建议使用HostId】
	UHostId string
}

CreateAttachUDiskResponse is response schema for CreateAttachUDisk action

type CreateUDiskRequest 

type CreateUDiskRequest struct {
	request.CommonBase

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

	// 加密需要的cmk id，UKmsMode为Yes时，必填
	CmkId *string `required:"false"`

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

	// UDisk 类型: DataDisk（普通数据盘），SSDDataDisk（SSD数据盘），RSSDDataDisk（RSSD数据盘），EfficiencyDataDisk（高效数据盘），默认值（DataDisk）
	DiskType *string `required:"false"`

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

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

	// RDMA集群id。DiskType为RSSDDataDisk可填，指定云盘创建到对应的RDMA集群。
	RdmaClusterId *string `required:"false"`

	// 购买UDisk大小,单位:GB,普通数据盘：范围[1~8000]；SSD数据盘：范围[1~8000]；RSSD数据盘：范围[1~32000]；高效数据盘：范围[1~32000]。
	Size *int `required:"true"`

	// 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No
	SnapshotService *string `required:"false"`

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

	// 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No
	UDataArkMode *string `required:"false"`

	// 是否加密。Yes：加密，No：不加密，默认值（No）
	UKmsMode *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

	// Year , Month, Dynamic 默认: Dynamic  (已废弃)
	ChargeType *string `required:"false"`

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

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

	// 购买时长 默认: 1  (已废弃)
	Quantity *int `required:"false"`

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

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 added in v0.6.4 

type DeleteUDiskSnapshotRequest struct {
	request.CommonBase

	// 快照Id(填写后不能填写UDisk Id)
	SnapshotId *string `required:"false"`

	// UDisk Id,删除该盘所创建出来的所有快照(填写后不能填写SnapshotId)
	UDiskId *string `required:"false"`
}

DeleteUDiskSnapshotRequest is request schema for DeleteUDiskSnapshot action

type DeleteUDiskSnapshotResponse added in v0.6.4 

type DeleteUDiskSnapshotResponse struct {
	response.CommonBase
}

DeleteUDiskSnapshotResponse is response schema for DeleteUDiskSnapshot action

type DescribeRecycleUDiskRequest added in v0.16.6 

type DescribeRecycleUDiskRequest struct {
	request.CommonBase

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

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

DescribeRecycleUDiskRequest is request schema for DescribeRecycleUDisk action

type DescribeRecycleUDiskResponse added in v0.16.6 

type DescribeRecycleUDiskResponse struct {
	response.CommonBase

	// 回收站磁盘列表
	DataSet []RecycleUDiskSet

	// 磁盘数量
	TotalCount int
}

DescribeRecycleUDiskResponse is response schema for DescribeRecycleUDisk action

type DescribeUDiskPriceRequest 

type DescribeUDiskPriceRequest struct {
	request.CommonBase

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

	// UDisk 类型: DataDisk（普通数据盘），SSDDataDisk（SSD数据盘），RSSDDataDisk(RSSD数据盘)，EfficiencyDataDisk（高效数据盘），SystemDisk（普通系统盘），SSDSystemDisk（SSD系统盘），RSSDSystemDisk(RSSD系统盘)，EfficiencySystemDisk（高效系统盘），默认值（DataDisk）
	DiskType *string `required:"false"`

	// 是否将快照服务(数据方舟)，云硬盘放入一张订单, 是："Yes",否："No"，默认是"No"
	IsTotalPrice *string `required:"false"`

	// 云主机机型（V2.0），枚举值["N", "C", "G", "O", "OM"]。参考[[api:uhost-api:uhost_type|云主机机型说明]]。
	MachineType *string `required:"false"`

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

	// 购买UDisk大小,单位:GB,普通数据盘：范围[1~8000]；SSD数据盘：范围[1~8000]；普通系统盘：范围[1~8000]；SSD系统盘：范围[1~4000]；RSSD数据盘：范围[1~32000]；RSSD系统盘：范围[1~4000]；高效数据盘：范围[1~32000]；高效系统盘：范围[1~500]。
	Size *int `required:"true"`

	// 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No
	SnapshotService *string `required:"false"`

	// 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No
	UDataArkMode *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

	// ProtocolVersion字段为1时，需结合IsBoot确定具体磁盘类型:普通数据盘：DiskType:"CLOUD_NORMAL",IsBoot:"False"；普通系统盘：DiskType:"CLOUD_NORMAL",IsBoot:"True"；SSD数据盘：DiskType:"CLOUD_SSD",IsBoot:"False"；SSD系统盘：DiskType:"CLOUD_SSD",IsBoot:"True"；RSSD数据盘：DiskType:"CLOUD_RSSD",IsBoot:"False"；RSSD系统盘：DiskType:"CLOUD_RSSD",IsBoot:"True"；高效数据盘：DiskType:"CLOUD_EFFICIENCY",IsBoot:"False"；高效系统盘：DiskType:"CLOUD_EFFICIENCY",IsBoot:"True"；为空拉取所有。ProtocolVersion字段为0或没有该字段时，可设为以下几个值:普通数据盘：DataDisk；普通系统盘：SystemDisk；SSD数据盘：SSDDataDisk；SSD系统盘：SSDSystemDisk；RSSD数据盘：RSSDDataDisk；RSSD系统盘：RSSDSystemDisk：高效数据盘：EfficiencyDataDisk；高效系统盘：EfficiencySystemDisk；为空拉取所有。
	DiskType *string `required:"false"`

	// 根据传入的HostId，返回与该主机关联的云盘信息。
	HostId *string `required:"false"`

	// 根据传入的HostIdForAttachment，筛选出能被挂载在该主机上的云盘。目前主要针对RSSD云盘。
	HostIdForAttachment *string `required:"false"`

	// 宿主产品类型，可筛选挂载在该类型宿主上的云盘。可选值：uhost, uphost。为空拉取所有。（当HostIdForAttachment字段不为空时，该字段可以不填，若HostIdForAttachment与该字段宿主类型冲突，则以HostIdForAttachment字段为准。）
	HostProduct *string `required:"false"`

	// 是否忽略快照服务信息。Yes：忽略，No：不忽略，默认值（No）。（如不关心快照服务信息，建议选填“Yes”，可降低请求延时）
	IgnoreBackupMode *string `required:"false"`

	// 是否忽略计费信息。Yes：忽略，No：不忽略，默认值（No）。（如不关心账单信息，建议选填“Yes”，可降低请求延时）
	IgnoreUBillInfo *string `required:"false"`

	// ProtocolVersion字段为1且DiskType不为空时，必须设置，设置规则请参照DiskType；ProtocolVersion字段为1且DiskType为空时，该字段无效。ProtocolVersion字段为0或没有该字段时，该字段无效。
	IsBoot *string `required:"false"`

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

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

	// 请求协议版本，建议升级为1，为1时DiskType与UHost磁盘类型定义一致；默认为0
	ProtocolVersion *int `required:"false"`

	// 云盘状态。All(所有状态)，Available(可用)，Attaching(挂载中)，InUse(已挂载)， Detaching(卸载中)， Initializating(分配中)，Failed(创建失败)，Cloning(克隆中)，Restoring(恢复中)，RestoreFailed(恢复失败)。默认值：All
	Status *string `required:"false"`

	// 是否只返回云盘基础信息（只包含云盘及关联主机的资源信息）。Yes：是，No：否，默认值（No）。（如仅需要基础信息，建议选填“Yes”，可降低请求延时）
	UDiskBasicInfo *string `required:"false"`

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

	// 根据传入的UHostIdForAttachment，筛选出能被挂载在该主机上的云盘【本字段即将废弃，建议使用HostIdForAttachment】
	UHostIdForAttachment *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 added in v0.6.4 

type DescribeUDiskSnapshotRequest struct {
	request.CommonBase

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

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

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

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

DescribeUDiskSnapshotRequest is request schema for DescribeUDiskSnapshot action

type DescribeUDiskSnapshotResponse added in v0.6.4 

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 类型: DataDisk（普通数据盘），SSDDataDisk（SSD数据盘），RSSDDataDisk(RSSD数据盘)，EfficiencyDataDisk（高效数据盘），SystemDisk（普通系统盘），SSDSystemDisk（SSD系统盘），RSSDSystemDisk(RSSD系统盘)，EfficiencySystemDisk（高效系统盘），默认值（DataDisk）
	DiskType *string `required:"false"`

	// 【已废弃】云主机机型（V2.0），枚举值["N", "C", "G", "O", "OM"]。参考[[api:uhost-api:uhost_type|云主机机型说明]]。
	MachineType *string `required:"false"`

	// 购买UDisk大小,单位:GB,普通数据盘：范围[1~8000]；SSD数据盘：范围[1~8000]；普通系统盘：范围[1~8000]；SSD系统盘：范围[1~4000]；RSSD数据盘：范围[1~32000]；RSSD系统盘：范围[1~4000]；高效数据盘：范围[1~32000]；高效系统盘：范围[1~500]。
	Size *int `required:"true"`

	// 是否开启快照服务（开启快照服务，可免费开启数据方舟）。Yes：开启，No：不开启，默认值：No。仅支持查询开启快照服务的价格。
	SnapshotService *string `required:"false"`

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

	// 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No
	UDataArkMode *string `required:"false"`
}

DescribeUDiskUpgradePriceRequest is request schema for DescribeUDiskUpgradePrice action

type DescribeUDiskUpgradePriceResponse 

type DescribeUDiskUpgradePriceResponse struct {
	response.CommonBase

	// 用户折后价 (对应计费CustomPrice)
	OriginalPrice int

	// 价格
	Price int
}

DescribeUDiskUpgradePriceResponse is response schema for DescribeUDiskUpgradePrice action

type DetachUDiskRequest 

type DetachUDiskRequest struct {
	request.CommonBase

	// Host实例ID
	HostId *string `required:"false"`

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

	// UHost实例ID。【UHostId和HostId必须选填一个，本字段即将废弃，建议使用HostId】
	UHostId *string `required:"false"`
}

DetachUDiskRequest is request schema for DetachUDisk action

type DetachUDiskResponse 

type DetachUDiskResponse struct {
	response.CommonBase

	// 卸载的Host实例ID
	HostId string

	// 卸载的UDisk实例ID
	UDiskId string

	// 卸载的UHost实例ID。【即将废弃，建议使用HostId】
	UHostId string
}

DetachUDiskResponse is response schema for DetachUDisk action

type RecoverUDiskRequest added in v0.16.6 

type RecoverUDiskRequest struct {
	request.CommonBase

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

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

	// 云硬盘资源ID
	UDiskId *string `required:"true"`
}

RecoverUDiskRequest is request schema for RecoverUDisk action

type RecoverUDiskResponse added in v0.16.6 

type RecoverUDiskResponse struct {
	response.CommonBase
}

RecoverUDiskResponse is response schema for RecoverUDisk action

type RecycleUDiskSet added in v0.16.6 

type RecycleUDiskSet struct {

	// 销毁倒计时
	CountdownTime int

	// 创建时间
	CreateTime int

	// 过期时间
	ExpiredTime int

	// 磁盘名称
	Name string

	// 磁盘容量
	Size int

	// 业务组
	Tag string

	// 磁盘id
	UDiskId string

	// 可用区
	Zone string
}

RecycleUDiskSet - 回收站列表

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

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

	// 云主机机型（V2.0），枚举值["N", "C", "G", "O", "OM"]。参考[[api:uhost-api:uhost_type|云主机机型说明]]。
	MachineType *string `required:"false"`

	// 调整后大小, 单位:GB,普通数据盘：范围[1~8000]；SSD数据盘：范围[1~8000]；RSSD数据盘：范围[1~32000]。
	Size *int `required:"true"`

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

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

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

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

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

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

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

	// 【开启数据方舟入口已关闭】是否开启数据方舟。Yes：开启，No：不开启，默认值：No
	UDataArkMode *string `required:"false"`

	// 需要设置数据方舟的UDisk的Id
	UDiskId *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)

API: AttachUDisk

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

func (*UDiskClient) CloneUDisk 

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

API: CloneUDisk

从UDisk创建UDisk克隆

func (*UDiskClient) CloneUDiskSnapshot 

func (c *UDiskClient) CloneUDiskSnapshot(req *CloneUDiskSnapshotRequest) (*CloneUDiskSnapshotResponse, error)

API: CloneUDiskSnapshot

从快照创建UDisk克隆

func (*UDiskClient) CloneUDiskUDataArk added in v0.16.6 

func (c *UDiskClient) CloneUDiskUDataArk(req *CloneUDiskUDataArkRequest) (*CloneUDiskUDataArkResponse, error)

API: CloneUDiskUDataArk

从数据方舟的备份创建UDisk

func (*UDiskClient) CreateAttachUDisk added in v0.16.4 

func (c *UDiskClient) CreateAttachUDisk(req *CreateAttachUDiskRequest) (*CreateAttachUDiskResponse, error)

API: CreateAttachUDisk

创建并挂载UDisk磁盘

func (*UDiskClient) CreateUDisk 

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

API: CreateUDisk

创建UDisk磁盘

func (*UDiskClient) CreateUDiskSnapshot 

func (c *UDiskClient) CreateUDiskSnapshot(req *CreateUDiskSnapshotRequest) (*CreateUDiskSnapshotResponse, error)

API: CreateUDiskSnapshot

创建snapshot快照

func (*UDiskClient) DeleteUDisk 

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

API: DeleteUDisk

删除UDisk

func (*UDiskClient) DeleteUDiskSnapshot added in v0.6.4 

func (c *UDiskClient) DeleteUDiskSnapshot(req *DeleteUDiskSnapshotRequest) (*DeleteUDiskSnapshotResponse, error)

API: DeleteUDiskSnapshot

删除Snapshot

func (*UDiskClient) DescribeRecycleUDisk added in v0.16.6 

func (c *UDiskClient) DescribeRecycleUDisk(req *DescribeRecycleUDiskRequest) (*DescribeRecycleUDiskResponse, error)

API: DescribeRecycleUDisk

拉取回收站中云硬盘列表

func (*UDiskClient) DescribeUDisk 

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

API: DescribeUDisk

获取UDisk实例

func (*UDiskClient) DescribeUDiskPrice 

func (c *UDiskClient) DescribeUDiskPrice(req *DescribeUDiskPriceRequest) (*DescribeUDiskPriceResponse, error)

API: DescribeUDiskPrice

获取UDisk实例价格信息

func (*UDiskClient) DescribeUDiskSnapshot added in v0.6.4 

func (c *UDiskClient) DescribeUDiskSnapshot(req *DescribeUDiskSnapshotRequest) (*DescribeUDiskSnapshotResponse, error)

API: DescribeUDiskSnapshot

获取UDisk快照

func (*UDiskClient) DescribeUDiskUpgradePrice 

func (c *UDiskClient) DescribeUDiskUpgradePrice(req *DescribeUDiskUpgradePriceRequest) (*DescribeUDiskUpgradePriceResponse, error)

API: DescribeUDiskUpgradePrice

获取UDisk升级价格信息

func (*UDiskClient) DetachUDisk 

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

API: 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) NewCloneUDiskUDataArkRequest added in v0.16.6 

func (c *UDiskClient) NewCloneUDiskUDataArkRequest() *CloneUDiskUDataArkRequest

NewCloneUDiskUDataArkRequest will create request of CloneUDiskUDataArk action.

func (*UDiskClient) NewCreateAttachUDiskRequest added in v0.16.4 

func (c *UDiskClient) NewCreateAttachUDiskRequest() *CreateAttachUDiskRequest

NewCreateAttachUDiskRequest will create request of CreateAttachUDisk 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 added in v0.6.4 

func (c *UDiskClient) NewDeleteUDiskSnapshotRequest() *DeleteUDiskSnapshotRequest

NewDeleteUDiskSnapshotRequest will create request of DeleteUDiskSnapshot action.

func (*UDiskClient) NewDescribeRecycleUDiskRequest added in v0.16.6 

func (c *UDiskClient) NewDescribeRecycleUDiskRequest() *DescribeRecycleUDiskRequest

NewDescribeRecycleUDiskRequest will create request of DescribeRecycleUDisk 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 added in v0.6.4 

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) NewRecoverUDiskRequest added in v0.16.6 

func (c *UDiskClient) NewRecoverUDiskRequest() *RecoverUDiskRequest

NewRecoverUDiskRequest will create request of RecoverUDisk 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) RecoverUDisk added in v0.16.6 

func (c *UDiskClient) RecoverUDisk(req *RecoverUDiskRequest) (*RecoverUDiskResponse, error)

API: RecoverUDisk

从回收站中恢复云硬盘

func (*UDiskClient) RenameUDisk 

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

API: RenameUDisk

重命名UDisk

func (*UDiskClient) ResizeUDisk 

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

API: ResizeUDisk

调整UDisk容量

func (*UDiskClient) RestoreUDisk 

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

API: RestoreUDisk

从备份恢复数据至UDisk

func (*UDiskClient) SetUDiskUDataArkMode 

func (c *UDiskClient) SetUDiskUDataArkMode(req *SetUDiskUDataArkModeRequest) (*SetUDiskUDataArkModeResponse, error)

API: SetUDiskUDataArkMode

设置UDisk数据方舟的状态

type UDiskDataSet 

type UDiskDataSet struct {

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

	// 该盘的备份方式。快照服务："SnapshotService"；数据方舟："UDataArk"；无备份方式：""
	BackupMode string

	// Year,Month,Dynamic,Trial,Postpay
	ChargeType string

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

	// 该盘的cmk id
	CmkId string

	// cmk id 别名
	CmkIdAlias string

	// 该盘cmk的状态, Enabled(正常)，Disabled(失效)，Deleted(删除)，NoCmkId(非加密盘)
	CmkIdStatus string

	// 创建时间
	CreateTime int

	// 该盘的密文密钥
	DataKey string

	// 挂载的设备名称
	DeviceName string

	// 请求中的ProtocolVersion字段为1时，需结合IsBoot确定具体磁盘类型:普通数据盘：DiskType:"CLOUD_NORMAL",IsBoot:"False"； 普通系统盘：DiskType:"CLOUD_NORMAL",IsBoot:"True"；SSD数据盘：DiskType:"CLOUD_SSD",IsBoot:"False"；SSD系统盘：DiskType:"CLOUD_SSD",IsBoot:"True"；RSSD数据盘：DiskType:"CLOUD_RSSD",IsBoot:"False"；RSSD系统盘：DiskType:"CLOUD_RSSD",IsBoot:"True"；高效数据盘：DiskType:"CLOUD_EFFICIENCY",IsBoot:"False"；高效系统盘：DiskType:"CLOUD_EFFICIENCY",IsBoot:"True"。请求中的ProtocolVersion字段为0或没有该字段时，云硬盘类型参照如下:普通数据盘：DataDisk；普通系统盘：SystemDisk；SSD数据盘：SSDDataDisk；SSD系统盘：SSDSystemDisk；RSSD数据盘：RSSDDataDisk；RSSD系统盘：RSSDSystemDisk；高效数据盘：EfficiencyDataDisk；高效系统盘：EfficiencySystemDisk。
	DiskType string

	// 过期时间
	ExpiredTime int

	// 挂载的Host的IP
	HostIP string

	// 挂载的Host的Id
	HostId string

	// 挂载的Host的Name
	HostName string

	// 是否是系统盘，是："True", 否："False"
	IsBoot string

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

	// 实例名称
	Name string

	// RDMA集群id，仅RSSD返回该值；其他类型云盘返回""。当云盘的此值与快杰云主机的RdmaClusterId相同时，RSSD可以挂载到这台云主机。
	RdmaClusterId string

	// 容量单位GB
	Size int

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

	// 该盘快照个数
	SnapshotCount int

	// 该盘快照上限
	SnapshotLimit int

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

	// 业务组名称
	Tag string

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

	// UDisk实例Id
	UDiskId string

	// 挂载的UHost的IP。【即将废弃，建议使用HostIP】
	UHostIP string

	// 挂载的UHost的Id。【即将废弃，建议使用HostId】
	UHostId string

	// 挂载的UHost的Name。【即将废弃，建议使用HostName】
	UHostName string

	// 是否是加密盘，是:"Yes", 否:"No"
	UKmsMode string

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

	// 可用区
	Zone string
}

UDiskDataSet - DescribeUDisk

type UDiskPriceDataSet 

type UDiskPriceDataSet struct {

	// "UDataArk","SnapshotService","UDisk","Total"
	ChargeName string

	// Year， Month， Dynamic，Trial
	ChargeType string

	// 原价(对应计费OriginalPrice)
	ListPrice int

	// 用户折后价(对应计费CustomPrice)
	OriginalPrice int

	// 实际价格 (单位: 分)
	Price int
}

UDiskPriceDataSet - DescribeUDiskPrice

type UDiskSnapshotSet added in v0.6.4 

type UDiskSnapshotSet struct {

	// 该快照的cmk id
	CmkId string

	// cmk id 别名
	CmkIdAlias string

	// 该快照cmk的状态, Enabled(正常)，Disabled(失效)，Deleted(删除)，NoCmkId(非加密盘)
	CmkIdStatus string

	// 快照描述
	Comment string

	// 创建时间
	CreateTime int

	// 该快照的密文密钥
	DataKey string

	// 磁盘类型，0：普通数据盘；1：普通系统盘；2：SSD数据盘；3：SSD系统盘；4：RSSD数据盘；5：RSSD系统盘。
	DiskType int

	// 过期时间
	ExpiredTime int

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

	// 快照名称
	Name string

	// 容量单位GB
	Size int

	// 快照Id
	SnapshotId string

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

	// 快照的源UDisk的Id
	UDiskId string

	// 快照的源UDisk的Name
	UDiskName string

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

	// 是否是加密盘快照，是:"Yes", 否:"No"
	UKmsMode string

	// 快照版本
	Version string

	// 可用区
	Zone string
}

UDiskSnapshotSet - DescribeUDiskSnapshot

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.