查询流程作业状态

最近更新时间:2024-03-12 01:30:08

我的收藏

1. 接口描述

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

查询流程任务

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeJobFlow。
Version String 公共参数,本接口取值:2019-01-03。
Region String 公共参数,详见产品支持的 地域列表
JobFlowId Integer 流程任务Id,RunJobFlow接口返回的值。
示例值:1

3. 输出参数

参数名称 类型 描述
State String 流程任务状态,可以为以下值:
JobFlowInit,流程任务初始化。
JobFlowResourceApplied,资源申请中,通常为JobFlow需要新建集群时的状态。
JobFlowResourceReady,执行流程任务的资源就绪。
JobFlowStepsRunning,流程任务步骤已提交。
JobFlowStepsComplete,流程任务步骤已完成。
JobFlowTerminating,流程任务所需资源销毁中。
JobFlowFinish,流程任务已完成。
示例值:JobFlowFinish
Details Array of JobResult 流程任务步骤结果。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询任务流程

输入示例

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

{
    "JobFlowId": "1"
}

输出示例

{
    "Response": {
        "State": "JobFlowFinish",
        "Details": [],
        "RequestId": "5a96d30f-a251-42a0-82e2-f85325f5b89b"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.WoodServerError 内部服务调用异常。
InvalidParameter.InvalidJobFlow 无效的流程任务。
ResourceNotFound.ClusterNotFound 无法找到该实例。