tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateWorkGroup

Last updated: 2024-08-08 15:32:31

1. API Description

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

This API is used to create working 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: CreateWorkGroup.
Version Yes String Common Params. The value used for this API: 2021-01-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
WorkGroupName Yes String Working group name
WorkGroupDescription No String Working group description
PolicySet.N No Array of Policy Collections of authentication policies bound to working groups
UserIds.N No Array of String Collection of IDs of users to be bound to working groups

3. Output Parameters

Parameter Name Type Description
WorkGroupId Integer Working group ID which is globally unique
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 Working Groups

Input Example

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

{
    "WorkGroupName": "Group1",
    "WorkGroupDescription": "testGroup",
    "PolicySet": [
        {
            "Table": "TableName",
            "Catalog": "COSDataCatalog",
            "Operation": "ALL",
            "Database": "DatabaseName"
        }
    ]
}

Output Example

{
    "Response": {
        "WorkGroupId": 1,
        "RequestId": "1287310-badou889lodj-1231jk12"
    }
}

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.GrantPolicyFailed Authorization failed.
InternalError An internal error occurred.
InvalidParameter.DuplicateGroupName The working group name is duplicated.
InvalidParameter.InvalidAccessPolicy The access policy is invalid.
InvalidParameter.InvalidDescription The description information is invalid.
InvalidParameter.InvalidWorkGroupName The working group name is invalid.
ResourcesSoldOut The resource is sold out.
ResourcesSoldOut.UnauthorizedGrantPolicy There is no permission authorization policy.
ResourcesSoldOut.UnauthorizedOperation There is no permission to operate.
UnauthorizedOperation Unauthorized operation.
UnauthorizedOperation.CreateWorkgroup Sub-users are not administrators and cannot create working groups.
UnauthorizedOperation.GrantPolicy Sub-users do not have the authority to grant specific permissions.
UnauthorizedOperation.UserNotExist The sub-user does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy