Obtaining the Quality Job List
Function
This API is used to obtain the list of quality jobs.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/quality/quality-tasks
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain it, see Project ID and Account ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
category_id |
No |
Long |
Directory ID |
name |
No |
String |
Quality job name |
schedule_status |
No |
String |
Scheduling status, which can be UNKNOWN (the scheduling status is unknown), NOT_START (scheduling has not started), SCHEDULING (the scheduling is in progress), FINISH_SUCCESS (the scheduling is completed properly), KILL (the scheduling is manually stopped), or RUNNING_EXCEPTION (the scheduling fails). |
start_time |
No |
Long |
Start time of the last query period. The value is a 13-digit timestamp accurate to millisecond. |
end_time |
No |
Long |
End time of the last query period. The value is a 13-digit timestamp accurate to millisecond. |
creator |
No |
String |
Creator |
limit |
No |
Long |
Number of records displayed on each page. The maximum value is 100. |
offset |
No |
Long |
Pagination offset. The minimum value is 0. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
workspace |
Yes |
String |
DataArts Studio workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID. |
X-Auth-Token |
Yes |
String |
IAM token. For details about how to obtain the token, see Authentication. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
count |
Long |
Total number of records |
resources |
Array of QualityTaskOverviewVO objects |
Pagination data |
Parameter |
Type |
Description |
---|---|---|
id |
Long |
Quality job ID |
name |
String |
Quality job name |
category_id |
Long |
Directory ID |
schedule_status |
String |
Scheduling status, which can be UNKNOWN (the scheduling status is unknown), NOT_START (scheduling has not started), SCHEDULING (the scheduling is in progress), FINISH_SUCCESS (the scheduling is completed properly), KILL (the scheduling is manually stopped), or RUNNING_EXCEPTION (the scheduling fails). |
schedule_period |
String |
Scheduling period. The value can be MINUTE, HOUR, DAY, or WEEK. |
schedule_interval |
String |
Scheduling interval. When the scheduling period is minute, hour, or day, the scheduling interval is a number. When the scheduling period is week, the scheduling interval is days in a week, for example, MONDAY,TUESDAY. |
create_time |
Long |
Creation time. The value is a 13-digit timestamp accurate to millisecond. |
last_run_time |
Long |
Last execution time. The value is a 13-digit timestamp accurate to millisecond. |
creator |
String |
Creator |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, for example, DQC.0000 which indicates that the request was successfully processed |
error_msg |
String |
Error message |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, for example, DQC.0000 which indicates that the request was successfully processed |
error_msg |
String |
Error message |
Example Requests
None
Example Responses
Status code: 200
The API call is successful. InstanceVO is returned.
{ "count" : 1, "resources" : [ { "id" : 1012385458115825700, "name" : "test", "category_id" : 1012384968858652700, "schedule_status" : "NOT_START", "schedule_period" : null, "schedule_interval" : null, "create_time" : 1661413102000, "last_run_time" : 1661413281000, "creator" : "ei" } ] }
SDK Sample Code
The SDK sample code is as follows.
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 ListQualityTaskSolution { 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(); ListQualityTaskRequest request = new ListQualityTaskRequest(); try { ListQualityTaskResponse response = client.listQualityTask(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 = ListQualityTaskRequest() response = client.list_quality_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.ListQualityTaskRequest{} response, err := client.ListQualityTask(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
The API call is successful. InstanceVO is returned. |
400 |
BadRequest |
500 |
INTERNAL SERVER ERROR |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot