Tencent Cloud

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

DescribeOpsWorkflows

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

Download PDF

1. API Description

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

Querying User Production Workflow List

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: DescribeOpsWorkflows.
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.
ProjectId	Yes	String	Project ID
ProductNameList	No	String	Task Product Type Name List, separated by ','
FolderIdList	No	String	File ID list, separated by ','
WorkFlowIdList	No	String	Workflow ID, separated by ','
WorkFlowNameList	No	String	Workflow Name List, separated by ','
TaskNameList	No	String	Task Name List, separated by ','
TaskIdList	No	String	Task ID list, separated by ','
StatusList	No	String	Status List, separated by ','
InChargeList	No	String	Person in Charge List, separated by ','
PageNumber	No	Integer	Page number
PageSize	No	Integer	Page size
SortItem	No	String	Sorting Item
SortType	No	String	Sort Method, DESC or ASC

3. Output Parameters

Parameter Name	Type	Description
Data	WorkflowExtOpsDtoPage	Workflow ListNote: This field may return null, indicating that no valid value can be obtained.
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 Querying User Production Workflow List

Querying User Production Workflow List

Input Example

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

{
    "ProjectId": "1531609696090365852",
    "PageNumber": 1,
    "PageSize": 10
}

Output Example

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "CreateTime": "2024-03-13 20:07:03",
                    "FolderId": "14ac5d0f-e132-11ee-8d13-a4ae120f8272",
                    "FolderName": "0sasha",
                    "ModifyTime": "2024-03-13 20:07:03",
                    "Owner": ";AUTO_TEST;",
                    "OwnerId": ";100029411056;",
                    "ProjectId": "1531609696090365952",
                    "ProjectIdent": null,
                    "ProjectName": "project_wedata",
                    "Status": "ALL_RUNNING",
                    "TaskCount": 3,
                    "WorkFlowDesc": "",
                    "WorkFlowId": "1a791878-e132-11ee-8d13-a4ae120f8272",
                    "WorkFlowName": "saflow"
                }
            ],
            "TotalCount": 1
        },
        "RequestId": "80f565cd-e63a-427a-98e5-c729d7e0e3f2"
    }
}

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 Failure.

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support

tencent cloud

Recent Pages

DescribeOpsWorkflows

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying User Production Workflow List

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

DescribeOpsWorkflows

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying User Production Workflow List

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?