1. API Description

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

This API is used to get the list of workflow details by workflow 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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DescribeWorkflows.
VersionYesStringCommon Params. The value used for this API: 2019-06-12.
RegionNoStringCommon Params. This parameter is not required for this API.
WorkflowIds.NNoArray of IntegerWorkflow ID filter. Array length limit: 100.
StatusNoStringWorkflow status. Valid values:
  • Enabled: Enabled,
  • Disabled: Disabled.

  • If this parameter is left empty, the workflow status will not be distinguished.
    OffsetNoIntegerPaging offset. Default value: 0.
    LimitNoIntegerNumber of returned entries. Default value: 10. Maximum value: 100.

    3. Output Parameters

    Parameter NameTypeDescription
    TotalCountIntegerNumber of eligible entries.
    WorkflowInfoSetArray of WorkflowInfoWorkflow information array.
    RequestIdStringThe unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying a workflow

    This example shows you how to query the workflow whose ID is 78459.

    Input Example

    &<Common request parameters>

    Output Example

        "Response": {
            "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
            "TotalCount": 1,
            "WorkflowInfoSet": [
                    "WorkflowId": 78459,
                    "WorkflowName": "transcode-10",
                    "Status": "Enabled",
                    "Trigger": {
                        "Type": "CosFileUpload",
                        "CosFileUploadTrigger": {
                            "Bucket": "TopRankVideo-125xxx88",
                            "Region": "ap-chongqing",
                            "Dir": "/movie/201907/"
                    "OutputStorage": {
                        "Type": "COS",
                        "CosOutputStorage": {
                            "Bucket": "TopRankVideo-125xxx88",
                            "Region": "ap-chongqing"
                    "MediaProcessTask": {
                        "TranscodeTaskSet": [
                                "Definition": 10,
                                "WatermarkSet": []
                    "OutputDir": "/movie/201907/",
                    "AiContentReviewTask": null,
                    "AiRecognitionTask": null,
                    "AiAnalysisTask": null,
                    "TaskNotifyConfig": null,
                    "TaskPriority": 0,
                    "CreateTime": "2019-07-18T10:00:00Z",
                    "UpdateTime": "2019-07-18T11:00:03Z"

    5. Developer Resources


    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 CodeDescription
    FailedOperation.InvalidMpsUserOperation failed: unauthorized MPS user.
    InternalErrorInternal error.
    InvalidParameterValueIncorrect parameter value.