tencent cloud

APIs

DescribeAggregator

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-10-19 15:49:01

1. API Description

Domain name for API request: config.intl.tencentcloudapi.com.

This example shows you how to query account group details.

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: DescribeAggregator.
Version Yes String Common Params. The value used for this API: 2022-08-02.
Region No String Common Params. This parameter is not required.
AccountGroupId Yes String

Account group ID.

OwnerUin Yes Integer

Account group creator ID.

3. Output Parameters

Parameter Name Type Description
Name String

Account group name.

Description String

Account group description.

Type String

Account group type.

AggregatorAccounts Array of AggregatorAccount

Member information.

AggregatorStatus Integer

Creation status.

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 This example shows you how to query account group details.

This example shows you how to query account group details.

Input Example

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

{
    "OwnerUin": 234234324,
    "AccountGroupId": "ca-sdfs7734h24h3"
}

Output Example

{
    "Response": {
        "AggregatorAccounts": [
            {
                "MemberUin": 23423424,
                "MemberName": "test_user"
            }
        ],
        "Type": "RD",
        "Description": "Global account group",
        "RequestId": "73d105d8-5820-434f-9fac-76f926e61c",
        "Name": "Name",
        "AggregatorStatus": 1
    }
}

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
InternalError Internal error.
InvalidParameter Parameter error.
ResourceNotFound.AccountGroupIsNotExist Account group does not exist.
ResourceNotFound.MemberNotExist The member does not exist.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック