Create File System - CreateUFSVolume
Overview
Create File System
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is CreateUFSVolume. | Yes |
| PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Region | string | Region. See List of Regions and Availability Zones | Yes |
| ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
| Size | int | The size of the file system, in GB, must be a multiple of 100. The minimum size for capacity-based file systems is 500GB, while the minimum size for performance-based file systems is 100GB. | Yes |
| StorageType | string | File system storage type, Basic represents capacity type, Advanced represents performance type. | Yes |
| ProtocolType | string | File system protocol, currently only supports NFSv4 | Yes |
| VolumeName | string | File System Name | No |
| Remark | string | Note | No |
| Tag | string | File System's Business Group | No |
| ChargeType | string | Billing mode, enumeration values are: Year, pay annually; Month, pay monthly; Dynamic, pay as you go (permission required); Trial, trial (permission required) default is Dynamic. | No |
| Quantity | int | Purchase Duration Default: 1 | No |
| CouponId | string | ID of the voucher used | No |
Response Field
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
| Action | string | Operation command name. | Yes |
| Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
| VolumeName | string | File System Name | Yes |
| VolumeId | string | File System ID | Yes |
| VolumeStatus | string | File System Mount Point Status | Yes |
Example
Request Example
https://api.surfercloud.com/?Action=CreateUFSVolume
&VolumeName=saHszswLdzUZzUZsPiwCAnJtBouOgHSzIRb
&ProjectId=MIyyFdSR
&StorageType=Advanced
&ProtocolType=NFSv4
&Size=500Response Example
{
"Action": "CreateUFSVolumeResponse",
"RetCode": 0,
"VolumeId": "ufs-xxx",
"VolumeName": "zUZzUZsPiwCAnJ",
"VolumeStatus": "UnInitialized"
}