tencent cloud

APIs

ListWorkflowTaskRuns

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-10-11 15:48:05

1. API Description

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

Query the historical operation list of workflow tasks

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: ListWorkflowTaskRuns.
Version Yes String Common Params. The value used for this API: 2026-07-15.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
WorkspaceId Yes String

Workspace ID, which can be obtained through ListWorkspaces. Required.

TaskId No String

Task ID, which can be obtained through the ListWorkflowTasks API. Optional, exact match. Pass at least one of this parameter and WorkflowRunId: if only TaskId is passed, all execution history of the task is queried.

WorkflowRunId No String

Workflow run ID, which can be obtained through ListWorkflowRuns. Optional, exact match. Pass at least one of this parameter and TaskId: if only WorkflowRunId is passed, all task runs under this workflow run are queried.

PageNumber No Integer

Page number. Value range: starts from 1. Optional. Default value: 1.

PageSize No Integer

Size per page. Optional. Default: 10. Value range: [10, 200]

3. Output Parameters

Parameter Name Type Description
Data ListWorkflowTaskRunsRsp

Response content of querying the historical operation list of workflow tasks

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 Workflow Task History Run List

Input Example

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

{
    "WorkspaceId": "17697410068842890",
    "TaskId": "f2d5ffc0-af32-4584-a315-b106637f1bfe",
    "WorkflowRunId": "8e0e3485-2736-4530-92ed-932e019898f1_1786115878097"
}

Output Example

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "CreateTime": "1786115878247",
                    "CreateUserUin": "700002164618",
                    "DependOnList": [],
                    "ErrorCodeString": "",
                    "IsLatestRun": true,
                    "JobId": "",
                    "RerunTimes": 0,
                    "ResourceGroupId": "",
                    "ResourceGroupInfoList": [],
                    "RetryTimes": 0,
                    "RunParams": "",
                    "RunResult": "",
                    "RunState": "CREATE",
                    "RunUserName": "",
                    "RunUserUin": "700002164618",
                    "TaskId": "f2d5ffc0-af32-4584-a315-b106637f1bfe",
                    "TaskName": "py_0807",
                    "TaskTypeExtensions": "",
                    "TaskTypeName": "PYTHON",
                    "TaskVersionId": "2cf47642-f9b8-4b93-a6fa-31a03810c423",
                    "TimeZone": "",
                    "TriggerType": "",
                    "UpdateTime": "1786115878236",
                    "WorkflowId": "8e0e3485-2736-4530-92ed-932e019898f1",
                    "WorkflowName": "",
                    "WorkflowRunId": "8e0e3485-2736-4530-92ed-932e019898f1_1786115878097",
                    "WorkflowTaskRunId": "f2d5ffc0-af32-4584-a315-b106637f1bfe_1786115878097_1",
                    "WorkspaceId": "17697410068842890"
                }
            ],
            "PageNumber": 1,
            "PageSize": 10,
            "TotalCount": 1,
            "TotalPageNumber": 1
        },
        "RequestId": "6e166d32-30fc-49f3-9e01-61ab8af86417"
    }
}

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.
FailedOperation.WorkflowNoPermission No operation permissions.
InternalError.UnknownError Unknown error.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
InvalidParameterValue.ParamBlankError Parameter <parameter> cannot be empty.
InvalidParameterValue.ParamIllegalError Parameter <parameter> does not meet requirements: <message>
InvalidParameterValue.ParamNullError Parameter <parameter> cannot be null.
MissingParameter Parameters are missing.
OperationDenied Operation denied.
RegionError Region error
ResourceNotFound The resource does not exist.

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백