# 查询任务完成情况 - ListFactoryTaskCompletion #### 功能介绍 查询任务完成情况。包括今天，昨天以及近7天的平均任务完成情况。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsStudio/doc?api=ListFactoryTaskCompletion)中调试该接口，支持自动认证鉴权。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI - URI格式 GET /v2/{project_id}/factory/monitor/task-completion-data - 参数说明 表1URI参数说明 | 参数名 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | 项目编号，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 否 | String | 查询任务的类型，默认为all，查询所有任务。类型如下：Dummy、CDM Job、MRS Hive SQL、MRS Spark SQL、DLI SQL、DLI Spark、Python、DWS SQL、Shell等作业算子。 说明： 此处只是列举一些算子，以实际为准。 该接口只统计运行成功的实例，每小时统计一次，任务表示作业中的算子。 | | start_day | 否 | String | 要获取任务完成情况的日期，默认为今天。格式为yyyy-MM-dd | | start_time | 否 | Integer | 要获取任务完成情况的开始时间点，以该时间点为日期分割时间点，默认为0点。格式为整点时间，取值范围为0-23。 说明： 例如设置为start_day=2025-01-18\&start_time=10 则对应返回内容为： 2025-01-18 10点后一天【2025-01-18 10:00:00 \~ 2025-01-19 09:59:59】 前一天【2025-01-17 10:00:00 \~ 2025-01-18 09:59:59】 以及前七天平均值【2025-01-11 10:00:00 \~ 2025-01-18 09:59:59】的任务完成状态。 | #### 请求参数 表3请求Header参数 | 参数名 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | workspace | 否 | String | 工作空间id。获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 - 如果不设置该参数，默认查询default工作空间下的数据。 - 如果需要查询其他工作空间的数据，需要带上该消息头。 说明： - 多个DataArts Studio实例需要指定工作空间。 - 当工作空间里面没有default工作空间时，工作空间为必填参数，否则会报错。 | | X-Auth-Token | 否 | String | IAM Token 最小长度：**0** 最大长度：**4096** | #### 响应参数 表4响应参数说明 | 参数名 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | yesterday | 否 | array\[object\] | 昨天的任务信息，请参考[task_record结构体]。 | | average | 否 | array\[object\] | 近7天的平均任务信息，请参考[task_record结构体]。 | | today | 否 | array\[object\] | 今天的任务信息，请参考[task_record结构体]。 | 表5task_record参数说明 | 参数名 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | record_time | 否 | Long | 整时的时间点，13位时间戳。 | | task_completion_num | 否 | Long | 当前时间点完成的任务数量。 | #### 请求示例 ``` GET /v2/b384b9e9ab9b4ee8994c8633aabc9505/factory/monitor/task-completion-data?type=all ``` #### 响应示例 - 成功响应 HTTP状态码 200 ``` { "yesterday": [ { "record_time": 1704124800000, "task_completion_num": 0 }, { "record_time": 1704128400000, "task_completion_num": 0 }, { "record_time": 1704132000000, "task_completion_num": 0 } ], "average": [ { "record_time": 1704124800000, "task_completion_num": 0 }, { "record_time": 1704128400000, "task_completion_num": 0 }, { "record_time": 1704132000000, "task_completion_num": 0 } ], "today": [ { "record_time": 1704124800000, "task_completion_num": 0 }, { "record_time": 1704128400000, "task_completion_num": 0 }, { "record_time": 1704132000000, "task_completion_num": 0 } ] } ``` - 失败响应 HTTP状态码 400 ``` { "error_code": "DLF.3051", "error_msg": "The request parameter is invalid. " } ```