tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAllByFolderNew

Last updated: 2024-06-21 15:10:27

1. API Description

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

Query all subfolders + workflows under the parent directory

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: DescribeAllByFolderNew.
Version Yes String Common Params. The value used for this API: 2021-08-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Folder No FolderOpsDto Folder Attributes
Workflows.N No Array of WorkflowCanvasOpsDto Workflow List
TargetFolderId No String Target File ID
KeyWords No String Keyword
ParentsFolderId No String Parent File ID
IsAddWorkflow No String Pull Folder List
TaskStates.N No Array of String Task Status
FindType No String Search type
OptType No String Access type
OperatorName No String Operator Name
OperatorId No String Operator ID
ProjectId No String Project ID
ProjectIdent No String Project Identifier
ProjectName No String Project name
PageIndex No Integer Index Page Number
PageSize No Integer Page size
Count No Integer Total Data
RequestBaseInfo No ProjectBaseInfoOpsRequest Basic Request Information
IsCount No Boolean Whether to Calculate Total

3. Output Parameters

Parameter Name Type Description
Data CollectionFolderOpsDto Result Set
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 Testing

Testing

Input Example

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAllByFolderNew
<Common Request Parameters>{
    "ProjectId": "1460947878944567296",
    "Folder": {
        "Id": "c789de4f-bcc7-11ed-b7fc-043f72e73c62",
        "ProjectId": "1460947878944567296"
    },
    "Workflows": [
        {
            "WorkflowId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
        }
    ],
    "TargetFolderId": "c123de4f-b127-21cd-b7fc-043f98y73c62",
    "FindType": "all",
    "KeyWords": "",
    "TaskStates": []
}

Output Example

{
    "Response": {
        "Data": {
            "TotalCount": 0,
            "TotalPage": 0,
            "PageCount": 0,
            "PageNumber": 0,
            "PageSize": 0,
            "Items": [
                {
                    "Id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                    "CreateTime": "2023-03-25 09:06:00",
                    "Name": "test",
                    "ProjectId": "1460947878944567296",
                    "UpdateTime": "2023-03-25 09:06:00",
                    "ParentsFolderId": "c789de4f-bcc7-11ed-b7fc-043f72e73c62",
                    "Total": 1,
                    "Workflows": [
                        {
                            "WorkflowId": "c789de4f-bcc7-11ed-b7fc-043f72e73c62",
                            "WorkflowDesc": "wf_0",
                            "WorkflowName": "wf_0",
                            "FolderId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                            "FolderIds": [
                                "f47ac10b-58cc-4372-a567-0e02b2c3d479"
                            ],
                            "Tasks": [
                                {
                                    "TaskId": "20230405060708098",
                                    "VirtualTaskId": "",
                                    "VirtualFlag": false,
                                    "TaskName": "task_1",
                                    "WorkflowId": "c789de4f-bcc7-11ed-b7fc-043f72e73c62",
                                    "RealWorkflowId": "",
                                    "WorkflowName": "wf_0 ",
                                    "FolderId": "f47ac10b-58cc-4372-a567-0e02b2c3d479 ",
                                    "FolderName": "test_dir",
                                    "CreateTime": "2023-08-25 09:06:00 ",
                                    "LastUpdate": "2023-08-25 09:06:00 ",
                                    "Status": "",
                                    "InCharge": "tom",
                                    "InChargeId": "123435345",
                                    "StartTime": "2023-08-25 09:09:00 ",
                                    "EndTime": "2023-08-25 09:15:00 ",
                                    "ExecutionStartTime": "2023-08-25 09:09:00 ",
                                    "ExecutionEndTime": "2023-08-25 09:09:00 ",
                                    "CycleType": "D",
                                    "CycleStep": 1,
                                    "CrontabExpression": "0,1 0 0 0 0",
                                    "DelayTime": 1,
                                    "StartupTime": 1,
                                    "RetryWait": 1,
                                    "RetryAble": 1,
                                    "TaskAction": "",
                                    "TryLimit": 1,
                                    "RunPriority": 1,
                                    "TaskType": {
                                        "TypeDesc": "",
                                        "TypeId": 0,
                                        "TypeSort": ""
                                    },
                                    "BrokerIp": null,
                                    "ClusterId": null,
                                    "MinDateTime": null,
                                    "MaxDateTime": null,
                                    "ExecutionTTL": 0,
                                    "SelfDepend": null,
                                    "LeftCoordinate": 0,
                                    "TopCoordinate": 0,
                                    "Notes": null,
                                    "InstanceInitStrategy": null,
                                    "YarnQueue": null,
                                    "LastSchedulerCommitTime": null,
                                    "NormalizedJobStartTime": null,
                                    "SchedulerDesc": null,
                                    "ResourceGroup": null,
                                    "Creator": null,
                                    "DependencyRel": null,
                                    "DependencyWorkflow": null,
                                    "EventListenerConfig": null,
                                    "EventPublisherConfig": null,
                                    "VirtualTaskStatus": null,
                                    "TaskLinkInfo": {
                                        "Id": null,
                                        "LinkKey": null,
                                        "TaskFrom": null,
                                        "TaskTo": null,
                                        "InCharge": null,
                                        "LinkDependencyType": null,
                                        "Offset": null,
                                        "LinkType": null,
                                        "WorkflowId": null
                                    },
                                    "TargetServiceId": null,
                                    "Submit": null,
                                    "SourceServiceId": null,
                                    "TargetServiceType": null,
                                    "TasksStr": null,
                                    "SourceServiceType": null,
                                    "ProductName": null,
                                    "ProjectId": null,
                                    "ProjectIdent": null,
                                    "ProjectName": null,
                                    "OwnId": null,
                                    "UserId": null,
                                    "TenantId": null,
                                    "UpdateUser": null,
                                    "UpdateTime": null,
                                    "UpdateUserId": null,
                                    "TaskTypeId": 0,
                                    "TaskTypeDesc": null,
                                    "ShowWorkflow": true,
                                    "FirstSubmitTime": null,
                                    "FirstRunTime": null,
                                    "ScheduleDesc": null,
                                    "CycleNum": 0,
                                    "Crontab": null,
                                    "StartDate": null,
                                    "EndDate": null,
                                    "CycleUnit": null,
                                    "InitStrategy": null,
                                    "Layer": null
                                }
                            ],
                            "Links": [
                                {
                                    "Id": null,
                                    "LinkKey": null,
                                    "TaskFrom": null,
                                    "TaskTo": null,
                                    "InCharge": null,
                                    "LinkDependencyType": null,
                                    "Offset": null,
                                    "LinkType": null,
                                    "WorkflowId": null
                                }
                            ],
                            "UserGroupId": null,
                            "UserGroupName": null,
                            "ProjectId": null,
                            "ProjectIdent": null,
                            "ProjectName": null,
                            "Owner": null,
                            "OwnerId": null
                        }
                    ],
                    "TotalFolders": 0,
                    "FoldersList": null,
                    "FindType": null
                }
            ]
        },
        "RequestId": "e125de4f-acc3-22ed-b5fc-123f72e73c62"
    }
}

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 Failure.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy