Output Information (Invitational Test)
Function
This API is used to query the running instance information of the job operator related to a table. It is in invitational test and will be available for OBT in the future.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
GET /v1/{project_id}/datamap/node/{task_id}/instances
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain it, see Project ID and Account ID. |
| task_id | Yes | String | Job operator ID, that is, task_id in the response body of the API for associating a table with a job operator list. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| workspace_id | No | String | Space ID, which is workspace_id of the response body of the API for associating a table with a job operator list. |
| job_name | Yes | String | Job operator name, which is job_name in the response body of the API for associating a table with a job operator list. |
| start_time | Yes | Number | Start time of the search parameter time range, for example, 1705248000000. |
| end_time | Yes | Number | End time of the search parameter time range, for example, 1705311669796. |
| offset | Yes | Integer | Offset of the pagination parameter. |
| limit | Yes | Integer | Number of records on each page. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service. |
| instance | Yes | String | Instance ID. For details about how to obtain the instance ID, see Instance ID and Workspace ID. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| status_code | Integer | Response code. |
| body | String | Response body. |
| header_map | Object | Response header information. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Status code: 404
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Example Requests
None
Example Responses
Status code: 200
OK.
{
"status_code" : 200,
"body" : "{\n\t \"msg\":\"success\",\n\t \"rows\":[\n\t\t {\n\t\t\t \"endTime\":0,\n\t\t\t \"executionLogPath\":\"obs://dlf-log-0833a5737480d53b2f25c010dc1a7b88/b88c445407b24283aa949f9833a38fd8/etl-dli2dws/2024-01-11_09_01_39.684/ETL_Job_dli2dws/ETL_Job_dli2dws.job\",\n\t\t\t \"failCount\":-1,\n\t\t\t \"forceSuccess\":0,\n\t\t\t \"inputRowCount\":-1,\n\t\t\t \"jobId\":1,\n\t\t\t \"jobName\":\"ETL_Job_dli2dws\",\n\t\t\t \"outputRowCount\":-1,\n\t\t\t \"owner\":\"username\",\n\t\t\t \"planTime\":1704934907000,\n\t\t\t \"retryTimes\":0,\n\t\t\t \"runningData\":\"{\\\"obsDataPath\\\":\\\"obs://dlf-log-0833a5737480d53b2f25c010dc1a7b88/1e490376-4778-3a55-a2f5-76b4ac707a87/20240111090152_YqBe/obsData/\\\",\\\"jobId\\\":\\\"ca7ec295-0fe7-4fe9-bb2e-30f946334b28\\\",\\\"dliCurrentStep\\\":\\\"1\\\",\\\"firstTimeEtlSqlList\\\":\\\"Create table if NOT EXISTS wk.wk_shuju_temp_20240111090152_RVo0 (\\\\n num int,\\\\n sno string,\\\\n name string\\\\n) using csv options(\\\\n path 'obs://dlf-log-0833a5737480d53b2f25c010dc1a7b88/1e490376-4778-3a55-a2f5-76b4ac707a87/20240111090152_YqBe/obsData/',mode 'DROPMALFORMED'\\\\n);\\\\nINSERT into TABLE wk.wk_shuju_temp_20240111090152_RVo0\\\\n select\\\\n num,\\\\n sno,\\\\n name\\\\n from wk.wk_shuju ;\\\\ndrop table if exists wk.wk_shuju_temp_20240111090152_RVo0;\\\",\\\"type\\\":\\\"DLI\\\"}\",\n\t\t\t \"runningParam\":\"{\\\"total\\\":1,\\\"rows\\\":[{\\\"name\\\":\\\"running parameter\\\",\\\"value\\\":\\\"com.hwclouds.dataide.lts.plugins.hwclouds.etl.ETLJobRunner;dps;dps\\\"}]}\",\n\t\t\t \"runningTime\":0,\n\t\t\t \"speed\":0.0,\n\t\t\t \"startTime\":1704934916000,\n\t\t\t \"status\":\"running\",\n\t\t\t \"submitTime\":1704934907691,\n\t\t\t \"taskId\":937987,\n\t\t\t \"taskName\":\"etl-dli2dws\",\n\t\t\t \"taskRunningLogId\":126074594,\n\t\t\t \"type\":\"ETLJob\",\n\t\t\t \"workspaceId\":\"b88c445407b24283aa949f9833a38fd8\",\n\t\t\t \"workspaceName\":\"kw_test\"\n\t\t }\n\t ],\n\t \"success\":true,\n\t \"total\":1\n}",
"header_map" : {
"Keep-Alive" : "timeout=20",
"Server" : "CloudMiddleWareTomcat",
"X-Request-Id" : "e8c092e7-2acf-4f26-ab84-80f296352d99-1704936562490-scheduler03",
"X-Content-Type-Options" : "nosniff",
"Connection" : "keep-alive",
"Pragma" : "no-cache",
"Date" : "Thu, 11 Jan 2024 01:29:22 GMT",
"X-Frame-Options" : "SAMEORIGIN",
"Cache-Control" : "no-cache, no-store, must-revalidate",
"Expires" : "Thu, 01 Jan 1970 00:00:00 GMT",
"X-XSS-Protection" : "1; mode=block",
"Content-Length" : "1692",
"Content-Type" : "application/json;charset=UTF-8"
}
} 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 48 | 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 ShowInstanceInfosSolution { 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(); ShowInstanceInfosRequest request = new ShowInstanceInfosRequest(); request.withTaskId("{task_id}"); try { ShowInstanceInfosResponse response = client.showInstanceInfos(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 32 | # 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 = ShowInstanceInfosRequest() request.task_id = "{task_id}" response = client.show_instance_infos(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 38 | 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.ShowInstanceInfosRequest{} request.TaskId = "{task_id}" response, err := client.ShowInstanceInfos(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 | OK. |
| 400 | Bad request. |
| 401 | Unauthorized. |
| 403 | Forbidden. |
| 404 | Not found. |
| 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