1. Interface Description
Interface request domain name: cfs.api3.convergecloud.com.
This API (DescribeCfsFileSystems) is used to query file systems.
Default interface request rate limit: 20 times per second.
Interface update time: 2020-12-17 07:43:42.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeCfsFileSystems |
| Version | Yes | No | String | Public parameter, The value of this interface: 2019-07-19 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| FileSystemId | No | No | String | File system ID Example: cfs-2sczq3das |
| InternationalFlag | No | No | Uint64 | When the value of this field is 1, unnamed file systems will use English names. Example: 1 |
| VpcId | No | No | String | Virtual Private Cloud (VPC) ID Example: vpc-sxcase4 |
| SubnetId | No | No | String | Subnet ID Example: sbnet-id-business |
| Offset | No | No | Uint64 | Offset Example: 10 |
| Limit | No | No | Uint64 | Limit Example: 10 |
| CreationToken | No | No | String | User-defined name Example: fs-name-business |
| FileSystemIds | No | No | Array of String | File system ID list Example: cfs-sdcxdads,cfs-21esda32 |
| LifeCycleState | No | No | String | File system status Example: creating |
| ZoneId | No | No | Uint64 | Availability zone ID Example: 50010001 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| FileSystems | Array of FileSystemInfo | File System Name Example:View |
| TotalCount | Uint64 | Total Number of File Systems Example: 1 |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue.InvalidVpcParameter | VPC parameter error. |
| InvalidParameterValue.InvalidFileSystemId | Invalid FileSystemId. |
| ResourceInsufficient.RegionSoldOut | Region resources sold out. |
| InvalidParameterValue.InvalidZoneOrZoneId | Invalid availability zone or availability zone ID. |
| InvalidParameterValue.MissingFileSystemId | FileSystemId missing. |
| UnsupportedOperation.UnverifiedUser | User not authenticated with real name. |
| InvalidParameterValue.InvalidZoneId | Invalid availability zone. |
| InternalError.GetAccountStatusFailed | Failed to obtain user fee status. |
| InvalidParameterValue.UnavailableRegion | This availability zone cannot provide service. |
| UnsupportedOperation.OutOfService | Out of service due to overdue payment. Top up and try again. |
| InvalidParameterValue | Invalid parameter value |
| InvalidParameterValue.InvalidStorageType | Storage type error. |
| InvalidParameterValue.InvalidVip | The specified VIP is unavailable. |
| InvalidParameterValue.ZoneIdRegionNotMatch | ZoneId and Region do not match. |
| InternalError | Internal error |
| AuthFailure.UnauthorizedOperation | Request lacks CAM authorization. |
| FailedOperation | Operation failed |
| MissingParameter | Missing parameter error. |
| InvalidParameter | Wrong parameter. |
| InvalidParameterValue.InvalidPerMode | Invalid storage type. |
| InvalidParameterValue.MissingAppidOrUin | APPID and UIN cannot both be empty. |
| InvalidParameterValue.InvalidSubnetId | Invalid subnet ID. |
| InvalidParameterValue.InvalidVpcId | Invalid VPCID. |
| InvalidParameterValue.MissingFsParameter | FileSystem missing. |
| ResourceNotFound.SnapNotExit | Snapshot does not exist. |
| InvalidParameterValue.InvalidSnapStatus | Invalid snapshot status |
| InvalidParameterValue.SnapSrcFsBusy | The original FS of the snapshot is busy. |
| FailedOperation.UntagResourceFailed | Operation failure: Failed to unbind the resource tag. |
| FailedOperation.BindResourcePkgFailed | Failed to bind the resource package to the file system. |
| FailedOperation.ClientTokenInUse | Operation failure: Resources are being created. |
| InvalidParameter.InvalidTagKey | Parameter value error: Tag key cannot be empty. |
| InvalidParameter.ClientTokenLimitExceeded | Parameter value error: The string for ensuring request idempotency exceeds the length limit (64 bytes). |
| InvalidParameter.InvalidClientToken | Parameter value error: The string for ensuring request idempotency is incorrect. |
| AuthFailure | CAM signature/authentication error |