tencent cloud

Feedback

DescribeDependOpsTasks

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

1. API Description

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

Search for upstream/downstream task nodes by hierarchy

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: DescribeDependOpsTasks.
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.
TaskId Yes String Task ID
Deep Yes Integer Upstream/Downstream Levels 1-6
Up Yes Integer 1: Indicates querying upstream nodes; 0: Indicates querying downstream nodes; 2: Indicates querying both upstream and downstream nodes
ProjectId Yes String Project ID
WorkflowId Yes String Task Workflow ID

3. Output Parameters

Parameter Name Type Description
Data OpsTaskCanvasInfoList Canvas Task and Link 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 Example of Finding Upstream and Downstream Task Nodes Based on Hierarchy

Task Operation and Maintenance - Find Upstream and Downstream Task Nodes Based on Hierarchy

Input Example

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDependOpsTasks
<Common Request Parameters>{
    "TaskId": "your taskId",
    "Deep": 1,
    "Up": 1,
    "ProjectId": "your projectId",
    "WorkflowId": "c66ddxa3ee-aa0b-11ee-8d13-aaaa20f8272"
}

Output Example

{
    "Response": {
        "Data": {
            "LinksList": [],
            "TasksList": [
                {
                    "CycleUnit": "D",
                    "DelayTime": 0,
                    "FirstRunTime": "2024-01-03 00:00:00",
                    "FirstSubmitTime": "2024-01-03 16:36:35",
                    "FolderId": "b1f2ff1-aa0b-11ee-8d13-ae120f8272",
                    "FolderName": "0_axb",
                    "InCharge": ";jack;",
                    "Layer": null,
                    "LeftCoordinate": 3615,
                    "ProjectId": "your projectId",
                    "ProjectIdent": "project_wedata",
                    "ProjectName": "project_wedata",
                    "ScheduleDesc": "Execute once daily at 00:00",
                    "Status": "Y",
                    "TaskAction": "",
                    "TaskId": "your taskId",
                    "TaskName": "mysql2hive_test",
                    "TaskTypeDesc": "Offline Synchronization",
                    "TaskTypeId": 26,
                    "TopCoordinate": 1612,
                    "VirtualFlag": false,
                    "WorkflowId": "c66ddxa3ee-aa0b-11ee-8d13-aaaa20f8272",
                    "WorkflowName": "test11",
                    "TargetServiceId": "123",
                    "CreateTime": "2024-01-03 00:00:00",
                    "ExecutionStartTime": "2024-01-03 00:00:00",
                    "ExecutionEndTime": "2024-01-04 00:00:00",
                    "SourceServiceId": "321",
                    "SourceServiceType": "hive",
                    "TargetServiceType": "hive",
                    "AlarmType": "1"
                }
            ]
        },
        "RequestId": "5c961bb7-d22a-4a3e-bfa6-9a4a64084632"
    }
}

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.