# 获取数据作业列表 - ListDataJob #### 功能介绍 获取数据作业列表。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0100.html)。 #### URI GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/data-jobs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | eihealth_project_id | 是 | String | **参数解释**： 空间ID，您可以从[获取空间ID](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0099.html)中获取。 **约束限制**： 不涉及 **取值范围**： 仅支持中英文字符串、中划线和下划线，长度为\[1-128\]个字符。 **默认取值**： 不涉及 | | project_id | 是 | String | **参数解释**： 项目ID，您可以从[获取项目ID](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0033.html)中获取。 **约束限制**： 不涉及 **取值范围**： 仅支持中英文字符串、中划线和下划线，长度为\[1-128\]个字符。 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | creator | 否 | String | **参数解释**： 创建者名称。 **约束限制**： 不涉及 **取值范围**： 长度为\[1-128\]个字符。 **默认取值**： 不涉及 | | from_time | 否 | Long | **参数解释**： 查询该时间之后创建的数据作业。 **约束限制**： 不涉及 **取值范围**： 时间戳，范围为\[1000000000000-9999999999999\]。 **默认取值**： 不涉及 | | limit | 否 | Integer | **参数解释**： 查询条数。 **约束限制**： 不涉及 **取值范围**： 整数，范围为\[1-1000\]。 **默认取值**： 100 | | name | 否 | String | **参数解释**： 数据作业名称。 **约束限制**： 不涉及 **取值范围**： 长度为\[1-128\]个字符。 **默认取值**： 不涉及 | | offset | 否 | Integer | **参数解释**： 查询偏移量。 **约束限制**： 不涉及 **取值范围**： 整数，范围为\[0-100000000\]。 **默认取值**： 0 | | status | 否 | String | **参数解释**： 数据作业状态。 **约束限制**： 不涉及 **取值范围**： - PENDING：等待中 - RUNNING：运行中 - CANCELED：已取消 - SUCCEED：成功 - FAILED：失败 - DELETING：删除中 - DELETE_CANCELED：删除已取消 - DELETE_FAILED：删除失败 **默认取值**： 不涉及 | | to_time | 否 | Long | **参数解释**： 查询该时间之前创建的数据作业。 **约束限制**： 不涉及 **取值范围**： 时间戳，范围为\[1000000000000-9999999999999\]。 **默认取值**： 不涉及 | | type | 否 | String | **参数解释**： 数据作业类型。 **约束限制**： 不涉及 **取值范围**： - CLONE_DATA：复制数据 - DELETE_DATA：删除数据 - IMPORT_DATA：导入数据 - IMPORT_NETWORK_DATA：导入URL数据 **默认取值**： 不涉及 | | finish_from_time | 否 | Long | **参数解释**： 查询该时间之后完成的数据作业。 **约束限制**： 不涉及 **取值范围**： 时间戳，范围为\[1000000000000-9999999999999\]。 **默认取值**： 不涉及 | | finish_to_time | 否 | Long | **参数解释**： 查询该时间之前完成的数据作业。 **约束限制**： 不涉及 **取值范围**： 时间戳，范围为\[1000000000000-9999999999999\]。 **默认取值**： 不涉及 | | sort_dir | 否 | String | **参数解释**： 排序规则。 **约束限制**： 不涉及 **取值范围**： - asc：升序 - desc：降序 **默认取值**： desc | | sort_key | 否 | String | **参数解释**： 排序规则，目前默认时间降序，支持根据status，name，type，creator，create_time，end_time。 **约束限制**： 不涉及 **取值范围**： - status：状态 - name：作业名称 - type：作业类型 - creator：创建者 - create_time：创建时间 - end_time：结束时间 **默认取值**： 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，[获取Token](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0011.html)接口响应消息头中X-Subject-Token的值即为Token。 **约束限制**： 不涉及 **取值范围**： 长度为\[1-32768\]个字符。 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | **参数解释**： 总条数。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | data_jobs | Array of [DataJobRsp] objects | **参数解释**： 数据作业列表。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表5DataJobRsp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | creator | String | **参数解释**： 数据作业创建者。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | end_time | String | **参数解释**： 数据作业结束时间。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | id | String | **参数解释**： 数据作业ID。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | name | String | **参数解释**： 数据作业名称。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | create_time | String | **参数解释**： 数据作业创建时间。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | status | String | **参数解释**： 数据作业状态。 **约束限制**： 不涉及 **取值范围**： - PENDING：等待中 - RUNNING：运行中 - CANCELED：已取消 - SUCCEED：成功 - FAILED：失败 - DELETING：删除中 - DELETE_CANCELED：删除已取消 - DELETE_FAILED：删除失败 **默认取值**： 不涉及 | | finish_count | Integer | **参数解释**： 数据作业完成数。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | total_count | Integer | **参数解释**： 数据作业总数。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | type | String | **参数解释**： 数据作业类型。 **约束限制**： 不涉及 **取值范围**： - CLONE_DATA：复制数据 - DELETE_DATA：删除数据 - IMPORT_DATA：导入数据 - IMPORT_NETWORK_DATA：导入URL数据 **默认取值**： 不涉及 | | failed_reason | String | **参数解释**： 数据作业失败原因。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | additions | String | **参数解释**： 附加信息。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 请求示例 获取数据作业列表。 ``` https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/data-jobs ``` #### 响应示例 **状态码：200** OK ``` { "count" : 30, "data_jobs" : [ { "creator" : "creator", "end_time" : "2021-04-21T09:30:37Z", "id" : "94116a6b-1945-4581-b64c-2cea712988ab", "name" : "DataDelete-20210421093037", "create_time" : "2021-04-21T09:30:37Z", "status" : "SUCCEED", "finish_count" : 4, "total_count" : 10, "type" : "DELETE_DATA" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ai4sservice/ErrorCode.html)。