查询权限组列表
最近更新时间: 2026-09-17 00:03:25
1. 接口描述
接口请求域名: cfs.api3.fincloud.tencent.cn。
本接口(DescribeCfsPGroups)用于查询权限组列表。
默认接口请求频率限制:20次/秒。
接口更新时间:2019-09-24 19:03:36。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeCfsPGroups |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-07-19 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InternationalFlag | 否 | 否 | Int64 | 此选项值为1时,默认权限组使用英文 示例值: 0 |
| PGroupId | 否 | 否 | String | 权限组ID 示例值: pgroup-1es6pwjb |
| Name | 否 | 否 | String | 权限组名称 示例值: qta-searchpgrouplist-ez5g-1255000219 |
| DescInfo | 否 | 否 | String | 权限组描述信息 示例值: default_pgroup |
| OrderBy | 否 | 否 | String | 排序字段,BindCfsNum或者CDate 示例值: BindCfsNum |
| OrderByType | 否 | 否 | String | 排序类型,ASC或者DESC 示例值: desc |
| Offset | 否 | 否 | Uint64 | Offset 分页码 示例值: 0 |
| Limit | 否 | 否 | Uint64 | Limit 页面大小 示例值: 100 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| PGroupList | Array of PGroupInfo | 权限组信息列表 示例值:查看 |
| TotalCount | Uint64 | 文件系统总数 示例值: 10 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| UnsupportedOperation.OutOfService | 用户已欠费, 请充值后重试。 |
| UnsupportedOperation.UnverifiedUser | 用户未经过实名认证。 |
| InternalError.GetAccountStatusFailed | 获取用户费用状态失败。 |
5. 示例
示例1 查询权限组列表
输入示例
https://cfs.api3.fincloud.tencent.cn/?Action=DescribeCfsPGroups
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "fjo8aejo-fjei-32eu-2je9-fhue83nd81",
"PGroupList": [
{
"PGroupId": "pg-xqwqewe",
"Name": "yf",
"DescInfo": "yf",
"BindCfsNum": 0,
"CDate": "2019-07-05 19:04:18"
},
{
"PGroupId": "pgroup-67890",
"Name": "yf2",
"DescInfo": "yf2",
"BindCfsNum": 0,
"CDate": "2019-07-06 10:57:29"
},
{
"PGroupId": "pgroup-54321",
"Name": "测试",
"DescInfo": "use for yf",
"BindCfsNum": 1,
"CDate": "2019-07-03 16:06:38"
},
{
"PGroupId": "pgroupbasic",
"Name": "默认权限组",
"DescInfo": "默认权限组",
"BindCfsNum": 5,
"CDate": "2019-06-21 17:30:05"
}
]
}
}