Release Notes
Announcements
Domain name for API request: cfs.intl.tencentcloudapi.com.
This API is used to update a permission rule.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: UpdateCfsRule. |
| Version | Yes | String | Common Params. The value used for this API: 2019-07-19. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| PGroupId | Yes | String | Permission group ID, which can be obtained through the api DescribeCfsPGroups. |
| RuleId | Yes | String | Rule ID, which can be obtained through the DescribeCfsRules api. |
| AuthClientIp | No | String | You can enter a single IP or IP range, such as 10.1.10.11 or 10.10.1.0/24. The default visiting address is *, indicating that all IPs are allowed. Please note that you need to enter the CVM instance's private IP here. |
| RWPermission | No | String | Read/write permission. Valid values: RO (read-only), RW (read & write). Default value: RO |
| UserPermission | No | String | User permission. valid values: all_squash, no_all_squash, root_squash, no_root_squash. default value: root_squash. All_squash: all accessing users (including the root user) will be mapped to anonymous users or groups. no_all_squash: all accessing users (including the root user) retain original UID/GID information. root_squash: maps visiting root user to anonymous user or user group. non-root user keeps original UID/GID information. no_root_squash: has the same effect as no_all_squash. all accessing users (including the root user) retain their original UID/GID information. |
| Priority | No | Integer | Rule priority. value range: 1-100. among them, 1 is the highest and 100 is the minimum. default value: 100. |
| Parameter Name | Type | Description |
|---|---|---|
| PGroupId | String | Permission group ID |
| RuleId | String | Rule ID |
| AuthClientIp | String | Client IP or IP range allowed for access |
| RWPermission | String | Read & write permission |
| UserPermission | String | User permission |
| Priority | Integer | Priority |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cfs.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateCfsRule
<Common request parameters>
{
"RWPermission": "rw",
"Priority": 7,
"PGroupId": "pgroup-12345",
"RuleId": "rule-12345",
"AuthClientIp": "10.0.0.10",
"UserPermission": "no_root_squash"
}
{
"Response": {
"RequestId": "fjo8aejo-fjei-32eu-2je9-fhue83nd81",
"PGroupId": "pgroup-12345",
"RuleId": "rule-12345",
"AuthClientIp": "10.0.0.10",
"RWPermission": "rw",
"UserPermission": "no_root_squash",
"Priority": 7
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.PgroupInUse | The permission group has been bound to a file system. |
| FailedOperation.PgroupIsUpdating | The permission group is being updated. |
| FailedOperation.PgroupLinkCfsv10 | The permission group has been associated with a legacy instance. Please unassociate it and try again. |
| InternalError | Internal error. |
| InternalError.GetAccountStatusFailed | Failed to get the payment status of the user. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue.DuplicatedRuleAuthClientIp | The rule IP already exists. |
| InvalidParameterValue.InvalidAuthClientIp | Incorrect rule IP. |
| InvalidParameterValue.InvalidPgroup | The permission group is not under this user. |
| InvalidParameterValue.InvalidPriority | Incorrect priority settings. |
| InvalidParameterValue.InvalidRwPermission | Incorrect read/write permission settings. |
| InvalidParameterValue.InvalidUserPermission | Incorrect user permission settings. |
| InvalidParameterValue.RuleNotMatchPgroup | The permission group rule and permission group do not match. |
| ResourceNotFound.PgroupNotFound | The permission group does not exist. |
| UnsupportedOperation | Unsupported operation. |
| UnsupportedOperation.OutOfService | Your account is in arrears. Please top up and try again. |
| UnsupportedOperation.UnverifiedUser | Unverified user. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback