API 中心

文档中心 API 中心文件存储数据结构

数据结构

最近更新时间：2024-04-26 01:10:35

我的收藏

本页目录：

AutoSnapshotPolicyInfo

快照策略信息

被如下接口引用：DescribeAutoSnapshotPolicies。

名称	类型	描述
AutoSnapshotPolicyId	String	快照策略ID 示例值：asp-xx
PolicyName	String	快照策略ID 示例值：default
CreationTime	String	快照策略创建时间示例值：2020-05-23 19:00:45
FileSystemNums	Integer	关联的文件系统个数示例值：2
DayOfWeek	String	快照定期备份在一星期哪一天，该参数与DayOfMonth,IntervalDays互斥示例值：'1,2'
Hour	String	快照定期备份在一天的哪一小时示例值：'3,4'
IsActivated	Integer	是否激活定期快照功能,1代表已激活，0代表未激活示例值：1
NextActiveTime	String	下一次触发快照时间示例值：2020-05-25 19:00:45
Status	String	快照策略状态，1代表快照策略状态正常。这里只有一种状态示例值：1
AppId	Integer	账号ID 示例值：122445
AliveDays	Integer	保留时间示例值：3
RegionName	String	地域示例值：ap-guangzhou
FileSystems	Array of FileSystemByPolicy	文件系统信息示例值：112
DayOfMonth	String	快照定期备份在一个月的某个时间；该参数与DayOfWeek,IntervalDays互斥注意：此字段可能返回 null，表示取不到有效值。示例值：'1,2,3,4'
IntervalDays	Integer	快照定期间隔天数，1-365 天；该参数与DayOfMonth,DayOfWeek互斥注意：此字段可能返回 null，表示取不到有效值。示例值：20
CrossRegionsAliveDays	Integer	跨地域复制的快照保留时间，单位天示例值：10

AvailableProtoStatus

版本控制-协议详情

被如下接口引用：DescribeAvailableZoneInfo。

名称	类型	描述
SaleStatus	String	售卖状态。可选值有 sale_out 售罄、saling可售、no_saling不可销售
Protocol	String	协议类型。可选值有 NFS、CIFS、TURBO

AvailableRegion

版本控制-区域数组

被如下接口引用：DescribeAvailableZoneInfo。

名称	类型	描述
Region	String	区域名称，如“ap-beijing”
RegionName	String	区域名称，如“bj”
RegionStatus	String	区域可用情况，当区域内至少有一个可用区处于可售状态时，取值为AVAILABLE，否则为UNAVAILABLE
Zones	Array of AvailableZone	可用区数组
RegionCnName	String	区域中文名称，如“广州”

AvailableType

版本控制-类型数组

被如下接口引用：DescribeAvailableZoneInfo。

名称	类型	描述
Protocols	Array of AvailableProtoStatus	协议与售卖详情示例值：NFS
Type	String	存储类型。返回值中 SD 为通用标准型存储， HP为通用性能型存储， TB为Turbo标准型， TP 为Turbo性能型。示例值：SD
Prepayment	Boolean	是否支持预付费。返回值中 true 为支持、false 为不支持示例值：true

AvailableZone

版本控制-可用区数组

被如下接口引用：DescribeAvailableZoneInfo。

名称	类型	描述
Zone	String	可用区名称示例值：ap-beijing-1
ZoneId	Integer	可用区ID 示例值：800001
ZoneCnName	String	可用区中文名称示例值：北京一区
Types	Array of AvailableType	Type数组
ZoneName	String	可用区中英文名称示例值：北京一区

BucketInfo

对象存储桶

被如下接口引用：DescribeBucketList。

名称	类型	描述
Name	String	桶名称示例值：name
Region	String	桶所在地域注意：此字段可能返回 null，表示取不到有效值。示例值：region

FileSystemByPolicy

绑定快照策略的文件系统信息

被如下接口引用：DescribeAutoSnapshotPolicies。

名称	类型	描述
CreationToken	String	文件系统名称示例值：default
FileSystemId	String	文件系统ID 示例值：cfs-xx
SizeByte	Integer	文件系统大小，单位Byte 示例值：1
StorageType	String	存储类型，HP：通用性能型；SD：通用标准型；TP:turbo性能型；TB：turbo标准型；THP：吞吐型示例值：HP
TotalSnapshotSize	Integer	快照总大小，单位GiB 示例值：1
CreationTime	String	文件系统创建时间示例值：2022-08-20 11:22:33
ZoneId	Integer	文件系统所在区ID 示例值：100001

FileSystemClient

文件系统客户端信息

被如下接口引用：DescribeCfsFileSystemClients。

名称	类型	描述
CfsVip	String	文件系统IP地址
ClientIp	String	客户端IP地址
VpcId	String	文件系统所属VPCID
Zone	String	可用区名称，例如ap-beijing-1，请参考概览文档中的地域与可用区列表
ZoneName	String	可用区中文名称
MountDirectory	String	该文件系统被挂载到客户端上的路径信息

FileSystemInfo

文件系统基本信息

被如下接口引用：DescribeCfsFileSystems。

名称	类型	描述
CreationTime	String	创建时间示例值：2020-08-11 20:57:17
CreationToken	String	用户自定义名称示例值：default
FileSystemId	String	文件系统 ID 示例值：cfs-xx
LifeCycleState	String	文件系统状态。取值范围： - creating:创建中 - mounting:挂载中 - create_failed:创建失败 - available:可使用 - unserviced:停服中 - upgrading:升级中示例值：creating
SizeByte	Integer	文件系统已使用容量。单位：Byte 示例值：10
SizeLimit	Integer	文件系统空间限制。单位:GiB 示例值：50
ZoneId	Integer	区域 ID 示例值：100001
Zone	String	区域名称示例值：ap-guangzhou-1
Protocol	String	文件系统协议类型, 支持 NFS,CIFS,TURBO 示例值：SMB
StorageType	String	存储类型，HP：通用性能型；SD：通用标准型；TP:turbo性能型；TB：turbo标准型；THP：吞吐型示例值：HP
StorageResourcePkg	String	文件系统绑定的预付费存储包示例值：cfspkg-xx
BandwidthResourcePkg	String	文件系统绑定的预付费带宽包（暂未支持）示例值：cfspkg-xx
PGroup	PGroup	文件系统绑定权限组信息示例值：pgroupbasic
FsName	String	用户自定义名称示例值：default
Encrypted	Boolean	文件系统是否加密,true：代表加密，false：非加密示例值：true
KmsKeyId	String	加密所使用的密钥，可以为密钥的 ID 或者 ARN
AppId	Integer	应用ID 示例值：1000443xxxx
BandwidthLimit	Float	文件系统吞吐上限，吞吐上限是根据文件系统当前已使用存储量、绑定的存储资源包以及吞吐资源包一同确定. 单位MiB/s 示例值：100
Capacity	Integer	文件系统容量规格上限单位:GiB 示例值：100
Tags	Array of TagInfo	文件系统标签列表示例值："TagKey": "xxxxx", "TagValue": "xxxxx"
TieringState	String	文件系统生命周期管理状态 NotAvailable：不可用 Available:可用示例值：NotAvailable
TieringDetail	TieringDetailInfo	分层存储详情注意：此字段可能返回 null，表示取不到有效值。示例值："TieringSizeInBytes": 0

Filter

条件过滤

被如下接口引用：DescribeAutoSnapshotPolicies, DescribeCfsSnapshots, DescribeMigrationTasks, DescribeUserQuota。

名称	类型	必选	描述
Values	Array of String	是	值示例值：cfs-12345
Name	String	是	名称示例值：cfsId

MigrationTaskInfo

CFS数据迁移任务信息

被如下接口引用：DescribeMigrationTasks。

名称	类型	描述
TaskName	String	迁移任务名称示例值：name
TaskId	String	迁移任务id 示例值：migrate-001
MigrationType	Integer	迁移方式标志位，默认为0。0: 桶迁移；1: 清单迁移示例值：0
MigrationMode	Integer	迁移模式，默认为0。0: 全量迁移示例值：0
BucketName	String	数据源桶名称注意：此字段可能返回 null，表示取不到有效值。示例值：xx-123455
BucketRegion	String	数据源桶地域注意：此字段可能返回 null，表示取不到有效值。示例值：ap-guangzhou
BucketAddress	String	数据源桶地址注意：此字段可能返回 null，表示取不到有效值。示例值：https://xx-12345.cos.ap-shanghai.myqcloud.com
ListAddress	String	清单地址注意：此字段可能返回 null，表示取不到有效值。示例值：https://xx-12345.cos.ap-shanghai.myqcloud.com/list.csv
FsName	String	文件系统实例名称注意：此字段可能返回 null，表示取不到有效值。示例值：testcfs
FileSystemId	String	文件系统实例Id 示例值：cfs-xxxx
FsPath	String	文件系统路径示例值：/cfs/test
CoverType	Integer	同名文件迁移时覆盖策略，默认为0。0: 最后修改时间优先；1: 全覆盖；2: 不覆盖示例值：0
CreateTime	Integer	创建时间示例值：2023-01-09 15:03:57
EndTime	Integer	完成/终止时间注意：此字段可能返回 null，表示取不到有效值。示例值：2023-01-20 15:03:57
Status	Integer	迁移状态。0: 已完成；1: 进行中；2: 已终止示例值：0
FileTotalCount	Integer	文件数量注意：此字段可能返回 null，表示取不到有效值。示例值：10
FileMigratedCount	Integer	已迁移文件数量注意：此字段可能返回 null，表示取不到有效值。示例值：10
FileFailedCount	Integer	迁移失败文件数量注意：此字段可能返回 null，表示取不到有效值。示例值：10
FileTotalSize	Integer	文件容量，单位Byte 注意：此字段可能返回 null，表示取不到有效值。示例值：1024
FileMigratedSize	Integer	已迁移文件容量，单位Byte 注意：此字段可能返回 null，表示取不到有效值。示例值：1024
FileFailedSize	Integer	迁移失败文件容量，单位Byte 注意：此字段可能返回 null，表示取不到有效值。示例值：512
FileTotalList	String	全部清单注意：此字段可能返回 null，表示取不到有效值。示例值：https://cfs-migrate-xxxxx.cos.ap-chongqing.myqcloud.com/cfs-migrate-results/cfsmigrate-3d2cf062
FileCompletedList	String	已完成文件清单注意：此字段可能返回 null，表示取不到有效值。示例值：https://cfs-migrate-xxxxx.cos.ap-chongqing.myqcloud.com/cfs-migrate-results/cfsmigrate-3d2cf062
FileFailedList	String	失败文件清单注意：此字段可能返回 null，表示取不到有效值。示例值：https://cfs-migrate-xxxxx.cos.ap-chongqing.myqcloud.com/cfs-migrate-results/cfsmigrate-3d2cf062
BucketPath	String	源桶路径注意：此字段可能返回 null，表示取不到有效值。示例值：https://xx-12345.cos.ap-shanghai.myqcloud.com

MountInfo

挂载点信息

被如下接口引用：DescribeMountTargets。

名称	类型	描述
FileSystemId	String	文件系统 ID 示例值：cfs-hge16re9
MountTargetId	String	挂载点 ID 示例值：mount-0ylt3o7o
IpAddress	String	挂载点 IP 示例值：10.1.0.7
FSID	String	挂载根目录示例值：fwsuvz0l
LifeCycleState	String	挂载点状态示例值：available
NetworkInterface	String	网络类型示例值：VPC
VpcId	String	私有网络 ID 示例值：vpc-hq13cw04
VpcName	String	私有网络名称示例值：qcloudtest
SubnetId	String	子网 Id 示例值：subnet-jdl08no5
SubnetName	String	子网名称示例值：qcloudtest
CcnID	String	CFS Turbo使用的云联网ID 示例值：ccn-1xhbcp41
CidrBlock	String	云联网中CFS Turbo使用的网段示例值：10.0.0.0/24

PGroup

文件系统绑定权限组信息

被如下接口引用：DescribeCfsFileSystems。

名称	类型	描述
PGroupId	String	权限组ID
Name	String	权限组名称

PGroupInfo

权限组数组

被如下接口引用：DescribeCfsPGroups。

名称	类型	描述
PGroupId	String	权限组ID
Name	String	权限组名称
DescInfo	String	描述信息
CDate	String	创建时间
BindCfsNum	Integer	关联文件系统个数

PGroupRuleInfo

权限组规则列表

被如下接口引用：DescribeCfsRules。

名称	类型	描述
RuleId	String	规则ID
AuthClientIp	String	允许访问的客户端IP
RWPermission	String	读写权限, ro为只读，rw为读写
UserPermission	String	all_squash：所有访问用户（含 root 用户）都会被映射为匿名用户或用户组。 no_all_squash：所有访问用户（含 root 用户）均保持原有的 UID/GID 信息。 root_squash：将来访的 root 用户映射为匿名用户或用户组，非 root 用户保持原有的 UID/GID 信息。 no_root_squash：与 no_all_squash 效果一致，所有访问用户（含 root 用户）均保持原有的 UID/GID 信息
Priority	Integer	规则优先级，1-100。其中 1 为最高，100为最低

SnapshotInfo

快照信息

被如下接口引用：DescribeCfsSnapshots。

名称	类型	描述
CreationTime	String	创建快照时间示例值：2020-09-16 16:34:33
SnapshotName	String	快照名称示例值：default
SnapshotId	String	快照ID 示例值：snapcfs-xx
Status	String	快照状态，createing-创建中；available-运行中；deleting-删除中；rollbacking-new 创建新文件系统中；create-failed 创建失败示例值：available
RegionName	String	地域名称示例值：ap-guangzhou
FileSystemId	String	文件系统ID 示例值：cfs-xx
Size	Integer	快照大小示例值：11
AliveDay	Integer	保留时长天示例值：12
Percent	Integer	快照进度百分比，1表示1% 示例值：1
AppId	Integer	账号ID 示例值：21211
DeleteTime	String	快照删除时间示例值：2020-10-01 16:34:33
FsName	String	文件系统名称示例值：default
Tags	Array of TagInfo	快照标签
SnapshotType	String	快照类型, general为通用系列快照，turbo为Turbo系列快照注意：此字段可能返回 null，表示取不到有效值。示例值：turbo
SnapshotTime	String	实际快照时间，反应快照对应文件系统某个时刻的数据。注意：此字段可能返回 null，表示取不到有效值。示例值：2023-05-16 14:45:15

SnapshotOperateLog

快照操作日志

被如下接口引用：DescribeSnapshotOperationLogs。

名称	类型	描述
Action	String	操作类型 CreateCfsSnapshot：创建快照 DeleteCfsSnapshot：删除快照 CreateCfsFileSystem：创建文件系统 UpdateCfsSnapshotAttribute：更新快照示例值：CreateCfsSnapshot
ActionTime	String	操作时间示例值：2020-08-11 20:57:17
ActionName	String	操作名称 CreateCfsSnapshot DeleteCfsSnapshot CreateCfsFileSystem UpdateCfsSnapshotAttribute 示例值：UpdateCfsSnapshotAttribute
Operator	String	操作者uin 示例值：1000004435
Result	Integer	1-任务进行中；2-任务成功；3-任务失败示例值：2

SnapshotStatistics

文件系统快照统计

被如下接口引用：DescribeCfsSnapshotOverview。

名称	类型	描述
Region	String	地域示例值：ap-guangzhou
SnapshotNumber	Integer	快照总个数示例值：2
SnapshotSize	Integer	快照总容量示例值：33

TagInfo

Tag信息单元

被如下接口引用：CreateCfsFileSystem, CreateCfsSnapshot, DescribeCfsFileSystems, DescribeCfsSnapshots。

名称	类型	必选	描述
TagKey	String	是	标签键示例值：abc
TagValue	String	是	标签值示例值：abc

TieringDetailInfo

分层存储详细信息

被如下接口引用：DescribeCfsFileSystems。

名称	类型	必选	描述
TieringSizeInBytes	Integer	否	低频存储容量注意：此字段可能返回 null，表示取不到有效值。示例值：100

UserQuota

文件系统配额信息

被如下接口引用：DescribeUserQuota。

名称	类型	必选	描述
UserType	String	是	指定配额类型，包括Uid、Gid 示例值：Uid
UserId	String	是	UID/GID信息示例值：1000
CapacityHardLimit	Integer	是	容量硬限制，单位GiB 示例值：10
FileHardLimit	Integer	是	文件硬限制，单位个示例值：10000
FileSystemId	String	是	文件系统ID 示例值：cfs-1245
CapacityUsed	Integer	否	容量使用，单位GiB 注意：此字段可能返回 null，表示取不到有效值。示例值：9
FileUsed	Integer	否	文件使用个数，单位个注意：此字段可能返回 null，表示取不到有效值。示例值：9999