tencent cloud

Tencent Cloud WeData

Release Notes
Dynamic Release Record (2026)
Product Introduction
Product Overview
Product Advantages
Product Architecture
Product Features
Application Scenarios
Purchase Guide
Billing Overview
Product Version Purchase Instructions
Execute Resource Purchase Description
Billing Modes
Overdue Policy
Refund
Preparations
Overview of Account and Permission Management
Add allowlist /security groups (Optional)
Sign in to WeData with Microsoft Entra ID (Azure AD) Single Sign-On (SSO)
Operation Guide
Console Operation
Project Management
Data Integration
Studio
Data Development
Data Analysis
Data Science
Data Governance (with Unity Semantics)
API Documentation
History
Introduction
API Category
Making API Requests
Smart Ops Related Interfaces
Project Management APIs
Resource Group APIs
Data Development APIs
Data Asset - Data Dictionary APIs
Data Development APIs
Ops Center APIs
Data Operations Related Interfaces
Data Exploration APIs
Asset APIs
Metadata Related Interfaces
Task Operations APIs
Data Security APIs
Instance Operation and Maintenance Related Interfaces
Data Map and Data Dictionary APIs
Data Quality Related Interfaces
DataInLong APIs
Platform Management APIs
Data Source Management APIs
Data Quality APIs
Platform Management APIs
Asset Data APIs
Data Source Management APIs
Data Types
Error Codes
WeData API 2025-08-06
Service Level Agreements
Related Agreement
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary

ListTaskInstances

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-03-02 12:26:08

1. API Description

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

This API is used to obtain instance lists.

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: ListTaskInstances.
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.
ProjectId Yes String Project ID. specifies the project ID.
PageNumber No Integer Page number. integer..
Used in conjunction with pageSize and cannot be less than 1. default value: 1.
PageSize No Integer Specifies the number of items to display per page. default: 10. value range: 1-100.
Keyword No String Task name or task ID.
Supports fuzzy search filtering. multiple values are separated by commas.
TimeZone No String Time zone timeZone, specifies the time zone of the passed in time string. default UTC+8.
InstanceType No Integer Instance Type

0 - Backfill instance

1 - Cyclic (scheduled) instance

2 - Non-cyclic (non-scheduled) instance
InstanceState No String Instance Status

WAIT_EVENT: Waiting for event

WAIT_UPSTREAM: Waiting for upstream

WAIT_RUN: Waiting to run

RUNNING: Running

SKIP_RUNNING: Skipped

FAILED_RETRY: Retrying after failure

EXPIRED: Failed

COMPLETED: Succeeded
TaskTypeId No Integer Task type Id.
CycleType No String Task Cycle Type

ONEOFF_CYCLE: One-time

YEAR_CYCLE: Yearly

MONTH_CYCLE: Monthly

WEEK_CYCLE: Weekly

DAY_CYCLE: Daily

HOUR_CYCLE: Hourly

MINUTE_CYCLE: Minute-level

CRONTAB_CYCLE: Crontab expression-based
OwnerUin No String Task owner id.
FolderId No String Folder id
WorkflowId No String Workflow id of the task.
ExecutorGroupId No String Execution resource group Id.
ScheduleTimeFrom No String Instance Scheduled Time Filter Condition specifies the filter start time in the time format yyyy-MM-dd HH:MM:ss.
ScheduleTimeTo No String Instance Scheduled Time Filter Condition specifies the cutoff time in the format of yyyy-MM-dd HH:MM:ss.
StartTimeFrom No String Instance Execution Start Time Filter Condition specifies the start time for filtering. time format: yyyy-MM-dd HH:MM:ss.
StartTimeTo No String Instance Execution Start Time Filter Condition.
Expiration time in yyyy-MM-dd HH:MM:ss format.
LastUpdateTimeFrom No String Instance Last Update Time Filter Condition.
Expiration time in yyyy-MM-dd HH:MM:ss format.
LastUpdateTimeTo No String Instance Last Update Time Filter Condition.
Expiration time in yyyy-MM-dd HH:MM:ss format.
SortColumn No String Query Result Sorting Field

SCHEDULE_DATE: Sort by scheduled execution time

START_TIME: Sort by actual execution start time

END_TIME: Sort by actual execution end time

COST_TIME: Sort by execution duration
SortType No String Instance Sorting Order

- ASC
- DESC

3. Output Parameters

Parameter Name Type Description
Data TaskInstancePage Instance 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 Retrieving the Task Instance List

Input Example

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

{
    "ProjectId": "1460947878944567296",
    "PageSize": 1,
    "TimeZone": "UTC+6"
}

Output Example

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "CostTime": 3000,
                    "CurRunDate": "2025-10-01 00:00:00",
                    "CycleType": "MONTH_CYCLE",
                    "EndTime": "2025-08-27 20:24:40",
                    "ExecutorGroupId": "20240222212719833743",
                    "ExecutorGroupName": "qfh_test",
                    "FolderId": "a1eb11e9-6f1a-11ed-8909-bc97e105ba60",
                    "FolderName": "u9ed8u8ba4u6587u4ef6u5939",
                    "InstanceKey": "20250714200130106_2025-10-01 00:00:00",
                    "InstanceState": "COMPLETED",
                    "InstanceType": 0,
                    "LastUpdateTime": "2025-08-27 20:24:44",
                    "OwnerUinList": [
                        "100039182306"
                    ],
                    "ProjectId": "1460947878944567296",
                    "SchedulerTime": "2025-09-30 22:00:00",
                    "StartTime": "2025-08-27 20:24:37",
                    "TaskId": "20250714200130106",
                    "TaskName": "u8c03u5ea6u53c2u6570u6d4bu8bd51",
                    "TaskType": "Shell",
                    "TaskTypeId": 35,
                    "TotalRunNum": 10,
                    "Tries": 1,
                    "TryLimit": 5,
                    "WorkflowId": "1f0911b9-032e-4e4f-a564-69e4b871d7e2",
                    "WorkflowName": "u8c03u5ea6u53c2u6570u6d4bu8bd5"
                }
            ],
            "PageNumber": 1,
            "PageSize": 1,
            "TotalCount": 176022,
            "TotalPageNumber": 176022
        },
        "RequestId": "93e9be2a-c5bb-4b2c-b04f-8ca64aa5a5c5"
    }
}

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.
InternalError Internal error.
InvalidParameter Parameter error.
MissingParameter Parameter missing.

도움말 및 지원

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

피드백