tencent cloud

文件存储

动态与公告
产品动态
产品公告
产品简介
产品概述
产品优势
存储类型及性能规格
使用场景
推荐地域
系统限制
购买指南
计费概述
价格总览
通用系列计费方式
Turbo 系列计费方式
吞吐型计费方式
快照计费方式
低频计费方式
资源单位包
资源购买
查看账单
欠费说明
快速入门
创建文件系统及挂载点
在Linux 客户端上使用 CFS 文件系统
在 Windows 客户端上使用 CFS 文件系统
在 Linux 客户端上使用 CFS Turbo 文件系统
使用 CFS 客户端助手挂载文件系统
操作指南
访问管理
管理文件系统
权限管理
使用标签
快照管理
跨可用区、跨网络访问指引
自动挂载文件系统
数据迁移服务
用户权限管理
用户配额
数据加密
数据生命周期管理
升级通用标准型文件系统
实践教程
NFS 客户端内核选择
Turbo 目录管理
计算实例销毁
在容器 TKE 上使用 CFS
在云函数 SCF上使用 CFS
在容器 TKE 上使用 CFS Turbo
在 Serverless 容器服务上使用 CFS Turbo
Turbo 文件系统网络选择
文件存储数据拷贝方案
文件存储性能测试
API 文档
History
Introduction
API Category
Snapshot APIs
File system APIs
Lifecycle APIs
Other APIs
Data Flow APIs
Making API Requests
Permission Group APIs
Service APIs
Scaling APIs
Data Migration APIs
Data Types
Error Codes
故障处理
小文件及高并发场景下客户端使用卡顿
常见问题
服务等级协议
联系我们
词汇表

UpdateCfsRule

PDF
聚焦模式
字号
最后更新时间: 2026-03-24 17:02:14

1. API Description

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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.

3. Output Parameters

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.

4. Example

Example1 Update permission group rules.

Input Example

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"
}

Output Example

{
    "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
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈