数据结构
最近更新时间: 2024-09-03 18:49:42
FileSystemByPolicy
绑定快照策略的文件系统信息
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CreationToken | 是 | 否 | String | 文件系统名称 |
| FileSystemId | 是 | 否 | String | 文件系统ID |
| SizeByte | 是 | 否 | Uint64 | 文件系统大小 |
| StorageType | 是 | 否 | String | 文件系统存储类型 |
| TotalSnapshotSize | 是 | 否 | Uint64 | 快照总大小 |
| Protocol | 是 | 否 | String | 协议类型 |
VersionCtrlRegionZones
区域可用情况
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RegionZones | 是 | 否 | Array of AvailableRegion | 区域可用情况 |
SnapList
文件系统快照列表
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RegionName | 是 | 否 | String | 地域名 |
| SnapId | 是 | 否 | String | 快照id |
| SnapName | 是 | 否 | String | 快照名称 |
| FileSystemId | 是 | 否 | String | 文件系统id |
| FsName | 是 | 否 | String | 文件系统名 |
| Size | 是 | 否 | Uint64 | 快照大小B |
| StorageType | 是 | 否 | String | 存储类型 |
| AliveDay | 是 | 否 | Uint64 | 保留天数 |
| CreateTime | 是 | 否 | String | 创建时间 |
| UpdateTime | 是 | 否 | String | 更新时间 |
| Status | 是 | 否 | Uint64 | 快照状态 |
| Percent | 是 | 否 | Uint64 | 快照进度 |
| JobHistorys | 是 | 否 | Array of CfsSnapJobHistory | 操作历史 |
| JobId | 是 | 否 | String | 快照任务id |
CfsTagUser
cfs tags
被如下接口引用：DescribeCfsTags
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagId | 是 | 否 | Uint64 | tag id |
| TagName | 是 | 否 | String | 标识名称 |
| Status | 是 | 否 | Uint64 | 打开状态 |
| SdSaleStatus | 是 | 是 | String | SD是否可售 |
| HpSaleStatus | 是 | 是 | String | 是否可售 |
| ZoneId | 是 | 是 | Uint64 | 可用区id |
| ISSMB | 是 | 是 | Uint64 | 支持SMB |
| ISNFS | 是 | 是 | Uint64 | 支持NFS |
TagInfo
Tag信息单元
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagKey | 是 | 否 | String | 标签键 |
| TagValue | 是 | 否 | String | 标签值 |
InputPermissionGroupRules
入参权限组规则列表
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AuthClientIp | 是 | 否 | String | 允许访问的客户端IP |
| RWPermission | 是 | 否 | String | 读写权限, ro为只读，rw为读写 |
| UserPermission | 是 | 否 | String | 用户权限。其中all_squash为所有访问用户都会被映射为匿名用户或用户组；no_all_squash为访问用户会先与本机用户匹配，匹配失败后再映射为匿名用户或用户组；root_squash为将来访的root用户映射为匿名用户或用户组；no_root_squash为来访的root用户保持root帐号权限。 |
| Priority | 是 | 否 | Uint64 | 规则优先级，1-100。 其中 1 为最高，100为最低 |
PGroupInfo
权限组数组
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| PGroupId | 是 | 否 | String | 权限组ID |
| Name | 是 | 否 | String | 权限组名称 |
| DescInfo | 是 | 否 | String | 描述信息 |
| CDate | 是 | 否 | String | 创建时间 |
| BindCfsNum | 是 | 否 | Int64 | 关联文件系统个数 |
FileSystemByVpcInfo
用于按照VPC查询文件系统接口
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| FileSystemId | 是 | 否 | String | 文件系统ID |
| IpAddress | 是 | 否 | String | IP地址 |
| FSID | 是 | 否 | String | 挂载根目录 |
| LifeCycleState | 是 | 否 | String | 挂载点状态 |
| MountTargetId | 是 | 否 | String | 挂载点 ID |
| NetworkInterface | 是 | 否 | String | 网络类型 |
| VpcId | 是 | 否 | String | 私有网络 ID |
| SubnetId | 是 | 否 | String | 子网 ID |
| ZoneId | 是 | 否 | Int64 | 可用区ID |
PeriodStatisticsSet
全局统计信息
被如下接口引用：DescribeStatistics
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| StandardFilesystemCount | 是 | 否 | Uint64 | 标准型文件系统数量 |
| HighPerformanceFilesystemCount | 是 | 否 | Uint64 | 性能型文件系统数量 |
| StandardFilesystemStorage | 是 | 否 | Float | 标准型文件系统存储量 |
| HighPerformanceFilesystemStorage | 是 | 否 | Float | 性能型文件系统存储量 |
| StatisticalPeriod | 是 | 否 | String | 统计周期 |
AutoSnapshotPolicyInfo
快照策略
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AutoSnapshotPolicyId | 是 | 否 | String | 快照策略ID |
| PolicyName | 是 | 否 | String | 策略名称 |
| CreationTime | 是 | 否 | String | 创建时间 |
| FileSystemNums | 是 | 否 | Uint64 | 关联的文件系统个数 |
| DayOfWeek | 是 | 否 | String | 星期 |
| Hour | 是 | 否 | String | 小时 |
| IsActivated | 是 | 否 | Uint64 | 是否激活 |
| NextActiveTime | 是 | 否 | String | 下次执行时间 |
| Status | 是 | 否 | Uint64 | 策略状态 |
| AliveDays | 是 | 否 | Uint64 | 保留时间 |
| RegionName | 是 | 否 | String | 地域 |
| FileSystems | 是 | 否 | Array of FileSystemByPolicy | 关联文件系统信息 |
| AppId | 是 | 否 | Uint64 | appid |
AvailableZone
版本控制-可用区数组
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Zone | 是 | 否 | String | 可用区名称 |
| ZoneId | 是 | 否 | Int64 | 可用区ID |
| ZoneCnName | 是 | 否 | String | 可用区中文名称 |
| Types | 是 | 否 | Array of AvailableType | Type数组 |
| ZoneEnName | 是 | 否 | String | 可用区英文名 |
FileSystemClient
文件系统客户端信息
被如下接口引用：DescribeCfsFileSystemClients
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CfsVip | 是 | 否 | String | 文件系统IP地址 |
| ClientIp | 是 | 否 | String | 客户端IP地址 |
| VpcId | 是 | 否 | String | 文件系统所属VPCID |
| Zone | 是 | 否 | String | 可用区名称，例如ap-beijing-1 |
| ZoneName | 是 | 否 | String | 可用区中文名称 |
| MountDirectory | 是 | 否 | String | 该文件系统被挂载到客户端上的路径信息 |
| ZoneId | 是 | 否 | Uint64 | 可用起ID |
| LinkStatus | 是 | 否 | Uint64 | 链接状态：1：已链接，2:链接断开 |
| MonitorStatus | 是 | 否 | Uint64 | 监控状态：1:已安装监控，2：未安装监控 |
| Protocol | 是 | 否 | String | 协议：v3：nfsv3挂载，v4:nfsv4挂载 |
PGroupRuleInfo
权限组规则列表
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RuleId | 是 | 否 | String | 规则ID |
| AuthClientIp | 是 | 否 | String | 允许访问的客户端IP |
| RWPermission | 是 | 否 | String | 读写权限, ro为只读，rw为读写 |
| UserPermission | 是 | 否 | String | 用户权限。其中all_squash为所有访问用户都会被映射为匿名用户或用户组；no_all_squash为访问用户会先与本机用户匹配，匹配失败后再映射为匿名用户或用户组；root_squash为将来访的root用户映射为匿名用户或用户组；no_root_squash为来访的root用户保持root帐号权限。 |
| Priority | 是 | 否 | Int64 | 规则优先级，1-100。 其中 1 为最高，100为最低 |
MountInfo
挂载点信息
被如下接口引用：DescribeMountTargets
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| FileSystemId | 是 | 否 | String | 文件系统 ID |
| MountTargetId | 是 | 否 | String | 挂载点 ID |
| IpAddress | 是 | 否 | String | 挂载点 IP |
| FSID | 是 | 否 | String | 挂载根目录 |
| LifeCycleState | 是 | 否 | String | 挂载点状态 |
| NetworkInterface | 是 | 否 | String | 网络类型 |
| VpcId | 是 | 否 | String | 私有网络 ID |
| VpcName | 是 | 否 | String | 私有网络名称 |
| SubnetId | 是 | 否 | String | 子网 Id |
| SubnetName | 是 | 否 | String | 子网名称 |
| PGroupName | 是 | 否 | String | 权限组名称 |
ResourceTags
标签
被如下接口引用：CreateCfsFileSystem
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TagKey | 是 | 否 | String | 标签键 |
| TagValue | 是 | 否 | String | 标签值 |
AvailableProtoStatus
版本控制-协议详情
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SaleStatus | 是 | 否 | String | 售卖状态。可选值有 sale_out 售罄、saling可售、no_saling不可销售 |
| Protocol | 是 | 否 | String | 协议类型。可选值有 NFS、CIFS |
Filter
过滤参数
被如下接口引用：DescribeCfsFileSystems
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | 名称 |
| Values | 是 | 否 | Array of String | 变量 |
CfsSnapJobHistory
文件系统快照操作历史记录
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| RegionName | 是 | 否 | String | 地域名称 |
| CreateTime | 是 | 否 | String | 创建时间 |
| UpdateTime | 是 | 否 | String | 更新时间 |
| JobType | 是 | 否 | String | 任务类型 |
| Operater | 是 | 否 | String | 操作人 |
| Status | 是 | 否 | Uint64 | 任务状态 |
| Message | 是 | 否 | String | 任务详情 |
AvailableType
版本控制-类型数组
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Protocols | 是 | 否 | Array of AvailableProtoStatus | 协议与售卖详情 |
| Type | 是 | 否 | String | 存储类型。可选值有 SD 标准型存储、HP性能型存储 |
MountTargetsWithRegion
用于DescribeMountTargetsWithRegion接口
被如下接口引用：DescribeMountTargetsWithRegion
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| VpcId | 是 | 否 | String | 私有网络 ID |
| IpAddress | 是 | 否 | String | 挂载点 IP |
KmsKey
KmsKey
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NextRotateTime | 是 | 否 | Int64 | 下次轮转时间戳 |
| Owner | 是 | 否 | String | 密钥属主 |
| KeyRotationEnabled | 是 | 否 | Bool | 密钥轮转是否开启 |
| KeyId | 是 | 否 | String | 密钥ID |
| Alias | 是 | 否 | String | 密钥别名 |
| CreateTime | 是 | 否 | Int64 | 创建时间戳 |
| Description | 是 | 否 | String | 密钥描述 |
| KeyState | 是 | 否 | String | 密钥状态，可选值为“Enabled“，”Disabled“ |
| KeyUsage | 是 | 否 | String | 密钥使用方 |
| Type | 是 | 否 | Int64 | 密钥类型 |
| CreatorUin | 是 | 否 | Int64 | 创建者UIN |
MigratableCfsFileSystemId
可迁移文件系统ID，用于DescribeMigratableCfsFileSystems接口
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| FileSystemId | 是 | 否 | String | 文件系统ID |
AvailableRegion
版本控制-区域数组
被如下接口引用：
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Region | 是 | 否 | String | 区域名称，如“ap-beijing” |
| RegionName | 是 | 否 | String | 区域名称，如“bj” |
| RegionStatus | 是 | 否 | String | 区域可用情况，当区域内至少有一个可用区处于可售状态时，取值为AVAILABLE，否则为UNAVAILABLE |
| Zones | 是 | 否 | Array of AvailableZone | 可用区数组 |
| RegionCnName | 是 | 否 | String | 区域中文名称，如“广州” |
PGroup
文件系统绑定权限组信息
被如下接口引用：DescribeCfsFileSystems
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| PGroupId | 是 | 否 | String | 权限组ID |
| Name | 是 | 否 | String | 权限组名称 |
FileSystemInfo
文件系统基本信息
被如下接口引用：DescribeCfsFileSystems
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CreationTime | 是 | 否 | String | 创建时间 |
| CreationToken | 是 | 否 | String | 用户自定义名称 |
| FileSystemId | 是 | 否 | String | 文件系统 ID |
| LifeCycleState | 是 | 否 | String | 文件系统状态 |
| SizeByte | 是 | 否 | Uint64 | 文件系统已使用容量 |
| SizeLimit | 是 | 否 | Uint64 | 文件系统最大空间限制 |
| ZoneId | 是 | 否 | Uint64 | 区域 ID |
| Zone | 是 | 否 | String | 区域名称 |
| Protocol | 是 | 否 | String | 文件系统协议类型 |
| StorageType | 是 | 否 | String | 文件系统存储类型 |
| StorageResourcePkg | 是 | 否 | String | 文件系统绑定的预付费存储包（暂未支持） |
| BandwidthResourcePkg | 是 | 否 | String | 文件系统绑定的预付费带宽包（暂未支持） |
| PGroup | 是 | 否 | PGroup | 文件系统绑定权限组信息 |
| FsName | 是 | 否 | String | 用户自定义名称 |
| Encrypted | 是 | 否 | Bool | 文件系统是否加密 |
| KmsKeyId | 是 | 否 | String | 加密所使用的密钥，可以为密钥的 ID 或者 ARN |
| SizeLimitMax | 是 | 否 | Uint64 | 容量限额最大值 |
| VpcId | 是 | 否 | String | 私有网络ID |
| IpAddress | 是 | 否 | String | 挂载点IP地址 |
| AllocedSpace | 是 | 否 | Uint64 | 已分配空间 |
| TagId | 是 | 否 | Uint64 | cfs资源池tagid |
| TagName | 是 | 否 | String | cfs资源池tag名称 |
| SnapId | 是 | 否 | String | 快照id |
| SnapStatus | 是 | 否 | String | 快照状态 |
| BandwidthLimit | 是 | 否 | Float | 带宽上限 |
| AppId | 是 | 否 | Uint64 | appid |
MountTargetCollectionWithRegion
用于DescribeMountTargetsWithRegion接口
被如下接口引用：DescribeMountTargetsWithRegion
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| NumberOfMountTargets | 是 | 否 | Int64 | 挂载点数量 |
| FileSystemId | 是 | 否 | String | 文件系统 ID |
| MountTargets | 是 | 否 | Array of MountTargetsWithRegion | 挂载点详情 |