tencent cloud

Tencent Cloud WeData

ListTaskFolders

PDF
聚焦模式
字号
最后更新时间: 2026-03-02 12:27:08

1. API Description

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

Query Task Folder 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: ListTaskFolders.
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. This API only supports: ap-hongkong, ap-jakarta, ap-singapore, eu-frankfurt, na-ashburn, na-siliconvalley.
ProjectId Yes String Project ID.
ParentTaskFolderPath Yes String Absolute path of the parent folder, such as /abc/de. if it is the root directory, pass /.
WorkflowId Yes String Workflow ID.
TaskFolderType Yes String Task folder type.

| task folder type parameter | task folder type interface corresponding name |.
| ---------------- | ------------------------ |
ETL | integration task.
| EMR | EMR |
| DLC | DLC |
| SETATS | SETATS |
| TDSQL | TDSQL |
| TCHOUSE | TCHOUSE |
GENERAL.
TI_ONE | ti-one machine learning.
ACROSS_WORKFLOWS | cross-workflow.

PageNumber No Integer Number of data pages, equal to or greater than 1. default is 1.
PageSize No Integer Number of data records displayed per page. minimum value is 10. maximum value is 200. default value is 10.

3. Output Parameters

Parameter Name Type Description
Data TaskFolderPage Paged folder query result.
Note: This field may return null, indicating that no valid values can be obtained.
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 Query Job Folder List

Query job folder list

Input Example

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

{
    "ProjectId": "1486804694126882816",
    "ParentTaskFolderPath": "/",
    "WorkflowId": "1eb20625-48fa-44db-a9bd-0d203750285f",
    "TaskFolderType": "GENERAL",
    "PageNumber": 1,
    "PageSize": 10
}

Output Example

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "CreateUserUin": "100028579896",
                    "TaskFolderId": "e96662ab-ac31-47ab-9028-49ba2922ba78",
                    "TaskFolderPath": "/test_task_folder_01",
                    "ProjectId": "1486804694126882816"
                },
                {
                    "CreateUserUin": "100028579896",
                    "TaskFolderId": "f1f9c1c0-7869-4696-948e-a57d732be296",
                    "TaskFolderPath": "/tf_01",
                    "ProjectId": "1486804694126882816"
                }
            ],
            "PageNumber": 1,
            "PageSize": 10,
            "TotalCount": 2,
            "TotalPageNumber": 1
        },
        "RequestId": "70bc41db-80aa-4115-80f8-2f4b2e956057"
    }
}

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.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
LimitExceeded The quota limit is exceeded.
MissingParameter Parameter missing.
OperationDenied Operation denied.
ResourceInUse The resource is occupied.
ResourceNotFound The resource does not exist.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈