DescribeClusterFlowStatusDetail

Last updated: 2025-11-13 20:49:08

DescribeClusterFlowStatusDetail

Last updated: 2025-11-13 20:49:08

1. API Description

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

This API is used to query the EMR task running details status.

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: DescribeClusterFlowStatusDetail.
Version	Yes	String	Common Params. The value used for this API: 2019-01-03.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	EMR instance ID
FlowParam	Yes	FlowParam	Process-related parameters.
NeedExtraDetail	No	Boolean	Whether to return additional task information. The default value is false.

3. Output Parameters

Parameter Name	Type	Description
StageDetails	Array of StageInfoDetail	Task step details Note: This field may return null, indicating that no valid values can be obtained.
FlowDesc	Array of FlowParamsDesc	Task parameters. Note: This field may return null, indicating that no valid values can be obtained.
FlowName	String	Task name.
FlowTotalProgress	Float	Overall task flow progress. Example: 0.8.
FlowTotalStatus	Integer	Overall process status definition. 0: initializing. 1: running. 2: completed. 3: completed (with skipped steps). -1: failed. -3: blocked.
FlowExtraDetail	Array of FlowExtraDetail	Additional process information. This parameter is returned when NeedExtraDetail is true. Note: This field may return null, indicating that no valid values can be obtained.
FlowInfo	String	Flow description.
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 EMR Task Running Detail Status

Input Example

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

{
    "InstanceId": "emr-123",
    "FlowParam": {
        "FKey": "TraceId",
        "FValue": "1730204629-375383-1016312"
    },
    "NeedExtraDetail": true
}

Output Example

{
    "Response": {
        "FlowDesc": [
            {
                "PKey": "CoreSize",
                "PValue": "1"
            },
            {
                "PKey": "DeployProcess",
                "PValue": "DataNode,NodeManager,Filebeat"
            },
            {
                "PKey": "Node Type",
                "PValue": "Core"
            }
        ],
        "FlowExtraDetail": null,
        "FlowName": "Scale Out Core",
        "FlowTotalProgress": 0.38,
        "FlowTotalStatus": 1,
        "RequestId": "d9ad966c-9db0-409f-a2da-4c23350772d3",
        "StageDetails": [
            {
                "Desc": "Completed",
                "Endtime": "2024-10-29 20:24:41",
                "FailedReason": "",
                "HadWoodDetail": false,
                "IsShow": true,
                "IsSubFlow": false,
                "LanguageKey": "lookupResources",
                "Name": "Create Order",
                "Progress": 0,
                "Stage": "lookupResources",
                "Starttime": "2024-10-29 20:24:01",
                "Status": 2,
                "SubFlowFlag": "",
                "TimeConsuming": "takes 40s",
                "WoodJobId": 0
            },
            {
                "Desc": "Completed",
                "Endtime": "2024-10-29 20:24:43",
                "FailedReason": "",
                "HadWoodDetail": false,
                "IsShow": true,
                "IsSubFlow": false,
                "LanguageKey": "applyCvm",
                "Name": "Apply For Resource",
                "Progress": 0,
                "Stage": "applyCvm",
                "Starttime": "2024-10-29 20:24:41",
                "Status": 2,
                "SubFlowFlag": "",
                "TimeConsuming": "takes 2s",
                "WoodJobId": 0
            },
            {
                "Desc": "Completed",
                "Endtime": "2024-10-29 20:24:44",
                "FailedReason": "",
                "HadWoodDetail": false,
                "IsShow": true,
                "IsSubFlow": false,
                "LanguageKey": "bindTags",
                "Name": "Bind tag",
                "Progress": 0,
                "Stage": "bindTags",
                "Starttime": "2024-10-29 20:24:44",
                "Status": 2,
                "SubFlowFlag": "",
                "TimeConsuming": "takes 0s",
                "WoodJobId": 0
            },
            {
                "Desc": "Not started",
                "Endtime": "0000-00-00 00:00:00",
                "FailedReason": "",
                "HadWoodDetail": false,
                "IsShow": true,
                "IsSubFlow": false,
                "LanguageKey": "createSecurityGroup",
                "Name": "Initialize security group",
                "Progress": 0,
                "Stage": "createSecurityGroup",
                "Starttime": "0000-00-00 00:00:00",
                "Status": 4,
                "SubFlowFlag": "",
                "TimeConsuming": "",
                "WoodJobId": 0
            },
            {
                "Desc": "Not started",
                "Endtime": "0000-00-00 00:00:00",
                "FailedReason": "",
                "HadWoodDetail": false,
                "IsShow": true,
                "IsSubFlow": false,
                "LanguageKey": "addCVMAndCDBToWoodpecker",
                "Name": "Initialize resource",
                "Progress": 0,
                "Stage": "addCVMAndCDBToWoodpecker",
                "Starttime": "0000-00-00 00:00:00",
                "Status": 4,
                "SubFlowFlag": "",
                "TimeConsuming": "",
                "WoodJobId": 0
            },
            {
                "Desc": "Not started",
                "Endtime": "0000-00-00 00:00:00",
                "FailedReason": "",
                "HadWoodDetail": false,
                "IsShow": true,
                "IsSubFlow": false,
                "LanguageKey": "woodpeckerScaleoutCluster",
                "Name": "Prepare for scale-out",
                "Progress": 0,
                "Stage": "woodpeckerScaleoutCluster",
                "Starttime": "0000-00-00 00:00:00",
                "Status": 4,
                "SubFlowFlag": "",
                "TimeConsuming": "",
                "WoodJobId": 0
            },
            {
                "Desc": "Not started",
                "Endtime": "0000-00-00 00:00:00",
                "FailedReason": "",
                "HadWoodDetail": true,
                "IsShow": true,
                "IsSubFlow": true,
                "LanguageKey": "initializeService",
                "Name": "Initialize service",
                "Progress": 0,
                "Stage": "queryWoodpeckerFlow",
                "Starttime": "0000-00-00 00:00:00",
                "Status": 4,
                "SubFlowFlag": "",
                "TimeConsuming": "",
                "WoodJobId": 0
            },
            {
                "Desc": "Not started",
                "Endtime": "0000-00-00 00:00:00",
                "FailedReason": "",
                "HadWoodDetail": false,
                "IsShow": true,
                "IsSubFlow": false,
                "LanguageKey": "endPoint",
                "Name": "End task",
                "Progress": 0,
                "Stage": "endPoint",
                "Starttime": "0000-00-00 00:00:00",
                "Status": 4,
                "SubFlowFlag": "",
                "TimeConsuming": "",
                "WoodJobId": 0
            }
        ]
    }
}

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.
InternalError.CamCgwError	An error occurred while calling another service API.
InternalError.WoodServerError	An error occurred while calling another service API.
InvalidParameter.InvalidAppId	Invalid `AppId`.
InvalidParameter.InvalidInstanceName	Invalid cluster name.
ResourceNotFound.ClusterNotFound	The instance was not found.
ResourceNotFound.InstanceNotFound	The instance was not found.
UnauthorizedOperation.CheckCamAuth	Unauthorized operation.

Was this page helpful?

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

Yes

Feedback

tencent cloud