tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeWorkGroups

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

1. API Description

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

This API is used to get a list of 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: DescribeWorkGroups.
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.
WorkGroupId No Integer IDs of working groups that are queried. If it is not filled in or is 0, this means no need for filtering.
Filters.N No Array of Filter Filter criteria. Only the fuzzy search according to working group names is supported. The key is workgroup-name.
Offset No Integer Offset, which is 0 by default.
Limit No Integer Quantity of returns. It is 20 by default, and the maximum value is 100.
SortBy No String Sorting fields, which support the following type: create-time
Sorting No String Sorting methods; desc means in order; asc means in reverse order; it is asc by default.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer The total number of working groups
WorkGroupSet Array of WorkGroupInfo Collection of working 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 Getting a List of Working Groups

Input Example

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

{
    "Sorting": "desc",
    "WorkGroupId": 1,
    "Limit": 0,
    "SortBy": "create-time",
    "Filters": [
        {
            "Values": [
                "workgroup-name"
            ],
            "Name": "Group1"
        }
    ],
    "Offset": 0
}

Output Example

{
    "Response": {
        "WorkGroupSet": [
            {
                "PolicySet": [
                    {
                        "Table": "TableName",
                        "Catalog": "COSDataCatalog",
                        "Operation": "ALL",
                        "Database": "DatabaseName"
                    }
                ],
                "WorkGroupId": 1,
                "Creator": "1248065439",
                "UserNum": 1,
                "WorkGroupDescription": "test group",
                "WorkGroupName": "Group1",
                "UserSet": [
                    {
                        "UserDescription": "test user",
                        "UserAlias": "testname",
                        "UserId": "1248065439",
                        "CreateTime": "2021-07-28 16:19:32",
                        "Creator": "1248065439"
                    }
                ],
                "CreateTime": "2021-07-28 16:19:32"
            }
        ],
        "TotalCount": 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.GetPolicyFailed Obtaining the authentication policy failed.
FailedOperation.GetUserInfoFailed Obtaining user information failed. Please try again or submit a ticket to contact us.
FailedOperation.GetWorkGroupInfoFailed Obtaining working group information failed.
InternalError An internal error occurred.
InternalError.InternalSystemException The business system is abnormal. Please try again or submit a ticket to contact us.
InvalidParameter.InvalidAccessPolicy The access policy is invalid.
InvalidParameter.InvalidFilterKey The filter condition is not supported.
InvalidParameter.InvalidOffset The Offset value is invalid.
InvalidParameter.InvalidSortByType The sorting type is not supported.
InvalidParameter.InvalidSorting Invalid Sorting
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy