ListOpsWorkflows

Last updated:2025-11-13 20:54:30

ListOpsWorkflows

Last updated: 2025-11-13 20:54:30

1. API Description

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

Get Workflows under a Project by Project ID.

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: ListOpsWorkflows.
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.
PageNumber	No	Integer	Page number
PageSize	No	Integer	Pagination size.
FolderId	No	String	Folder ID
Status	No	String	Workflow Status Filter * ALL_RUNNING: All workflows are running (scheduled) * ALL_FREEZED: All workflows are paused * ALL_STOPPED: All workflows are offline * PART_RUNNING: Some workflows are running (partially scheduled) * ALL_NO_RUNNING: No workflows are running (unscheduled) * ALL_INVALID: All workflows are invalid
OwnerUin	No	String	Owner ID
WorkflowType	No	String	Workflow type filter criteria. supported values: Cycle or Manual. default: Cycle.
KeyWord	No	String	Workflow keyword-based filtering supports fuzzy matching of workflow Id/name.
SortItem	No	String	Sort item. Options: CreateTime, TaskCount.
SortType	No	String	Sorting method, DESC or ASC, uppercase.
CreateUserUin	No	String	CreatorId. specifies the id of the creator.
ModifyTime	No	String	Update time. format: yyyy-MM-dd HH:MM:ss.
CreateTime	No	String	Creation time. format: yyyy-MM-dd HH:MM:ss.

3. Output Parameters

Parameter Name	Type	Description
Data	OpsWorkflows	Workflow list
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 Workflow List

Input Example

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

{
    "ProjectId": "2428908825624145920"
}

Output Example

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "CreateTime": "2025-09-01 14:24:26",
                    "FolderId": "e96fc104-c531-11ef-8c70-043f72d4907c",
                    "FolderName": "carlshi",
                    "OwnerUin": ";100028596846;",
                    "ProjectId": "2428908825624145920",
                    "ProjectName": "project_wedata_1u62e8u6d4bu4e13u7528",
                    "Status": "ALL_RUNNING",
                    "TaskCount": 4,
                    "UpdateTime": "2025-09-01 14:24:26",
                    "UpdateUserUin": "100028596846",
                    "WorkflowDesc": "",
                    "WorkflowId": "44083d5c-7448-414b-a8c7-0427bd9ee75a",
                    "WorkflowName": "makeuporder",
                    "WorkflowType": "cycle"
                }
            ],
            "PageNumber": 1,
            "PageSize": 10,
            "TotalCount": 540,
            "TotalPageNumber": 54
        },
        "RequestId": "8d95e83b-4fef-454d-a0bf-13b8e2c23177"
    }
}

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

Tencent Cloud CLI 3.0

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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud