Creates a group.

Usage notes

This topic provides an example on how to create a group named TestGroup.

Limits

You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateGroup

The operation that you want to perform. Set the value to CreateGroup.

DirectoryId String Yes d-00fc2p61****

The ID of the directory.

GroupName String Yes TestGroup

The name of the group.

The name can contain letters, digits, underscores (_), hyphens (-), and periods (.).

The name can be up to 128 characters in length.

Description String No This is a group.

The description of the group.

The description can be up to 1,024 characters in length.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
Group Object

The information about the group.

GroupName String TestGroup

The name of the group.

Description String This is a group.

The description of the group.

CreateTime String 2021-11-01T02:38:27Z

The time when the group was created.

ProvisionType String Manual

The type of the group. The value is fixed as Manual, which indicates that the group is manually created.

UpdateTime String 2021-11-01T02:38:27Z

The time when the information about the group was modified.

GroupId String g-00jqzghi2n3o5hkh****

The ID of the group.

RequestId String 20E9650E-EC23-593E-933F-EA0D280D040C

The ID of the request.

Examples

Sample requests

https://[Endpoint]/?Action=CreateGroup
&DirectoryId=d-00fc2p61****
&GroupName=TestGroup
&Description=This is a group.
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateGroupResponse>
    <Group>
        <GroupName>TestGroup</GroupName>
        <Description>This is a group.</Description>
        <CreateTime>2021-11-01T02:38:27Z</CreateTime>
        <ProvisionType>Manual</ProvisionType>
        <UpdateTime>2021-11-01T02:38:27Z</UpdateTime>
        <GroupId>g-00jqzghi2n3o5hkh****</GroupId>
    </Group>
    <RequestId>20E9650E-EC23-593E-933F-EA0D280D040C</RequestId>
</CreateGroupResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Group" : {
    "GroupName" : "TestGroup",
    "Description" : "This is a group.",
    "CreateTime" : "2021-11-01T02:38:27Z",
    "ProvisionType" : "Manual",
    "UpdateTime" : "2021-11-01T02:38:27Z",
    "GroupId" : "g-00jqzghi2n3o5hkh****"
  },
  "RequestId" : "20E9650E-EC23-593E-933F-EA0D280D040C"
}

Error codes

For a list of error codes, visit the API Error Center.