获取对账作业列表
功能介绍
获取对账作业列表。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/quality/consistency-tasks
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
category_id |
否 |
Long |
目录ID。 |
name |
否 |
String |
name。 |
schedule_status |
否 |
String |
调度状态:UNKNOWN表示未知,NOT_START表示未启动,SCHEDULING表示调度中,FINISH_SUCCESS表示正常结束,KILL表示手动停止,RUNNING_EXCEPTION表示运行失败。 |
start_time |
否 |
Long |
最近运行时间查询区间的开始时间,13位时间戳(精确到毫秒)。 |
end_time |
否 |
Long |
最近运行时间查询区间的结束时间,13位时间戳(精确到毫秒)。 |
creator |
否 |
String |
创建人。 |
limit |
否 |
Long |
分页条数,最大值为100。 |
offset |
否 |
Long |
分页偏移量,最小值0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
workspace |
是 |
String |
DataArts Studio工作空间ID,获取方法请参见实例ID和工作空间ID。 |
X-Auth-Token |
是 |
String |
IAM Token,Token获取请参见认证鉴权。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
count |
Long |
总条数。 |
resources |
Array of QualityTaskOverviewVO_2 objects |
分页数据。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Long |
对账作业ID。 |
name |
String |
对账作业名称。 |
category_id |
Long |
目录ID。 |
schedule_status |
String |
调度状态,UNKNOWN表示未知,NOT_START表示未启动,SCHEDULING表示调度中,FINISH_SUCCESS表示正常结束,KILL表示手动停止,RUNNING_EXCEPTION表示运行失败。 |
schedule_period |
String |
调度周期,MINUTE表示按分钟调度,HOUR表示按小时调度,DAY表示按天调度,WEEK表示按周调度。 |
schedule_interval |
String |
调度间隔,当调度周期为分钟、小时、天时,间隔时间为数字,而当调度周期为周时,调度间隔为星期的英文,如:每周一、周二调度时,schedule_interval为"MONDAY,TUESDAY"。 |
create_time |
Long |
创建时间,13位时间戳(精确到毫秒)。 |
last_run_time |
Long |
最新运行时间,13位时间戳(精确到毫秒)。 |
creator |
String |
创建者。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DQC.0000表示请求处理成功。 |
error_msg |
String |
错误信息。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DQC.0000表示请求处理成功。 |
error_msg |
String |
错误信息。 |
请求示例
无
响应示例
状态码: 200
Success 返回的是InstanceVO
{ "count" : 1, "resources" : [ { "id" : 1012386182149165000, "name" : "test", "category_id" : 0, "schedule_status" : "NOT_START", "schedule_period" : null, "schedule_interval" : null, "create_time" : 1661413275050, "last_run_time" : null, "creator" : "ei" } ] }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
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 ListConsistencyTaskSolution { 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("<YOUR REGION>")) .build(); ListConsistencyTaskRequest request = new ListConsistencyTaskRequest(); try { ListConsistencyTaskResponse response = client.listConsistencyTask(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()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# 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("<YOUR REGION>")) \ .build() try: request = ListConsistencyTaskRequest() response = client.list_consistency_task(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dataartsstudio.NewDataArtsStudioClient( dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListConsistencyTaskRequest{} response, err := client.ListConsistencyTask(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Success 返回的是InstanceVO |
400 |
BadRequest |
500 |
INTERNAL SERVER ERROR |