接口请求域名: organization.intl.tencentcloudapi.com 。
创建用户组
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateGroup。 |
| Version | 是 | String | 公共参数,本接口取值:2021-03-31。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ZoneId | 是 | String | 空间 ID。 |
| GroupName | 是 | String | 用户组的名称。 格式:允许英文字母、数字和特殊字符-。 长度:最大 128 个字符。 |
| Description | 否 | String | 用户组的描述。 长度:最大 1024 个字符。 |
| GroupType | 否 | String | 用户组类型 Manual:手动创建,Synchronized:外部导入 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| GroupInfo | GroupInfo | 用户组信息。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
创建用户组
POST / HTTP/1.1
Host: organization.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateGroup
<公共请求参数>
{
"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"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.GroupOverUpperLimit | 用户组创建超过限制 |
| FailedOperation.IdentityCenterNotOpen | CIC服务没有开通 |
| FailedOperation.ZoneIdNotExist | CIC服务的用户zoneId不存在 |
| InvalidParameter.GroupNameAlreadyExists | 用户组名称已经存在 |
| InvalidParameter.GroupNameFormatError | 用户组名称格式错误 |
文档反馈