1. Interface Description
Interface request domain name: cfs.api3.convergecloud.com.
This API (UpdateCfsFileSystemName) is used to update the file system name.
Default interface request rate limit: 20 times per second.
Interface update time: 2019-09-21 03:42:06.
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: UpdateCfsFileSystemName |
| 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 |
| CreationToken | No | No | String | Legacy version user-defined file system name, with a lower priority than FsName Example: fs-name-business |
| FileSystemId | Yes | No | String | File system ID Example: cfs-2sczq3das |
| FsName | No | No | String | User-defined file system name. Either this field or CreationToken must be specified. Example: fs-name-business |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| CreationToken | String | User-defined file system name Example: fs-name-business |
| FileSystemId | String | File System ID Example: cfs-2sczq3das |
| FsName | String | User-defined file system name Example: fs-name-business |
| 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 |
|---|---|
| InvalidParameter | Wrong parameter. |
| InternalError | Internal error |
| ResourceNotFound | The resource does not exist |
| InternalError.GetAccountStatusFailed | Failed to obtain user fee status. |
| InvalidParameterValue.FsNameLimitExceeded | User-defined name too long (exceeds 64 bytes). |
| InvalidParameterValue.InvalidFsName | Invalid user-defined name. |
| InvalidParameterValue.InvalidFileSystemId | Invalid FileSystemId. |
| InvalidParameterValue.InvalidRegionZoneInfo | Region error. Either (ZoneName) or (ZoneId, Region) must be selected. |
| InvalidParameterValue.MissingFsParameter | FileSystem missing. |
| ResourceNotFound.FileSystemNotFound | The file system does not exist. |
| FailedOperation | Operation failed |
| UnsupportedOperation.UnverifiedUser | User not authenticated with real name. |
| UnsupportedOperation.OutOfService | Out of service due to overdue payment. Top up and try again. |