1. Interface Description
Interface request domain name: cfs.api3.convergecloud.com.
This API (DescribeCfsServiceStatus) is used to query the CFS service status of users.
Default interface request rate limit: 20 times per second.
Interface update time: 2019-09-21 03:40:43.
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: DescribeCfsServiceStatus |
| 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 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| CfsServiceStatus | String | The current CFS service status of the user. none: Not activated; creating: Being activated; created: Activated Example: none |
| 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 |
| UnsupportedOperation | Operation unsupported. |
| UnsupportedOperation.UnverifiedUser | User not authenticated with real name. |
| UnsupportedOperation.OutOfService | Out of service due to overdue payment. Top up and try again. |