1. Interface Description
Interface request domain name: cfs.api3.convergecloud.com.
This API is used to create permission group rules in batches.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-06-10 05:15:03.
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: BatchAddCfsRules |
| 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 |
| PermissionGroupId | Yes | No | String | Permission group ID Example: pgroup-dbne3lnb |
| RuleList | Yes | No | Array of InputPermissionGroupRules | Permission group rule list Example:View |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RuleList | Array of PGroupRuleInfo | Permission group rule 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 |
|---|---|
| UnsupportedOperation | Operation unsupported. |
| FailedOperation | Operation failed |
| UnsupportedOperation.OutOfService | Out of service due to overdue payment. Top up and try again. |
| InvalidParameterValue.InvalidPgroup | The permission group does not belong to the user. |
| InvalidParameterValue.InvalidPriority | Priority setting error. |
| InvalidParameter | Wrong parameter. |
| UnsupportedOperation.UnverifiedUser | User not authenticated with real name. |
| FailedOperation.PgroupIsUpdating | The permission group is being updated. |
| InternalError.GetAccountStatusFailed | Failed to obtain user fee status. |
| InvalidParameterValue.DuplicatedRuleAuthClientIp | Duplicate rule IP. |
| FailedOperation.PgroupInUse | Permission group already bound to the file system. |
| InvalidParameterValue.InvalidUserPermission | User permissions setting error. |
| InvalidParameterValue.InvalidRwPermission | Read/Write permission setting error. |
| InvalidParameterValue.InvalidAuthClientIp | Rule IP error. |
| ResourceInsufficient.RuleLimitExceeded | The number of rules exceeds the limit. |
| ResourceNotFound.PgroupNotFound | Permission group does not exist. |
| InternalError | Internal error |