1. Interface Description
Interface request domain name: cfs.api3.convergecloud.com.
Deletes file systems
Default interface request rate limit: 20 times per second.
Interface update time: 2020-12-17 07:45:17.
The interface is both signature verification and authentication.
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: DeleteCfsFileSystem |
| 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 | Yes | No | String | File system ID Example: cfs-2sczq3das |
| Force | No | No | Int64 | Forced deletion of file system: 1 for forced, 0 or empty for default Example: 1 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| componentName | String | Component name Example: billing |
| data | Array of String | Returned data. Example: success |
| eventId | Uint64 | Event ID Example: 1097864659 |
| returnCode | Uint64 | Returned values Example: 0 |
| returnValue | Uint64 | Returned values Example: 0 |
| returnMessage | String | Return Message Example: ok. OK |
| returnMsg | String | Return Message Example: ok. OK |
| timestamp | Uint64 | Timestamp Example: 1741786693 |
| version | Uint64 | API version 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.InvalidFileSystemId | Invalid FileSystemId. |
| InvalidParameterValue.InvalidFsStatus | Invalid file system status. |
| UnsupportedOperation.UnverifiedUser | User not authenticated with real name. |
| FailedOperation.PgroupInUse | Permission group already bound to the file system. |
| ResourceNotFound.FileSystemNotFound | The file system does not exist. |
| InternalError.GetAccountStatusFailed | Failed to obtain user fee status. |
| UnsupportedOperation.OutOfService | Out of service due to overdue payment. Top up and try again. |
| FailedOperation.PgroupIsUpdating | The permission group is being updated. |
| InvalidParameterValue.InvalidRegionZoneInfo | Region error. Either (ZoneName) or (ZoneId, Region) must be selected. |
| FailedOperation.MountTargetExists | Mount target exists in the file system. |
| InternalError | Internal error |
| AuthFailure.UnauthorizedOperation | Request lacks CAM authorization. |
| InvalidParameter | Wrong parameter. |
| UnsupportedOperation | Operation unsupported. |
| InternalError.Timeout | Timed out. |
| InvalidParameterValue.MissingFsParameter | FileSystem missing. |
| 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. |
| AuthFailure | CAM signature/authentication error |