CreateGroup

Last updated: 2019-12-14 11:23:41

PDF

1. API Description

API domain name: cam.tencentcloudapi.com.

This API creates a user group.

Default API request rate limit: 20 requests/sec.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter; the name of this API: CreateGroup
Version Yes String Common parameter; the version of this API: 2019-01-16
Region No String Common parameter; optional for this API.
GroupName Yes String Name of the user group
Remark No String Description of the user group

3. Output Parameters

Parameter name Type Description
GroupId Integer User group ID
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Sample

Sample 1. Creating a User Group

Input Sample Code

https://cam.tencentcloudapi.com/?Action=CreateGroup
&GroupName=test1
&Remark=test2
&<Common request parameter>

Output Sample Code

{
  "Response": {
    "GroupId": 2020,
    "RequestId": "f36a5d34-0d51-4b91-b9fc-af5d02571656"
  }
}

5. Developer Resources

API Explorer

This tool provides various capabilities such as online call, signature verification, SDK code generation, and quick API retrieval that significantly reduce the difficulty of using TencentCloud API.

6. Error Codes

The following error codes are API business logic-related. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameter.GroupFull The number of user groups has reached the upper limit.
InvalidParameter.GroupNameInUse The name of the user group already exists.