获取质量作业列表V1
功能介绍
批量查询数据质量作业,返回质量作业列表。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/quality/rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
start |
否 |
Long |
开始查询页数,用于计算分页查询偏移量,如果参数offset和limit均不为空则以offset值为准。 |
page_size |
否 |
Long |
每页显示条目数量,如果参数offset和limit均不为空则以limit值为准。 |
offset |
否 |
Integer |
分页查询偏移量。 |
limit |
否 |
Integer |
每页显示的条目数量。 |
category_id |
否 |
Long |
目录ID。 |
rule_name |
否 |
String |
质量作业名称。 |
schedule_status |
否 |
Integer |
调度状态,1表示未启动,2表示调度中,3表示正常结束,4表示手动停止,5表示调度异常。 |
schedule_period |
否 |
Integer |
调度周期,1表示分钟,2表示小时,3表示天,4表示周,5表示月。 |
start_time |
否 |
String |
开始时间(搜索),格式 yyyy-MM-dd HH:mm:ss。 |
end_time |
否 |
String |
结束时间(搜索),格式 yyyy-MM-dd HH:mm:ss。 |
result_status |
否 |
Integer |
最近运行结果,0表示运行中,1表示异常,2表示告警,3表示正常。 |
sort |
否 |
String |
排序字段。 |
order |
否 |
String |
排序方式。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DQC.0000表示请求处理成功。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DQC.0000表示请求处理成功。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DQC.0000表示请求处理成功。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DQC.0000表示请求处理成功。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
请求示例
无
响应示例
状态码: 200
Success,返回的data数据。
{ "data" : { "num" : 100, "page_search_result" : [ { "id" : "1042745498940891137", "name" : "rule-name", "creator" : "test-user", "create_offset_time" : "2022-11-17T10:23:12+08:00", "modify_offset_time" : "2022-11-17T10:23:46+08:00", "dw_name" : "", "db_name" : "", "schedule_status" : 1, "calc_offset_time" : "2022-11-17T10:51:59+08:00" } ] } }
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 ListQualityTaskListsSolution { 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(); ListQualityTaskListsRequest request = new ListQualityTaskListsRequest(); try { ListQualityTaskListsResponse response = client.listQualityTaskLists(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 = ListQualityTaskListsRequest() response = client.list_quality_task_lists(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.ListQualityTaskListsRequest{} response, err := client.ListQualityTaskLists(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Success,返回的data数据。 |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |