1. Interface Description
Interface request domain name: cfs.api3.convergecloud.com.
This API (UpdateCfsRule) is used to update permission rules.
Default interface request rate limit: 20 times per second.
Interface update time: 2019-09-21 03:42:49.
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: UpdateCfsRule |
| 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 |
| PGroupId | Yes | No | String | Permission group ID Example: pg-xqwqewe |
| RuleId | Yes | No | String | Rule ID Example: rule-xc2cxzcsd |
| AuthClientIp | No | No | String | You can specify an IP address or an IP address range, such as 10.1.10.11 or 10.10.1.0/24. The default visitor address is *, indicating that all IP addresses are allowed. Note that you need to specify the CVM instance's private IP here. Example: 10.0.0.10 |
| RWPermission | No | No | String | Read-write permission. Values: RO (read-only), RW (read-write). If not specified, this field will be ro by default. Example: rw |
| UserPermission | No | No | String | User permissions. all_squash: Map all accessing users to anonymous users or user groups. no_all_squash: First match accessing users with local users and then, if the match fails, map them to anonymous users or user groups. root_squash: Map accessing root users to anonymous users or user groups. no_root_squash: Allow accessing root users to keep their root account permissions. If not specified, this field will be root_squash by default. Example: no_root_squash |
| Priority | No | No | Int64 | Rule priority. Value range: 1-100, where 1 means the highest, and 100 the lowest Example: 7 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| PGroupId | String | Permission group ID Example: pg-xqwqewe |
| RuleId | String | Rule ID Example: rule-xc2cxzcsd |
| AuthClientIp | String | Client IP address or IP address range allowed for access Example: 10.0.0.10 |
| RWPermission | String | R/W permission Example: rw |
| UserPermission | String | User permissions Example: no_root_squash |
| Priority | Int64 | Priority Example: 7 |
| 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 |
| InternalError.GetAccountStatusFailed | Failed to obtain user fee status. |
| FailedOperation.PgroupInUse | Permission group already bound to the file system. |
| InvalidParameterValue.DuplicatedRuleAuthClientIp | Duplicate rule IP. |
| InvalidParameterValue.InvalidAuthClientIp | Rule IP error. |
| InvalidParameterValue.InvalidPgroup | The permission group does not belong to the user. |
| InvalidParameterValue.InvalidPriority | Priority setting error. |
| InvalidParameterValue.InvalidRwPermission | Read/Write permission setting error. |
| InvalidParameterValue.InvalidUserPermission | User permissions setting error. |
| InvalidParameterValue.RuleNotMatchPgroup | Permission group rules and permission group do not match. |
| ResourceNotFound.PgroupNotFound | Permission group does not exist. |
| FailedOperation | Operation failed |
| UnsupportedOperation | Operation unsupported. |
| FailedOperation.PgroupIsUpdating | The permission group is being updated. |
| UnsupportedOperation.UnverifiedUser | User not authenticated with real name. |
| UnsupportedOperation.OutOfService | Out of service due to overdue payment. Top up and try again. |