tencent cloud

Tencent Cloud WeData

DocumentaçãoTencent Cloud WeDataAPI DocumentationResource Group APIsListResourceGroups

ListResourceGroups

PDF
Modo Foco
Tamanho da Fonte
Última atualização: 2026-03-02 12:25:27

1. API Description

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

This API is used to query the execution resource group list.

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: ListResourceGroups.
Version Yes String Common Params. The value used for this API: 2025-08-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Type No String Execution resource group type.

-Schedule --- scheduling resource group.
-Integration - integration resource group.
-DataService - data service resource group.
Id No String Resource group ID
Name No String Execution resource group name to search.
ProjectIds.N No Array of String Project space id query list.
PageNumber No Integer Number of pages.
PageSize No Integer Page size.

3. Output Parameters

Parameter Name Type Description
Data ExecutorResourceGroupData Pagination Results
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 Querying a Scheduling Resource Group

Input Example

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

{
    "Type": "Schedule",
    "Name": null,
    "ProjectIds": [
        null
    ],
    "PageNumber": null,
    "PageSize": null
}

Output Example

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "AssociateProjects": [
                        {
"ProjectDisplayName": "Data exploration_notebook verification"
                            "ProjectId": "2153380290671734784",
                            "ProjectName": null
                        }
                    ],
"Description": "Develop scheduling resource group - dedicated notebook"
                    "Id": "20240401132517098618",
                    "Name": "sche_group_notebook_1",
"Region": "Shanghai"
                    "ResourceGroupType": "Schedule",
                    "SubNet": "subnet-ecs42j4h",
                    "VpcId": "vpc-s1p37c5i"
                }
            ],
            "PageNumber": 1,
            "PageSize": 10,
            "TotalCount": 1,
            "TotalPageNumber": 1
        },
        "RequestId": "ed5d6286-ce77-487b-91c7-bfd4285375a4"
    }
}

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 Operation failed.
Anterior: CreateResourceGroupPróximo: GetResourceGroupMetrics

Ajuda e Suporte

Esta página foi útil?

comentários