1. 接口描述
接口请求域名: tbdsnew.api3.fincloud.tencent.cn。
查询TBDS任务运行状态
默认接口请求频率限制:20次/秒。
接口更新时间:2025-09-10 18:01:29。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeFlowStatus |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-01-03 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | EMR实例ID。emr-all表示查询全部集群的任务列表 示例值: tbds-664nmwbe |
| Offset | 否 | 否 | Int64 | 页编号,默认值为0,表示第一页。 示例值: 0 |
| Limit | 否 | 否 | Int64 | 每页返回数量,默认值为10,最大值为200。 示例值: 10 |
| StartTime | 否 | 否 | Int64 | 起始时间,秒级单位的时间戳,不超过30天前。 示例值: 1746955285 |
| EndTime | 否 | 否 | Int64 | 终止时间,秒级单位的时间戳 示例值: 1748251285 |
| FlowStatusList | 否 | 否 | Array of Int64 | 流程状态筛选数组未提交 = 0提交= 1结束= 2失败= -1 示例值: [] |
| OrderKey | 否 | 否 | String | 排序key,当前仅支持AddTime,EndTime,默认为AddTime 示例值: |
| OrderType | 否 | 否 | String | 排序类型,当前仅支持desc,asc,默认为desc 示例值: |
| Filters | 否 | 否 | Array of Filters | 当InstanceId字段为“emr-all”时,支持的过滤字段:ClusterIdName表示集群id或名称;ClusterType表示集群类型,包括EMROnCVM和EMROnTKE;FlowName表示任务名称。 示例值:查看 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FlowList | Array of FlowStatus | 集群运行任务列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:查看 |
| TotalCnt | Int64 | 符合条件的流程总数。 示例值: 1 |
| FlowStatusList | Array of Int64 | 流程状态筛选数组 注意:此字段可能返回 null,表示取不到有效值。 示例值: 1 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InternalError.CamCgwError | 内部服务调用异常。 |
| InvalidParameter.InvalidInstanceName | 无效的集群名称。 |
| InvalidParameter.InvalidOrderKey | 错误信息:Invalid OrderKey。 |
| InternalError | 内部错误。 |
| FailedOperation | 操作失败。 |
| ResourceNotFound.InstanceNotFound | 无法找到该实例。 |
| InternalError.WoodServerError | 内部服务调用异常。 |
| ResourceNotFound.ClusterNotFound | 无法找到该实例。 |
| InvalidParameter.InvalidOrderType | 错误信息:Invalid OrderType。 |
5. 示例
示例1 查询EMR任务运行状态
输入示例
POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeFlowStatus
<公共请求参数>
{
"InstanceId": "tbds-664nmwbe",
"Offset": 0,
"Limit": 10,
"StartTime": 1746955285,
"EndTime": 1748251285,
"OrderKey": "",
"OrderType": "",
"FlowStatusList": []
}
输出示例
{
"Response": {
"FlowList": [
{
"Addtime": "2025-05-26 14:24:59",
"CanBeCancelled": false,
"ClusterName": "hadoop",
"ClusterType": "EMR on CVM",
"Endtime": "2025-05-26 14:26:08",
"FlowDesc": [
{
"PKey": "备注",
"PValue": "无相关备注"
},
{
"PKey": "应用范围",
"PValue": "ALL"
},
{
"PKey": "服务",
"PValue": "IMPALA"
}
],
"FlowId": 11869812,
"InstanceId": "tbds-664nmwbe",
"Processname": "下发配置 IMPALA",
"Progress": 1,
"StageDetails": [],
"Status": 2
},
{
"Addtime": "2025-05-26 14:11:52",
"CanBeCancelled": false,
"ClusterName": "hadoop",
"ClusterType": "EMR on CVM",
"Endtime": "2025-05-26 14:13:06",
"FlowDesc": [
{
"PKey": "备注",
"PValue": "无相关备注"
},
{
"PKey": "应用范围",
"PValue": "ALL"
},
{
"PKey": "服务",
"PValue": "IMPALA"
}
],
"FlowId": 11872965,
"InstanceId": "tbds-664nmwbe",
"Processname": "下发配置 IMPALA",
"Progress": 1,
"StageDetails": [],
"Status": 2
},
{
"Addtime": "2025-05-23 14:06:25",
"CanBeCancelled": false,
"ClusterName": "hadoop",
"ClusterType": "EMR on CVM",
"Endtime": "2025-05-23 14:06:38",
"FlowDesc": [
{
"PKey": "备注",
"PValue": "无相关备注"
},
{
"PKey": "应用范围",
"PValue": "ALL"
},
{
"PKey": "服务",
"PValue": "ZOOKEEPER"
}
],
"FlowId": 11869724,
"InstanceId": "tbds-664nmwbe",
"Processname": "下发配置 ZOOKEEPER",
"Progress": 1,
"StageDetails": [],
"Status": 2
},
{
"Addtime": "2025-05-23 12:45:50",
"CanBeCancelled": false,
"ClusterName": "hadoop",
"ClusterType": "EMR on CVM",
"Endtime": "2025-05-23 12:46:04",
"FlowDesc": [
{
"PKey": "备注",
"PValue": "无相关备注"
},
{
"PKey": "应用范围",
"PValue": "ALL"
},
{
"PKey": "服务",
"PValue": "ZOOKEEPER"
}
],
"FlowId": 11872823,
"InstanceId": "tbds-664nmwbe",
"Processname": "下发配置 ZOOKEEPER",
"Progress": 1,
"StageDetails": [],
"Status": 2
},
{
"Addtime": "2025-05-23 12:45:11",
"CanBeCancelled": false,
"ClusterName": "hadoop",
"ClusterType": "EMR on CVM",
"Endtime": "2025-05-23 12:45:26",
"FlowDesc": [
{
"PKey": "备注",
"PValue": "无相关备注"
},
{
"PKey": "应用范围",
"PValue": "ALL"
},
{
"PKey": "服务",
"PValue": "ZOOKEEPER"
}
],
"FlowId": 11869712,
"InstanceId": "tbds-664nmwbe",
"Processname": "重新下发 ZOOKEEPER配置",
"Progress": 1,
"StageDetails": [],
"Status": 2
},
{
"Addtime": "2025-05-23 11:37:12",
"CanBeCancelled": false,
"ClusterName": "hadoop",
"ClusterType": "EMR on CVM",
"Endtime": "2025-05-23 11:38:34",
"FlowDesc": [
{
"PKey": "服务信息",
"PValue": "hue-4.10.0"
}
],
"FlowId": 11869689,
"InstanceId": "tbds-664nmwbe",
"Processname": "新增服务",
"Progress": 1,
"StageDetails": [],
"Status": 2
},
{
"Addtime": "2025-05-23 11:33:59",
"CanBeCancelled": false,
"ClusterName": "hadoop",
"ClusterType": "EMR on CVM",
"Endtime": "2025-05-23 11:34:23",
"FlowDesc": [
{
"PKey": "服务信息",
"PValue": "hue-4.10.0"
}
],
"FlowId": 11869674,
"InstanceId": "tbds-664nmwbe",
"Processname": "卸载服务",
"Progress": 1,
"StageDetails": [],
"Status": 2
},
{
"Addtime": "2025-05-23 11:33:51",
"CanBeCancelled": false,
"ClusterName": "hadoop",
"ClusterType": "EMR on CVM",
"Endtime": "2025-05-23 11:34:05",
"FlowDesc": [
{
"PKey": "OpType",
"PValue": "StopService"
},
{
"PKey": "ScopeInfo",
"PValue": "{\"ServiceInfoList\":[{\"ServiceName\":\"HUE\"}]}"
},
{
"PKey": "StrategyConfig",
"PValue": "{\"RollingRestartSwitch\":0,\"BatchSize\":0,\"TimeWait\":0,\"StopPolicy\":\"\",\"DealOnFail\":0,\"RackAwarenessSwitch\":0}"
}
],
"FlowId": 11869663,
"InstanceId": "tbds-664nmwbe",
"Processname": "停止服务 HUE",
"Progress": 1,
"StageDetails": [],
"Status": 2
},
{
"Addtime": "2025-05-23 11:03:01",
"CanBeCancelled": false,
"ClusterName": "hadoop",
"ClusterType": "EMR on CVM",
"Endtime": "2025-05-23 11:03:18",
"FlowDesc": [
{
"PKey": "备注",
"PValue": "无相关备注"
},
{
"PKey": "应用范围",
"PValue": "ALL"
},
{
"PKey": "服务",
"PValue": "ZOOKEEPER"
}
],
"FlowId": 11869618,
"InstanceId": "tbds-664nmwbe",
"Processname": "下发配置 ZOOKEEPER",
"Progress": 1,
"StageDetails": [],
"Status": 2
},
{
"Addtime": "2025-05-22 19:55:57",
"CanBeCancelled": false,
"ClusterName": "hadoop",
"ClusterType": "EMR on CVM",
"Endtime": "2025-05-22 19:56:12",
"FlowDesc": [
{
"PKey": "ClusterId",
"PValue": "tbds-664nmwbe"
},
{
"PKey": "Enable",
"PValue": "true"
},
{
"PKey": "ImpalaResourcePools",
"PValue": ""
}
],
"FlowId": 11872678,
"InstanceId": "tbds-664nmwbe",
"Processname": "开启IMPALA动态资源池",
"Progress": 1,
"StageDetails": [],
"Status": 2
}
],
"FlowStatusList": [
0,
1,
2,
-1
],
"RequestId": "bd2b7683-3f1e-4e4b-a4e5-a08c533ac57e",
"TotalCnt": 451
}
}