弹性 MapReduce 查询EMR集群任务运行详情状态-信息查询相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： emr.tencentcloudapi.com 。

查询EMR任务运行详情状态

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeClusterFlowStatusDetail。
Version	是	String	公共参数，本接口取值：2019-01-03。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	EMR实例ID 示例值：emr-examples
FlowParam	是	FlowParam	流程相关参数
NeedExtraDetail	否	Boolean	是否返回任务额外信息默认: false 示例值：false

3. 输出参数

参数名称	类型	描述
StageDetails	Array of StageInfoDetail	任务步骤详情注意：此字段可能返回 null，表示取不到有效值。
FlowDesc	Array of FlowParamsDesc	任务参数注意：此字段可能返回 null，表示取不到有效值。
FlowName	String	任务名称注意：此字段可能返回 null，表示取不到有效值。
FlowTotalProgress	Float	总任务流程进度：例如：0.8 注意：此字段可能返回 null，表示取不到有效值。
FlowTotalStatus	Integer	定义流程总状态： 0:初始化， 1:运行中， 2:完成， 3:完成（存在跳过步骤）， -1:失败， -3:阻塞，注意：此字段可能返回 null，表示取不到有效值。
FlowExtraDetail	Array of FlowExtraDetail	流程额外信息 NeedExtraDetail为true时返回注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询EMR任务运行详情状态

输入示例

POST / HTTP/1.1
Host: emr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterFlowStatusDetail
<公共请求参数>

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

输出示例

{
    "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": "已完成",
                "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": "已完成",
                "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": "已完成",
                "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": "未启动",
                "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": "未启动",
                "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": "未启动",
                "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": "未启动",
                "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": "未启动",
                "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
InternalError.CamCgwError	内部服务调用异常。
InternalError.WoodServerError	内部服务调用异常。
InvalidParameter.InvalidAppId	无效参数，AppId。
InvalidParameter.InvalidInstanceName	无效的集群名称。
ResourceNotFound.ClusterNotFound	无法找到该实例。
ResourceNotFound.InstanceNotFound	无法找到该实例。
UnauthorizedOperation.CheckCamAuth	校验账号操作无权限。