1. Interface Description
Interface request domain name: cfs.api3.convergecloud.com.
Queries clients mounted to the file system. This feature requires the client to install the CFS monitoring plugin.
Default interface request rate limit: 20 times per second.
Interface update time: 2019-10-16 06:28:54.
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: DescribeCfsFileSystemClients |
| 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 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| ClientList | Array of FileSystemClient | Client List Example:View |
| 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 |
|---|---|
| InternalError | Internal error |
| InvalidParameterValue.InvalidFileSystemId | Invalid FileSystemId. |
| InvalidParameterValue.MissingFileSystemId | FileSystemId missing. |
| ResourceNotFound.FileSystemNotFound | The file system does not exist. |
| ResourceNotFound.MountTargetNotFound | Mount target does not exist. |
| UnsupportedOperation | Operation unsupported. |