文件存储创建权限组规则-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： cfs.tencentcloudapi.com 。

本接口（CreateCfsRule）用于创建权限组规则。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateCfsRule。
Version	是	String	公共参数，本接口取值：2019-07-19。
Region	是	String	公共参数，详见产品支持的地域列表。
PGroupId	是	String	权限组 ID 示例值：pgroup-12345
AuthClientIp	是	String	可以填写单个 IP 或者单个网段，例如 10.1.10.11 或者 10.10.1.0/24。默认来访地址为*表示允许所有。同时需要注意，此处需填写 CVM 的内网 IP。示例值：10.1.1.10
Priority	是	Integer	规则优先级，参数范围1-100。其中 1 为最高，100为最低示例值：9
RWPermission	否	String	读写权限, 值为 RO、RW；其中 RO 为只读，RW 为读写，不填默认为只读示例值：rw
UserPermission	否	String	用户权限，值为 all_squash、no_all_squash、root_squash、no_root_squash。 all_squash：所有访问用户（含 root 用户）都会被映射为匿名用户或用户组。 no_all_squash：所有访问用户（含 root 用户）均保持原有的 UID/GID 信息。 root_squash：将来访的 root 用户映射为匿名用户或用户组，非 root 用户保持原有的 UID/GID 信息。 no_root_squash：与 no_all_squash 效果一致，所有访问用户（含 root 用户）均保持原有的 UID/GID 信息示例值：root_squash

3. 输出参数

参数名称	类型	描述
RuleId	String	规则 ID 示例值：rule-12345
PGroupId	String	权限组 ID 示例值：pgroup-12345
AuthClientIp	String	客户端 IP 示例值：10.1.1.10
RWPermission	String	读写权限示例值：rw
UserPermission	String	用户权限示例值：root_squash
Priority	Integer	优先级示例值：9
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建权限组规则

输入示例

POST / HTTP/1.1
Host: cfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCfsRule
<公共请求参数>

{
    "RWPermission": "rw",
    "AuthClientIp": "10.1.1.10",
    "PGroupId": "pgroup-12345",
    "Priority": "9",
    "UserPermission": "root_squash"
}

输出示例

{
    "Response": {
        "RequestId": "fjo8aejo-fjei-32eu-2je9-fhue83nd81",
        "RuleId": "rule-12345",
        "PGroupId": "pgroup-12345",
        "AuthClientIp": "10.1.1.10",
        "RWPermission": "rw",
        "UserPermission": "root_squash",
        "Priority": 9
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
FailedOperation.PgroupInUse	权限组已绑定文件系统。
FailedOperation.PgroupIsUpdating	权限组正在更新中。
InternalError	内部错误。
InternalError.GetAccountStatusFailed	获取用户费用状态失败。
InvalidParameter	参数错误。
InvalidParameterValue.DuplicatedRuleAuthClientIp	规则IP重复。
InvalidParameterValue.InvalidAuthClientIp	规则IP错误。
InvalidParameterValue.InvalidPgroup	权限组不属于该用户。
InvalidParameterValue.InvalidPriority	优先级设置错误。
InvalidParameterValue.InvalidRwPermission	读写权限设置错误。
InvalidParameterValue.InvalidUserPermission	用户权限设置错误。
ResourceInsufficient.RuleLimitExceeded	规则条数超过上限。
ResourceNotFound.PgroupNotFound	权限组不存在。
UnsupportedOperation	操作不支持。
UnsupportedOperation.OutOfService	用户已欠费, 请充值后重试。
UnsupportedOperation.UnverifiedUser	用户未经过实名认证。

创建权限组规则

本页目录：