cfs — Cloud File Storage
cfs · 2019-07-19
CreateCfsFileSystem
POST
Create a file system.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cfs/CreateCfsFileSystem path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.
curl
curl -sS https://cfs.api3.convergecloud.com/ \
-H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cfs/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Host: cfs.api3.convergecloud.com' \
-H 'X-TC-Action: CreateCfsFileSystem' \
-H 'X-TC-Version: 2019-07-19' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"Zone":"<Zone>","NetInterface":"<NetInterface>","PGroupId":"<PGroupId>","Protocol":"<Protocol>","StorageType":"<StorageType>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| Zone | string | Yes | AZ name, such as "ap-beijing-1". For the list of regions and AZs, please see Overview |
| NetInterface | string | Yes | Network type. Valid values: `VPC` and `CCN`. Select `VPC` for a Standard or High-Performance file system, and `CCN` for a Standard Turbo or High-Performance Turbo one. |
| PGroupId | string | Yes | Permission group ID. pgroupbasic is the default permission group. obtain through the api DescribeCfsPGroups to query the permission group list. |
| Protocol | string | Yes | File system protocol type. valid values: NFS, CIFS, and TURBO. if left blank, NFS by default. the TURBO series must select TURBO. NFS and CIFS are not supported. |
| StorageType | string | Yes | Storage type of the file system. Valid values: `SD` (Standard), `HP` (High-Performance), `TB` (Standard Turbo), and `TP` (High-Performance Turbo). Default value: `SD`. |
| VpcId | string | No | Private network (VPC) ID. if the network type is VPC, this field must be specified. obtain it by querying the private network interface. |
| SubnetId | string | No | Subnet ID. this field must be specified if the network type is VPC. obtain through the api for querying subnets. |
| MountIP | string | No | IP address (this parameter supports only the VPC network type, and the Turbo series is not supported). If this parameter is left empty, a random IP in the subnet will be assigned. |
| FsName | string | No | Custom file system name |
| ResourceTags | TagInfo[] | No | File system tag |
| ClientToken | string | No | A unique string supplied by the client to ensure that the request is idempotent. Its maximum length is 64 ASCII characters. If this parameter is not specified, the idempotency of the request cannot be guaranteed. This string is valid for 2 hours. |
| CcnId | string | No | Cloud connect network ID. this field must be specified if the network type is CCN. obtain it by querying the CCN list through the api. |
| CidrBlock | string | No | CCN IP range used by the CFS (required if the network type is CCN), which cannot conflict with other IP ranges bound in CCN |
| Capacity | integer | No | File system capacity, required for the turbo series, in GiB. turbo standard type in GB, starting from 20 TiB (20480 GiB); scaling increment 10 TiB (10240 GiB). turbo performance type starts from 10 TiB (10240 GiB); capacity expansion step 10 TiB (10240 GiB). |
| SnapshotId | string | No | File system snapshot ID. this parameter can be obtained by querying the snapshot list. |
| AutoSnapshotPolicyId | string | No | Scheduled snapshot policy ID, which can be obtained by querying the snapshot policy information. |
| EnableAutoScaleUp | boolean | No | Whether default expansion is enabled. only turbo file storage supports this feature. |
| CfsVersion | string | No | v1.5: create a standard edition general file system. |
| MetaType | string | No | turbo file system metadata attribute. |
Response
Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.
| Field | Type | Description |
|---|---|---|
| CreationTime | string | File system creation time |
| CreationToken | string | Custom file system name |
| FileSystemId | string | File system ID |
| LifeCycleState | string | File system status. Valid values: `creating`, `create_failed`, `available`, `unserviced`, `upgrading`, `deleting` |
| SizeByte | integer | Storage used by the file system, in bytes |
| ZoneId | integer | AZ ID |
| FsName | string | Custom file system name |
| Encrypted | boolean | Whether a file system is encrypted |
| RequestId | string | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Success
{
"Response": {
"CreationTime": …,
"CreationToken": …,
"RequestId": "…"
}
}Error
{
"Response": {
"Error": { "Code": "…", "Message": "…" },
"RequestId": "…"
}
}Try it
CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cfs.
Request bodyvalid JSONPOST cfs.api3.convergecloud.com · CreateCfsFileSystem