创建用户组
最近更新时间: 2026-10-12 00:11:06
1. 接口描述
接口请求域名: cic.api3.fincloud.tencent.com。
创建用户组
默认接口请求频率限制:20次/秒。
接口更新时间:2024-12-11 12:17:58。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:CreateGroup |
| Version | 是 | 否 | String | 公共参数,本接口取值:2021-03-31 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| ZoneId | 是 | 是 | String | 空间 ID。 示例值: z-2d8shd8*** |
| GroupName | 是 | 是 | String | 用户组的名称。 格式:允许英文字母、数字和特殊字符-。 长度:最大 128 个字符。 示例值: group_name |
| Description | 否 | 是 | String | 用户组的描述。 长度:最大 1024 个字符。 示例值: description |
| GroupType | 否 | 是 | String | 用户组类型 Manual:手动创建,Synchronized:外部导入 示例值: Manual |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| GroupInfo | GroupInfo | 用户组信息。 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.IdentityCenterNotOpen | |
| FailedOperation.ZoneIdNotExist | |
| InvalidParameter.GroupNameFormatError | |
| InvalidParameter.GroupNameAlreadyExists | |
| FailedOperation.GroupOverUpperLimit |
5. 示例
示例1 创建用户组
输入示例
{
"ZoneId": "z-7cbs6s6gs***",
"GroupName": "testGroup",
"Description": "this is group"
}
输出示例
{
"Response": {
"GroupInfo": {
"GroupName": "testGroup",
"Description": "this is group",
"CreateTime": "2024-01-01 12:12:12",
"GroupType": "Manual",
"UpdateTime": "2024-01-01 12:12:12",
"GroupId": "g-8sh7baix****",
"MemberCount": 0
},
"RequestId": "e297543a-80de-4039-83c8-9d35d4545"
}
}