Tenant Cloud Storage Cloud File Storage Data structure

Data structure

Last Updated At: 2026-08-02 00:05:04

Filter

Filter parameter

Referenced by the following interfaces: DescribeAutoSnapshotPolicies

name	required	NULL allowed	type	description
Name	yes	no	String	Name Example: cfsId
Values	yes	no	Array of String	Variable Example: cfs-2sczq3das

SnapList

File system snapshot list

Referenced by the following interfaces: CopyFileSystemSnapshotCrossRegion, DescribeCfsSnaps

name	required	NULL allowed	type	description
RegionName	yes	no	String	Region name Example: ap-region1
SnapId	yes	no	String	Snapshot ID Example: 4f3041c8e5-a94a-10ba-4f57-8a8643b957
SnapName	yes	no	String	Snapshot Name Example: qta-snap-yf-01
FileSystemId	yes	no	String	File system ID Example: cfs-asd2ada
FsName	yes	no	String	File system name Example: fs-name-business
Size	yes	no	Uint64	Snapshot size in bytes Example: 150000000
StorageType	yes	no	String	Storage Type Example: HP
AliveDay	yes	no	Uint64	Retention period in days Example: 7
CreateTime	yes	no	String	Creation Time Example: 2021-09-15T19:04:45+08:00
UpdateTime	yes	no	String	Update time Example: 2021-09-15T19:04:45+08:00
Status	yes	no	Uint64	Snapshot status Example: 1
Percent	yes	no	Uint64	Snapshot progress Example: 20
JobHistorys	yes	no	Array of CfsSnapJobHistory	Operation history Example:View
JobId	yes	no	String	Snapshot task ID Example: snapcfs-mugq5p9z
BackupId	no	no	String	Backup ID Example: backup-ns2gv8al
BackupCreateTime	no	no	String	Backup creation time Example: 2025-07-28 07:25:57

FileSystemByVpcInfo

Queries file systems by VPC

Referenced by the following interfaces: DescribeCfsFileSystemsByVpc

name	required	NULL allowed	type	description
FileSystemId	yes	no	String	File System ID Example: cfs-asd2ada
IpAddress	yes	no	String	IP address Example: 192.168.0.1
FSID	yes	no	String	Mount root directory Example: fwsuvz0l
LifeCycleState	yes	no	String	Mount target status Example: available
MountTargetId	yes	no	String	Mount target ID Example: mount-0ylt3o7o
NetworkInterface	yes	no	String	Network Type Example: VPC
VpcId	yes	no	String	VPC ID Example: vpc-hq13cw04
SubnetId	yes	no	String	Subnet ID Example: sbnet-id-business
ZoneId	yes	no	Int64	Availability zone ID Example: 100001

PGroup

Information of the permission group bound to the file system

Referenced by the following interfaces: DescribeCfsFileSystems

name	required	NULL allowed	type	description
PGroupId	yes	no	String	Permission Group ID Example: pg-asc2xasdf
Name	yes	no	String	Permission Group Name Example: defaultname

FileSystemClient

File system client information

Referenced by the following interfaces: DescribeCfsFileSystemClients

name	required	NULL allowed	type	description
CfsVip	yes	no	String	File system IP address Example: 10.0.2.3
ClientIp	yes	no	String	Client IP address Example: 10.0.2.2
VpcId	yes	no	String	File system VPCID Example: vpc-agabral
Zone	yes	no	String	AZ name. For example, ap-zone-1. Example: ap-zone-1
ZoneName	yes	no	String	Name of Availability Zone Example: Region 1
MountDirectory	yes	no	String	Information of the path through which the file system is mounted on the client Example: /home/mnt
ZoneId	yes	no	Uint64	Availability zone ID Example: 100001
LinkStatus	yes	no	Uint64	Link status. 1: Connected; 2: Disconnected Example: 2
MonitorStatus	yes	no	Uint64	Monitor status. 1: Monitor installed; 2: Monitor not installed Example: 1
Protocol	yes	no	String	Protocol. v3: NFSv3 mount; v4: NFSv4 mount Example: SMB
UpdateTime	no	no	String	Link update time. Example: 2021-09-15T19:04:45+08:00

AvailableZone

Version control - Availability zone array

Referenced by the following interfaces: DescribeAvailableZoneInfo

name	required	NULL allowed	type	description
Zone	yes	no	String	AZ name Example: ap-zone-1
ZoneId	yes	no	Int64	Availability zone ID Example: 800001
ZoneCnName	yes	no	String	Name of Availability Zone Example: zone1
Types	yes	no	Array of AvailableType	Type array Example:View
ZoneEnName	yes	no	String	Availability zone name Example: ap-zone-2
ZoneDisplayName	yes	no	String	Availability zone display name, depending on the language. Example: Region 2

CfsSnapJobHistory

History of file system snapshot operations

Referenced by the following interfaces: CopyFileSystemSnapshotCrossRegion, DescribeCfsSnaps

name	required	NULL allowed	type	description
RegionName	yes	no	String	Region Example: ap-region1
CreateTime	yes	no	String	Creation Time Example: 2021-09-15T19:04:45+08:00
UpdateTime	yes	no	String	Update time Example: 2021-09-15T19:04:45+08:00
JobType	yes	no	String	Task Type Example: Snapshot
Operater	yes	no	String	Operator Example: yflei
Status	yes	no	Uint64	Task Status Example: 1
Message	yes	no	String	Task details Example: success

CfsTagUser

cfs tags

Referenced by the following interfaces: DescribeCfsTags

name	required	NULL allowed	type	description
TagId	yes	no	Uint64	tag id Example: 8
TagName	yes	no	String	Identifier name Example: school
Status	yes	no	Uint64	Open status Example: 1
SdSaleStatus	yes	yes	String	SD saleability Example: saling
HpSaleStatus	yes	yes	String	Saleability Example: saling
ZoneId	yes	yes	Uint64	Availability zone ID Example: 100001
ISSMB	yes	yes	Uint64	SMB support Example: 1
ISNFS	yes	yes	Uint64	NFS support Example: 1

MountInfo

Mount Point Information

Referenced by the following interfaces: DescribeMountTargets

name	required	NULL allowed	type	description
FileSystemId	yes	no	String	File system ID Example: cfs-hge16re9
MountTargetId	yes	no	String	Mount target ID Example: mount-0ylt3o7o
IpAddress	yes	no	String	Mount target IP Example: 192.168.0.1
FSID	yes	no	String	Mount root directory Example: fwsuvz0l
LifeCycleState	yes	no	String	Mount target status Example: available
NetworkInterface	yes	no	String	Network Type Example: VPC
VpcId	yes	no	String	VPC ID Example: vpc-hq13cw04
VpcName	yes	no	String	VPC name Example: private-for-yanfa
SubnetId	yes	no	String	Subnet ID Example: sbnet-id-business
SubnetName	yes	no	String	Subnet Name Example: private-for-yanfa
PGroupName	yes	no	String	Permission Group Name Example: pg-home

PGroupInfo

Permission group array

Referenced by the following interfaces: DescribeCfsPGroups

name	required	NULL allowed	type	description
PGroupId	yes	no	String	Permission Group ID Example: pg-asc2xasdf
Name	yes	no	String	Permission Group Name Example: default_pgroup
DescInfo	yes	no	String	Description Example: default_pgroup
CDate	yes	no	String	Creation Time Example: 2022-11-12 00:00:01
BindCfsNum	yes	no	Int64	Number of file systems associated Example: 1

AvailableProtoStatus

Version control - Protocol details

Referenced by the following interfaces: DescribeAvailableZoneInfo

name	required	NULL allowed	type	description
SaleStatus	yes	no	String	Sale status. sale_out: Sold out; saling: Available for sale; no_saling: Not for sale Example: sale_out
Protocol	yes	no	String	Protocol type. Values: NFS, CIFS Example: NFS

AutoSnapshotPolicyInfo

Snapshot Policy

Referenced by the following interfaces: DescribeAutoSnapshotPolicies

name	required	NULL allowed	type	description
AutoSnapshotPolicyId	yes	no	String	Snapshot Policy ID Example: asp-xcweqdx
PolicyName	yes	no	String	Policy Name Example: default
CreationTime	yes	no	String	Creation Time Example: 2020-05-23 19:00:45
FileSystemNums	yes	no	Uint64	Number of file systems associated Example: 2
DayOfWeek	yes	no	String	Week Example: '1,2'
Hour	yes	no	String	Hour Example: '3,4'
IsActivated	yes	no	Uint64	Activation status Example: 1
NextActiveTime	yes	no	String	Next execution Example: 2020-05-25 19:00:45
Status	yes	no	String	Policy status Example: 1
AliveDays	yes	no	Uint64	Retention Period Example: 3
RegionName	yes	no	String	Region Example: ap-region1
FileSystems	yes	no	Array of FileSystemByPolicy	Associated file system information Example:View
AppId	yes	no	Uint64	appid Example: 1255000652

InputPermissionGroupRules

Input parameter permission group rule list

Referenced by the following interfaces: BatchAddCfsRules, OverrideCfsRules

name	required	NULL allowed	type	description
AuthClientIp	yes	no	String	Client IP allowed for access Example: 10.0.0.2
RWPermission	yes	no	String	Read-write permissions, ro for read-only, rw for read-write Example: ro
UserPermission	yes	no	String	User permissions. all_squash: Map all accessing users to anonymous users or user groups. no_all_squash: First match accessing users with local users and then, if the match fails, map them to anonymous users or user groups. root_squash: Map accessing root users to anonymous users or user groups. no_root_squash: Allow accessing root users to keep their root account permissions. Example: all_squash
Priority	yes	no	Uint64	Rule priority. Value range: 1-100, where 1 means the highest, and 100 the lowest Example: 2

FileSystemByPolicy

Information of the file system bound to the snapshot policy

Referenced by the following interfaces: DescribeAutoSnapshotPolicies

name	required	NULL allowed	type	description
CreationToken	yes	no	String	File System Name Example: fs-name-business
FileSystemId	yes	no	String	File System ID Example: cfs-x1x
SizeByte	yes	no	Uint64	File system size Example: 1
StorageType	yes	no	String	File system storage type Example: HP
TotalSnapshotSize	yes	no	Uint64	Snapshot Size Example: 1
Protocol	yes	no	String	Protocol Type Example: SMB

PeriodStatisticsSet

Global statistics information

Referenced by the following interfaces: DescribeStatistics

name	required	NULL allowed	type	description
StandardFilesystemCount	yes	no	Uint64	Number of Standard file systems Example: 0
HighPerformanceFilesystemCount	yes	no	Uint64	Number of High Performance file systems Example: 0
StandardFilesystemStorage	yes	no	Float	Storage capacity of Standard file system Example: 0
HighPerformanceFilesystemStorage	yes	no	Float	Storage capacity of High Performance file system Example: 0
StatisticalPeriod	yes	no	String	Statistical Period Example: 0

FileSystemInfo

Basic file system information

Referenced by the following interfaces: DescribeCfsFileSystems

name	required	NULL allowed	type	description
CreationTime	yes	no	String	Creation Time Example: 2020-08-11 20:57:17
CreationToken	yes	no	String	User-defined name Example: fs-name-business
FileSystemId	yes	no	String	File system ID Example: cfs-gabtqtq
LifeCycleState	yes	no	String	File system status Example: creating
SizeByte	yes	no	Uint64	File system capacity that is used Example: 10
SizeLimit	yes	no	Uint64	Maximum file system space limit Example: 50
ZoneId	yes	no	Uint64	Region ID Example: 100001
Zone	yes	no	String	Region name Example: ap-zone-1
Protocol	yes	no	String	File system protocol type Example: SMB
StorageType	yes	no	String	File system storage type Example: HP
StorageResourcePkg	yes	no	String	Prepaid storage package bound to the file system (not yet supported) Example: no support current
BandwidthResourcePkg	yes	no	String	Prepaid bandwidth package bound to the file system (not yet supported) Example: no support current
PGroup	yes	no	PGroup	Information of the permission group bound to the file system Example:View
FsName	yes	no	String	User-defined name Example: fs-name-business
Encrypted	yes	no	Bool	Indicates whether the file system is encrypted Example: true
KmsKeyId	yes	no	String	Encryption key used, which can be the key ID or ARN Example: gaglkjgfpnggagalkinebn14tw
SizeLimitMax	yes	no	Uint64	Maximum capacity limit Example: 160000000
VpcId	yes	no	String	VPC ID Example: vpc-hq13cw04
IpAddress	yes	no	String	Mount target IP address Example: 192.168.0.1
AllocedSpace	yes	no	Uint64	Allocated space Example: 200000
TagId	yes	no	Uint64	CFS resource pool tag ID Example: 8
TagName	yes	no	String	CFS resource pool tag name Example: school
SnapId	yes	no	String	Snapshot ID Example: 4f3041c8e5-a94a-10ba-4f57-8a8643b957
SnapStatus	yes	no	String	Snapshot status Example: snapping
BandwidthLimit	yes	no	Float	Bandwidth Cap Example: 100
AppId	yes	no	Uint64	appid Example: 1255000652
DrcType	no	no	String	DRC type. Example: normal
BrcStatus	no	no	String	BRC status. Example: normal
SubnetId	no	no	String	VPC subnet ID. Example: subnet-eob81puc

PGroupRuleInfo

Permission group rule list

Referenced by the following interfaces: BatchAddCfsRules, DescribeCfsRules, OverrideCfsRules

name	required	NULL allowed	type	description
RuleId	yes	no	String	Rule ID Example: rule-gabatga4
AuthClientIp	yes	no	String	Client IP allowed for access Example: 10.0.0.2
RWPermission	yes	no	String	Read-write permissions, ro for read-only, rw for read-write Example: ro
UserPermission	yes	no	String	User permissions. all_squash: Map all accessing users to anonymous users or user groups. no_all_squash: First match accessing users with local users and then, if the match fails, map them to anonymous users or user groups. root_squash: Map accessing root users to anonymous users or user groups. no_root_squash: Allow accessing root users to keep their root account permissions. Example: all_squash
Priority	yes	no	Int64	Rule priority. Value range: 1-100, where 1 means the highest, and 100 the lowest Example: 2

AvailableRegion

Version control - Region array

Referenced by the following interfaces: DescribeAvailableZoneInfo

name	required	NULL allowed	type	description
Region	yes	no	String	Region name. For example, "ap-region". Example: region
RegionName	yes	no	String	Region name, such as bj Example: ap-region1
RegionStatus	yes	no	String	Region availability. When at least one zone in the region is available for sale, the value is AVAILABLE; otherwise; it is UNAVAILABLE. Example: AVAILABLE
Zones	yes	no	Array of AvailableZone	Availability zone array Example:View
RegionCnName	yes	no	String	Region name, such as region1 Example: region1
RegionDisplayName	yes	no	String	Region display name, depending on the language. Example: region1

ResourceTags

Tag

Referenced by the following interfaces: CreateCfsFileSystem

name	required	NULL allowed	type	description
TagKey	yes	no	String	Tag Key Example: Department
TagValue	yes	no	String	Tag Value Example: Product department 1

AvailableType

Version control - Type array

Referenced by the following interfaces: DescribeAvailableZoneInfo

name	required	NULL allowed	type	description
Protocols	yes	no	Array of AvailableProtoStatus	Protocol and sale details Example:View
Type	yes	no	String	Storage type. SD: Standard; HP: High Performance Example: SD