1. Interface Description
Interface request domain name: cfs.api3.convergecloud.com.
This API (DescribeCfsPGroups) is used to query the permission group list.
Default interface request rate limit: 20 times per second.
Interface update time: 2019-09-25 06:03:36.
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: DescribeCfsPGroups |
| 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 |
| InternationalFlag | No | No | Int64 | When the value of this field is 1, the default permission group will use English. Example: 0 |
| PGroupId | No | No | String | Permission Group ID Example: pgroup-1es6pwjb |
| Name | No | No | String | Permission Group Name Example: qta-searchpgrouplist-ez5g-1255000219 |
| DescInfo | No | No | String | Permission group description Example: default_pgroup |
| OrderBy | No | No | String | Sort field: BindCfsNum or CDate Example: BindCfsNum |
| OrderByType | No | No | String | Sort mode: ASC or DESC Example: desc |
| Offset | No | No | Uint64 | Offset paging number Example: 0 |
| Limit | No | No | Uint64 | Limit page size Example: 100 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| PGroupList | Array of PGroupInfo | Permission group information list Example:View |
| TotalCount | Uint64 | Total Number of File Systems Example: 10 |
| 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 |
|---|---|
| UnsupportedOperation.OutOfService | Out of service due to overdue payment. Top up and try again. |
| UnsupportedOperation.UnverifiedUser | User not authenticated with real name. |
| InternalError.GetAccountStatusFailed | Failed to obtain user fee status. |