tencent cloud

文档反馈

CreateGroup

最后更新时间:2024-08-26 11:25:08

1. API Description

Domain name for API request: organization.tencentcloudapi.com.

This API is used to create user groups.

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: CreateGroup.
Version Yes String Common Params. The value used for this API: 2021-03-31.
Region No String Common Params. This parameter is not required.
ZoneId Yes String Space ID.
GroupName Yes String User group name, which contains up to 128 characters, including English letters, digits, and special characters (-).
Description No String User group description, which contains up to 1024 characters.

3. Output Parameters

Parameter Name Type Description
GroupInfo GroupInfo User group information.
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 Creating User Groups

This example shows you how to create user groups.

Input Example

POST / HTTP/1.1
Host: organization.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateGroup
<Common request parameters>

{
    "ZoneId": "z-7cbs6s6gs***",
    "GroupName": "testGroup",
    "Description": "this is group"
}

Output Example

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

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.GroupOverUpperLimit User groups created exceed the upper limit.
FailedOperation.IdentityCenterNotOpen The CIC service is not enabled.
FailedOperation.ZoneIdNotExist The user zoneId of the CIC service does not exist.
InvalidParameter.GroupNameAlreadyExists The user group name already exists.
InvalidParameter.GroupNameFormatError The user group name has a format error.
联系我们

联系我们,为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持