Data Types
Last updated: 2020-04-02 18:01:25
AvailableProtoStatus
Versioning - protocol details
Used by actions: DescribeAvailableZoneInfo.
| Name | Type | Description |
|---|---|---|
| SaleStatus | String | Sale status. Valid values: sale_out (sold out), saling (purchasable), no_saling (non-purchasable) |
| Protocol | String | Protocol type. Valid values: NFS, CIFS |
AvailableRegion
Versioning - array of regions
Used by actions: DescribeAvailableZoneInfo.
| Name | Type | Description |
|---|---|---|
| Region | String | Region name, such as "ap-beijing" |
| RegionName | String | Region name, such as "bj" |
| RegionStatus | String | Region availability. If a region has at least one AZ where resources are purchasable, this value will be AVAILABLE; otherwise, it will be UNAVAILABLE |
| Zones | Array of AvailableZone | Array of AZs |
| RegionCnName | String | Region name, such as "Guangzhou" |
AvailableType
Versioning - array of classes
Used by actions: DescribeAvailableZoneInfo.
| Name | Type | Description |
|---|---|---|
| Protocols | Array of AvailableProtoStatus | Protocol and sale details |
| Type | String | Storage class. Valid values: SD (standard), HP (high-performance) |
AvailableZone
Versioning - array of AZs
Used by actions: DescribeAvailableZoneInfo.
| Name | Type | Description |
|---|---|---|
| Zone | String | AZ name |
| ZoneId | Integer | AZ ID |
| ZoneCnName | String | Chinese name of an AZ |
| Types | Array of AvailableType | Array of classes |
| ZoneName | String | Chinese and English names of an AZ |
FileSystemInfo
Basic information of a file system
Used by actions: DescribeCfsFileSystems.
| Name | Type | Description |
|---|---|---|
| CreationTime | String | Creation time |
| CreationToken | String | Custom name |
| FileSystemId | String | File system ID |
| LifeCycleState | String | File system status |
| SizeByte | Integer | Used file system capacity |
| SizeLimit | Integer | Maximum storage limit of a file system |
| ZoneId | Integer | Region ID |
| Zone | String | Region name |
| Protocol | String | File system protocol type |
| StorageType | String | File system storage class |
| StorageResourcePkg | String | Prepaid storage pack bound to a file system (not supported currently) |
| BandwidthResourcePkg | String | Prepaid bandwidth pack bound to a file system (not supported currently) |
| PGroup | PGroup | Information of permission groups bound to a file system |
| FsName | String | Custom name |
| Encrypted | Boolean | Whether a file system is encrypted |
| KmsKeyId | String | Key used for encryption, which can be the key ID or ARN |
| AppId | Integer | Application ID |
MountInfo
Mount target information
Used by actions: DescribeMountTargets.
| Name | Type | Description |
|---|---|---|
| FileSystemId | String | File system ID |
| MountTargetId | String | Mount target ID |
| IpAddress | String | Mount target IP |
| FSID | String | Mount root-directory |
| LifeCycleState | String | Mount target status |
| NetworkInterface | String | Network type |
| VpcId | String | VPC ID |
| VpcName | String | VPC name |
| SubnetId | String | Subnet ID |
| SubnetName | String | Subnet name |
PGroup
Information of permission groups bound to a file system
Used by actions: DescribeCfsFileSystems.
| Name | Type | Description |
|---|---|---|
| PGroupId | String | Permission group ID |
| Name | String | Permission group name |
PGroupInfo
Array of permission groups
Used by actions: DescribeCfsPGroups.
| Name | Type | Description |
|---|---|---|
| PGroupId | String | Permission group ID |
| Name | String | Permission group name |
| DescInfo | String | Description |
| CDate | String | Creation time |
| BindCfsNum | Integer | The number of bound file system |
PGroupRuleInfo
List of permission group rules
Used by actions: DescribeCfsRules.
| Name | Type | Description |
|---|---|---|
| RuleId | String | Rule ID |
| AuthClientIp | String | Client IP allowed for access |
| RWPermission | String | Read/write permission. ro: read-only; rw: read & write |
| UserPermission | String | User permission. all_squash: any visiting user will be mapped to an anonymous user or user group; no_all_squash: a visiting user will be first matched with a local user, and if the match fails, it will be mapped to an anonymous user or user group; root_squash: a visiting root user will be mapped to an anonymous user or user group; no_root_squash: a visiting root user will be allowed to maintain root account permissions. |
| Priority | Integer | Rule priority. Value range: 1–100. 1 represents the highest priority, while 100 the lowest |
TagInfo
Tag information unit
Used by actions: CreateCfsFileSystem.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key |
| TagValue | String | Yes | Tag value |
