# 查询采集任务列表 - ShowTaskList #### 功能介绍 查询采集任务列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dataartsstudio/making_request.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v3/{project_id}/metadata/tasks/search 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token，使用[Token认证](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0010.html)时必选。通过调用IAM服务的"获取用户Token"接口获取响应消息头中X-Subject-Token的值。 | | workspace | 是 | String | 工作空间ID，获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | user_name | 否 | String | 创建人。 | | name | 否 | String | 任务名。 | | data_source_type | 否 | String | 数据源类型。 | | data_connection_id | 否 | String | 数据连接id。 | | start_time | 否 | String | 开始时间。 | | end_time | 否 | String | 结束时间。 | | directory_id | 否 | String | 目录id。 | | bucket_name | 否 | String | 桶名。 | | limit | 否 | Integer | 分页参数limit，默认值：10。 | | offset | 否 | Integer | 分页参数offset，默认值：0。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | 查询采集任务数量。 | | total_records | Integer | 同一projectId下已创建采集任务数量。 | | max_records | Integer | 同一projectId下允许创建采集任务数量。 | | resources | Array of [MetadataCollectionTask] objects | 采集任务列表。 | 表5MetadataCollectionTask | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 任务id。 | | name | String | 任务名称。 | | description | String | 任务描述。 | | user_id | String | 用户id。 | | create_time | String | 创建时间。 | | project_id | String | 产品id。 | | dir_id | String | 目录id。 | | schedule_config | [SchedulerInfo] object | 调度信息。 | | parameter_config | Array of [CustomMetadata] objects | 自定义元数据信息。 | | update_time | String | 修改时间。 | | user_name | String | 用户名。 | | path | String | 路径。 | | last_run_time | String | 最后一次执行时间。 | | start_time | String | 开始时间。 | | end_time | String | 结束时间。 | | next_run_time | String | 下一次执行时间。 | | duty_person | String | 责任人。 | | update_type | String | 修改类型。 | | data_source_type | String | 数据来源类型。 | | task_config | Object | 任务信息Map(String, Object)。key：属性名称，value：属性值。 | | data_source_workspace_id | String | 数据来源工作空间id。 | 表6SchedulerInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cron_expression | String | 表达式。 | | end_time | String | 结束时间。 | | max_time_out | Integer | 最大超时时间。 | | interval | String | 间隔。 | | schedule_type | String | 调度类型。 | | start_time | String | 开始时间。 | | job_id | Integer | 工作id。 | | enabled | Integer | 启用。 | 表7CustomMetadata | 参数 | 参数类型 | 描述 | |:---|:---|:---| | description | String | 描述。 | | type | String | 类型。 | | task_id | String | 任务id。 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：403** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码：404** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 ``` { "user_name" : "userName", "name" : null, "data_source_type" : null, "data_connection_id" : null, "start_time" : null, "end_time" : null, "directory_id" : "e4248d66-c376-4f1b-a576-e4d1c6838d83", "bucket_name" : null, "limit" : 10, "offset" : 1 } ``` #### 响应示例 **状态码：200** OK。 ``` { "count" : 1, "total_records" : 1, "max_records" : 100, "resources" : [ { "create_time" : "1663722819809", "data_source_type" : "HIVE", "data_source_workspace_id" : null, "description" : null, "dir_id" : "0", "duty_person" : "user_demo", "end_time" : "0", "id" : "8a948047835b945101835d9b90e1010f", "last_run_time" : "1663723446000", "name" : "hive921", "next_run_time" : "0", "parameter_config" : [ ], "path" : null, "project_id" : null, "schedule_config" : [ { "cron_expression" : null, "enabled" : 4, "end_time" : null, "interval" : null, "job_id" : 262070, "max_time_out" : 60, "schedule_type" : "RUN_ONCE", "start_time" : null } ], "start_time" : "0", "task_config" : [ ], "update_time" : "1663722819809", "update_type" : null, "user_id" : "0833a573fe80d5401f6dc010a775569a", "user_name" : "user_demo" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class ShowTaskListSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("")) .build(); ShowTaskListRequest request = new ShowTaskListRequest(); try { ShowTaskListResponse response = client.showTaskList(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("")) \ .build() try: request = ShowTaskListRequest() response = client.show_task_list(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dataartsstudio.NewDataArtsStudioClient(hcClient) request := &model.ShowTaskListRequest{} response, err := client.ShowTaskList(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsStudio/sdk?api=ShowTaskList)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK。 | | 400 | BadRequest。 | | 401 | Unauthorized。 | | 403 | Forbidden。 | | 404 | Not Found。 |