tencent cloud

APIs

StopWorkflowRunList

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-11-05 11:19:26

1. API Description

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

Batch stop running workflow instances.

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

Application ID.

WorkflowRunIdList.N Yes Array of String

Workflow running instance ID list

3. Output Parameters

Parameter Name Type Description
SuccessIdList Array of String

List of instance IDs stopped successfully

FailedIdList Array of String

List of instance IDs that failed to stop

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 Batch stop workflow running instances

Batch stop workflow running instances

Input Example

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

{
    "AppId": "2075134221221714816",
    "WorkflowRunIdList": [
        "wfr-cd6a2j03k5j4"
    ]
}

Output Example

{
    "Response": {
        "FailedIdList": [],
        "SuccessIdList": [
            "wfr-cd6a2j03k5j4"
        ],
        "RequestId": "c126301e-91a7-433c-9b21-a543a03c513f"
    }
}

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.
MissingParameter Parameters are missing.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan